From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-0.7 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED autolearn=no autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id A8A1EC433DF for ; Thu, 9 Jul 2020 12:11:51 +0000 (UTC) Received: from silver.osuosl.org (smtp3.osuosl.org [140.211.166.136]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 6F3DC2074B for ; Thu, 9 Jul 2020 12:11:51 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 6F3DC2074B Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linux.ibm.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=ksummit-discuss-bounces@lists.linuxfoundation.org Received: from localhost (localhost [127.0.0.1]) by silver.osuosl.org (Postfix) with ESMTP id 31C9E26D38; Thu, 9 Jul 2020 12:11:50 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from silver.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id beKrywNISJYy; Thu, 9 Jul 2020 12:11:48 +0000 (UTC) Received: from lists.linuxfoundation.org (lf-lists.osuosl.org [140.211.9.56]) by silver.osuosl.org (Postfix) with ESMTP id 3988821517; Thu, 9 Jul 2020 12:11:48 +0000 (UTC) Received: from lf-lists.osuosl.org (localhost [127.0.0.1]) by lists.linuxfoundation.org (Postfix) with ESMTP id 07B43C0865; Thu, 9 Jul 2020 12:11:48 +0000 (UTC) Received: from whitealder.osuosl.org (smtp1.osuosl.org [140.211.166.138]) by lists.linuxfoundation.org (Postfix) with ESMTP id 2838EC016F for ; Thu, 9 Jul 2020 12:11:47 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by whitealder.osuosl.org (Postfix) with ESMTP id 0FA1888A1F for ; Thu, 9 Jul 2020 12:11:47 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from whitealder.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id Rd6KFO1fQGwm for ; Thu, 9 Jul 2020 12:11:46 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.7.6 Received: from mx0a-001b2d01.pphosted.com (mx0a-001b2d01.pphosted.com [148.163.156.1]) by whitealder.osuosl.org (Postfix) with ESMTPS id 42D2E889FC for ; Thu, 9 Jul 2020 12:11:46 +0000 (UTC) Received: from pps.filterd (m0098399.ppops.net [127.0.0.1]) by mx0a-001b2d01.pphosted.com (8.16.0.42/8.16.0.42) with SMTP id 069C3W3d023762; Thu, 9 Jul 2020 08:11:45 -0400 Received: from ppma06ams.nl.ibm.com (66.31.33a9.ip4.static.sl-reverse.com [169.51.49.102]) by mx0a-001b2d01.pphosted.com with ESMTP id 325r2pa31h-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Thu, 09 Jul 2020 08:11:44 -0400 Received: from pps.filterd (ppma06ams.nl.ibm.com [127.0.0.1]) by ppma06ams.nl.ibm.com (8.16.0.42/8.16.0.42) with SMTP id 069C7XSu005768; Thu, 9 Jul 2020 12:11:41 GMT Received: from b06cxnps4076.portsmouth.uk.ibm.com (d06relay13.portsmouth.uk.ibm.com [9.149.109.198]) by ppma06ams.nl.ibm.com with ESMTP id 325k0crvc2-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Thu, 09 Jul 2020 12:11:41 +0000 Received: from d06av23.portsmouth.uk.ibm.com (d06av23.portsmouth.uk.ibm.com [9.149.105.59]) by b06cxnps4076.portsmouth.uk.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id 069CBdRU32375028 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Thu, 9 Jul 2020 12:11:39 GMT Received: from d06av23.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 1A60CA4051; Thu, 9 Jul 2020 12:11:39 +0000 (GMT) Received: from d06av23.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 9DA46A4053; Thu, 9 Jul 2020 12:11:38 +0000 (GMT) Received: from linux.ibm.com (unknown [9.148.204.222]) by d06av23.portsmouth.uk.ibm.com (Postfix) with ESMTPS; Thu, 9 Jul 2020 12:11:38 +0000 (GMT) Date: Thu, 9 Jul 2020 15:11:36 +0300 From: Mike Rapoport To: Joe Perches Message-ID: <20200709121136.GG781326@linux.ibm.com> References: <8f68863a-d04c-4502-f88e-2a8b0e3c7968@linuxfoundation.org> <928d6b2c9a8afb4262a0d931bce03987ef002c8f.camel@perches.com> <20200612090706.GF2051223@linux.ibm.com> <8dff373fabbbe6ae20512848e93dac7544e0abce.camel@perches.com> <20200618090442.GF6493@linux.ibm.com> <1f7ace6cd84dfc83f91a8150f396074b05d06b97.camel@perches.com> <20200709122118.0ffaea91@coco.lan> <60434f00e5bc55d2ceac14bb6a8c00d4d17c4e96.camel@perches.com> MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <60434f00e5bc55d2ceac14bb6a8c00d4d17c4e96.camel@perches.com> X-TM-AS-GCONF: 00 X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:6.0.235, 18.0.687 definitions=2020-07-09_06:2020-07-09, 2020-07-09 signatures=0 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 suspectscore=2 clxscore=1015 bulkscore=0 lowpriorityscore=0 adultscore=0 priorityscore=1501 mlxscore=0 malwarescore=0 mlxlogscore=786 impostorscore=0 spamscore=0 phishscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2006250000 definitions=main-2007090095 Cc: Mauro Carvalho Chehab , ksummit Subject: Re: [Ksummit-discuss] [TECH TOPIC] Documentation X-BeenThere: ksummit-discuss@lists.linuxfoundation.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: ksummit-discuss-bounces@lists.linuxfoundation.org Sender: "Ksummit-discuss" On Thu, Jul 09, 2020 at 04:42:58AM -0700, Joe Perches wrote: > On Thu, 2020-07-09 at 12:21 +0200, Mauro Carvalho Chehab wrote: > > Em Thu, 18 Jun 2020 07:40:22 -0700 > > Joe Perches escreveu: > > > > > On Thu, 2020-06-18 at 12:04 +0300, Mike Rapoport wrote: > > > > if a patch breaks the sync between the code and the > > > > kerneldoc can it be detected by checkpatch.pl? > > > > > > No, it can not. Not directly. > > > > Well, perhaps checkpatch.pl could run: > > > > ./scripts/kernel-doc -none > > > > if it finds "/**" on a patch, showing the warnings produced by it, if any. > > checkpatch runs on patches. > Use the tools that are designed for this instead. The problem is that people usually do run checkpatch and do not run kernel-doc. That's where the idea to somehow put documentation checks into checkpatch came from. > > > As there already is an existing tool, that tool > > > should be used when possible. > > -- Sincerely yours, Mike. _______________________________________________ Ksummit-discuss mailing list Ksummit-discuss@lists.linuxfoundation.org https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss