Received: by 10.223.185.116 with SMTP id b49csp725065wrg; Tue, 20 Feb 2018 06:56:31 -0800 (PST) X-Google-Smtp-Source: AH8x227Ch9aBP+yTNZckdwYLDkfcoh+g8MM+zgwGiHGlGrEefMUkLE3z4BIui8t/olALu0ghgzDu X-Received: by 2002:a17:902:a9ca:: with SMTP id b10-v6mr18069345plr.223.1519138591112; Tue, 20 Feb 2018 06:56:31 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1519138591; cv=none; d=google.com; s=arc-20160816; b=VeREyzGRCb7F3ZEyk97ouqmG9wRqBJwr3uDq9Hx4mPKkeQstdoKwXawRvTKSjt491k whpAuK6Vqc0zqiB4t3g1n2LaYlXeURhVvR1Z8oIbSrkYnNCQtfYizB7xzFhmErgxQeCN knx+z9J6snkZYWlWMG8tOpgOsC0ntMjI8WQACcbOpNdESayxe0OFCrPolnyKSzl5jYIh vrlIgB0ApDaZ1GjvnB6TycIssC10AMi8T3Le9VT4ubiZhGcGb47oVA+8MlG9QurhS+Vv ryBF6iqAXN9R2hGfTq8pMZDevYjLG0zRKDa+iNqM+tPzfmgyGrpbbchR8SCcRQD/MOPN gARQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:message-id:date:subject:cc:to:from :arc-authentication-results; bh=KCJt2QeZfaM7SrMS5WV0jD4X2uFR20liSbSa+9ZEHZc=; b=UHgeXdnaL6mbNXW5KAu1djuI5BD0c+HSgHO74BvSHUAaRUfDjC+qC89U8gonzrTMOY eZED9exNTxfhni8g13WrGCjjqQBfswZYS58CkA3tEGrDkbIgZeM4S33Y3/u935B8fd21 exbiSs/qBFEeKwttFtGzN2wX/Sj8YsxeZYu+gEEjMZR2jMohhTcPMBMhfKd9EAChejo7 w/jc+ejJd4rYWIPjCvqXtOKeCyahcaLFBCQnvC6JTRBi+C0Hda0dUJzswkCYoEV7sgkj UhYSfeljaktAsiS2vncF6NyjXLbkHpRyCyz8ZUvzva7OwRLYjUVbk9Vaqs2Os9S8144G AvVQ== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=ibm.com Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id t71si6326281pgb.108.2018.02.20.06.56.04; Tue, 20 Feb 2018 06:56:31 -0800 (PST) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=ibm.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752136AbeBTOy4 (ORCPT + 99 others); Tue, 20 Feb 2018 09:54:56 -0500 Received: from mx0b-001b2d01.pphosted.com ([148.163.158.5]:49460 "EHLO mx0a-001b2d01.pphosted.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1752116AbeBTOyx (ORCPT ); Tue, 20 Feb 2018 09:54:53 -0500 Received: from pps.filterd (m0098419.ppops.net [127.0.0.1]) by mx0b-001b2d01.pphosted.com (8.16.0.22/8.16.0.22) with SMTP id w1KEngvb139547 for ; Tue, 20 Feb 2018 09:54:52 -0500 Received: from e06smtp11.uk.ibm.com (e06smtp11.uk.ibm.com [195.75.94.107]) by mx0b-001b2d01.pphosted.com with ESMTP id 2g8mjtuu07-1 (version=TLSv1.2 cipher=AES256-SHA bits=256 verify=NOT) for ; Tue, 20 Feb 2018 09:54:51 -0500 Received: from localhost by e06smtp11.uk.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for from ; Tue, 20 Feb 2018 14:54:49 -0000 Received: from b06cxnps4074.portsmouth.uk.ibm.com (9.149.109.196) by e06smtp11.uk.ibm.com (192.168.101.141) with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted; Tue, 20 Feb 2018 14:54:48 -0000 Received: from d06av25.portsmouth.uk.ibm.com (d06av25.portsmouth.uk.ibm.com [9.149.105.61]) by b06cxnps4074.portsmouth.uk.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id w1KEsmGe49217706; Tue, 20 Feb 2018 14:54:48 GMT Received: from d06av25.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 267E411C052; Tue, 20 Feb 2018 14:47:52 +0000 (GMT) Received: from d06av25.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 9E06A11C050; Tue, 20 Feb 2018 14:47:50 +0000 (GMT) Received: from rapoport-lnx (unknown [9.148.207.230]) by d06av25.portsmouth.uk.ibm.com (Postfix) with ESMTPS; Tue, 20 Feb 2018 14:47:50 +0000 (GMT) Received: by rapoport-lnx (sSMTP sendmail emulation); Tue, 20 Feb 2018 16:54:45 +0200 From: Mike Rapoport To: Jonathan Corbet Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Mike Rapoport Subject: [PATCH] doc-guide: kernel-doc: add comment about formatting verification Date: Tue, 20 Feb 2018 16:54:44 +0200 X-Mailer: git-send-email 2.7.4 X-TM-AS-GCONF: 00 x-cbid: 18022014-0040-0000-0000-00000435A4D8 X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 18022014-0041-0000-0000-000020D7B578 Message-Id: <1519138484-29023-1-git-send-email-rppt@linux.vnet.ibm.com> X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10432:,, definitions=2018-02-20_06:,, signatures=0 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 priorityscore=1501 malwarescore=0 suspectscore=0 phishscore=0 bulkscore=0 spamscore=0 clxscore=1011 lowpriorityscore=0 impostorscore=0 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1709140000 definitions=main-1802200189 Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Currently there is no automated checking for kernel-doc comments except running 'kernel-doc -v -none '. Mention the possibility to run kernel-doc to verify formatting of the comments in the kernel-doc guide. Signed-off-by: Mike Rapoport --- Documentation/doc-guide/kernel-doc.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst index c6c3297..bb5ed6d 100644 --- a/Documentation/doc-guide/kernel-doc.rst +++ b/Documentation/doc-guide/kernel-doc.rst @@ -44,6 +44,12 @@ that somebody changing the code will also change the documentation. The overview kernel-doc comments may be placed anywhere at the top indentation level. +Running the ``kernel-doc`` tool with increased verbosity and without actual +output generation may be used to verify proper formating of the +documentation comments. For example:: + + scripts/kernel-doc -v -none drivers/foo/bar.c + Function documentation ---------------------- -- 2.7.4