Received: by 2002:a05:7412:251c:b0:e2:908c:2ebd with SMTP id w28csp832383rda; Sun, 22 Oct 2023 11:50:09 -0700 (PDT) X-Google-Smtp-Source: AGHT+IFqN1nEs0xE5D2030ertOxQiA3C0JXSLslW/jVCx1wKRX0X/JDrgMzyyi3oJ4LjdgBAwUCQ X-Received: by 2002:a05:6a21:789c:b0:152:be08:b013 with SMTP id bf28-20020a056a21789c00b00152be08b013mr5866852pzc.42.1698000608709; Sun, 22 Oct 2023 11:50:08 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1698000608; cv=none; d=google.com; s=arc-20160816; b=hXeHqn8ApjVqBQ/ZXTX+OJx2Uq5uiWZ83cRxQKLO06HpYCk2SKKsNp2LJdwDw+N/h/ MXrNlUfh1rvXdMM4Fzz9hO0xAlaLH4aWxUb8mqr2pb8g3tINZAqNmud9at7QEFZWzgiC d/1Mvk/KrrqNK+QEc8sBZ5m61JgswUf+ndRTN/fqfKqp78Q7cDfPSvqcL3TIl+IM4iWN a7bMh8ZhkwY94HUwQoMcJw8lES+2FBeuLXagQIlRnjH2vtO9I8Pp0yuUVe4rvWu+D32z wVhcNfONTV8nqQSPiD4w0UFZ1rNQ23itn0uVwV8bGXYSD6a/CBtJZk+E1yv89ks8+BlO oEsw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from:dkim-signature; bh=AfPo0CQqUl2C/VImdIgEdj8artktDGxCrai/+Jf+/ls=; fh=tcQR93ds81CncM4gXZWW3QNplLQ2LVN49cCc8HdB9dc=; b=z9+PTlQp5dCvX20VhIpVjLbgR7UKXtXehgALyh1fxc7BzmlcLsMMfbt6CYTjOmgM+G xFND9YLm0k5L/o1Sp7Wjdgy7BanyvklSuhxZP84+EN2dc7Jgw5lPQ+U6VvPzxao9Ecu1 Xaw8sbxijgJVRug6JLC/z95r4m8JD7NJWQ3qd8djhy9NIIhCwuPD+tBQR/q5oGy+cyf+ OHF1bUqlwBcGAK0u1ea2dJHoTEbmveIKOUW0o+EpYceTDags6SvJo2iTWFmTfcJ3GbBE oOoTB7iDo6/fOD/ApFeY3KSBCSQdi8AJkLWWbLNnGLZnqJQUMD3++IVfB3TrtAXb5Opp bOwQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@oracle.com header.s=corp-2023-03-30 header.b=2u3rUBj+; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.36 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=oracle.com Return-Path: Received: from pete.vger.email (pete.vger.email. [23.128.96.36]) by mx.google.com with ESMTPS id u14-20020a170902e5ce00b001ca8e7953besi5433753plf.497.2023.10.22.11.50.08 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 22 Oct 2023 11:50:08 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.36 as permitted sender) client-ip=23.128.96.36; Authentication-Results: mx.google.com; dkim=pass header.i=@oracle.com header.s=corp-2023-03-30 header.b=2u3rUBj+; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.36 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=oracle.com Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by pete.vger.email (Postfix) with ESMTP id 41B388050004; Sun, 22 Oct 2023 11:50:06 -0700 (PDT) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at pete.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232460AbjJVSto (ORCPT + 99 others); Sun, 22 Oct 2023 14:49:44 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:56504 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229452AbjJVStm (ORCPT ); Sun, 22 Oct 2023 14:49:42 -0400 Received: from mx0a-00069f02.pphosted.com (mx0a-00069f02.pphosted.com [205.220.165.32]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 3CB9C197; Sun, 22 Oct 2023 11:49:40 -0700 (PDT) Received: from pps.filterd (m0333521.ppops.net [127.0.0.1]) by mx0b-00069f02.pphosted.com (8.17.1.19/8.17.1.19) with ESMTP id 39MBM0B9013546; Sun, 22 Oct 2023 18:49:32 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.com; h=from : to : cc : subject : date : message-id : mime-version : content-transfer-encoding; s=corp-2023-03-30; bh=AfPo0CQqUl2C/VImdIgEdj8artktDGxCrai/+Jf+/ls=; b=2u3rUBj+IajFU+0RlyB5UsmEQL+cB7He8Q61HCIBCen+r60UT5p7xOCRSpBmEc4kb7Oy 74J1kMk3SOsFmZaDh3KHCqMoFzclp+aC7ZkTZCeCgGOGdxRAmKhl+BDtiLBl6EX8NQaM JuYkeHP8iVT7ZUqHvdV/F1QBrF6ETz0xGQvJobpBauB/z4bu+z72Re0SrrBAwM7yMEM8 Yq6uSd/ypSZSc3ZJZD2Hg6AJzfOu8WHeKzDfLhySb3+fX6cj0fdima4z8vE9V/mjuexV xrUOx/XodWVjlzORlR7YjFTDVMfLLDYk/i02wErpozEOWgETDUAMZ1gw4cWFFgEasv11 ow== Received: from iadpaimrmta01.imrmtpd1.prodappiadaev1.oraclevcn.com (iadpaimrmta01.appoci.oracle.com [130.35.100.223]) by mx0b-00069f02.pphosted.com (PPS) with ESMTPS id 3tv5jb9v21-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Sun, 22 Oct 2023 18:49:31 +0000 Received: from pps.filterd (iadpaimrmta01.imrmtpd1.prodappiadaev1.oraclevcn.com [127.0.0.1]) by iadpaimrmta01.imrmtpd1.prodappiadaev1.oraclevcn.com (8.17.1.19/8.17.1.19) with ESMTP id 39MIaj8x001460; Sun, 22 Oct 2023 18:49:30 GMT Received: from pps.reinject (localhost [127.0.0.1]) by iadpaimrmta01.imrmtpd1.prodappiadaev1.oraclevcn.com (PPS) with ESMTPS id 3tv539pu0k-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Sun, 22 Oct 2023 18:49:30 +0000 Received: from iadpaimrmta01.imrmtpd1.prodappiadaev1.oraclevcn.com (iadpaimrmta01.imrmtpd1.prodappiadaev1.oraclevcn.com [127.0.0.1]) by pps.reinject (8.17.1.5/8.17.1.5) with ESMTP id 39MInTYB017392; Sun, 22 Oct 2023 18:49:29 GMT Received: from localhost.localdomain (dhcp-10-175-52-84.vpn.oracle.com [10.175.52.84]) by iadpaimrmta01.imrmtpd1.prodappiadaev1.oraclevcn.com (PPS) with ESMTP id 3tv539pu06-1; Sun, 22 Oct 2023 18:49:29 +0000 From: Vegard Nossum To: Jonathan Corbet , Mauro Carvalho Chehab Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Vegard Nossum Subject: [PATCH] docs: doc-guide: mention 'make refcheckdocs' Date: Sun, 22 Oct 2023 20:49:10 +0200 Message-Id: <20231022184910.919201-1-vegard.nossum@oracle.com> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.272,Aquarius:18.0.980,Hydra:6.0.619,FMLib:17.11.176.26 definitions=2023-10-22_16,2023-10-19_01,2023-05-22_02 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 malwarescore=0 mlxlogscore=999 adultscore=0 bulkscore=0 suspectscore=0 mlxscore=0 phishscore=0 spamscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2310170001 definitions=main-2310220174 X-Proofpoint-GUID: hI2lr3l0GhQELYIt-CfApe4OXJNAAuXb X-Proofpoint-ORIG-GUID: hI2lr3l0GhQELYIt-CfApe4OXJNAAuXb X-Spam-Status: No, score=-0.9 required=5.0 tests=DKIMWL_WL_MED,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on pete.vger.email Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (pete.vger.email [0.0.0.0]); Sun, 22 Oct 2023 11:50:06 -0700 (PDT) Add this to the section on fixing warnings. Cc: Mauro Carvalho Chehab Cc: Jonathan Corbet Signed-off-by: Vegard Nossum --- Documentation/doc-guide/contributing.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Documentation/doc-guide/contributing.rst b/Documentation/doc-guide/contributing.rst index d4793826ad9a..662c7a840cd5 100644 --- a/Documentation/doc-guide/contributing.rst +++ b/Documentation/doc-guide/contributing.rst @@ -138,6 +138,10 @@ times, but it's highly important. If we can actually eliminate warnings from the documentation build, then we can start expecting developers to avoid adding new ones. +In addition to warnings from the regular documentation build, you can also +run ``make refcheckdocs`` to find references to nonexistent documentation +files. + Languishing kerneldoc comments ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- 2.34.1