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.8 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 C7B52C7618B for ; Wed, 24 Jul 2019 11:41:30 +0000 (UTC) Received: from mother.openwall.net (mother.openwall.net [195.42.179.200]) by mail.kernel.org (Postfix) with SMTP id 2D77F229F4 for ; Wed, 24 Jul 2019 11:41:30 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 2D77F229F4 Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=perches.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=kernel-hardening-return-16571-kernel-hardening=archiver.kernel.org@lists.openwall.com Received: (qmail 26262 invoked by uid 550); 24 Jul 2019 11:41:24 -0000 Mailing-List: contact kernel-hardening-help@lists.openwall.com; run by ezmlm Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-ID: Received: (qmail 26229 invoked from network); 24 Jul 2019 11:41:23 -0000 X-Session-Marker: 6A6F6540706572636865732E636F6D X-HE-Tag: boy04_4462ffde4ad0c X-Filterd-Recvd-Size: 2574 Message-ID: <9bb45dcae38b0f9322c0ce033c041ede02f8d7ec.camel@perches.com> Subject: Re: [PATCH] checkpatch: Added warnings in favor of strscpy(). From: Joe Perches To: Jonathan Corbet Cc: Stephen Kitt , Kees Cook , Nitin Gote , jannh@google.com, kernel-hardening@lists.openwall.com, linux-kernel@vger.kernel.org, Rasmus Villemoes Date: Wed, 24 Jul 2019 04:41:07 -0700 In-Reply-To: <20190722162804.754943bc@lwn.net> References: <1561722948-28289-1-git-send-email-nitin.r.gote@intel.com> <20190629181537.7d524f7d@sk2.org> <201907021024.D1C8E7B2D@keescook> <20190706144204.15652de7@heffalump.sk2.org> <201907221047.4895D35B30@keescook> <15f2be3cde69321f4f3a48d60645b303d66a600b.camel@perches.com> <20190722230102.442137dc@heffalump.sk2.org> <20190722155730.08dfd4e3@lwn.net> <512d8977fb0d0b3eef7b6ea1753fb4c33fbc43e8.camel@perches.com> <20190722162804.754943bc@lwn.net> Content-Type: text/plain; charset="ISO-8859-1" User-Agent: Evolution 3.30.5-0ubuntu0.18.10.1 MIME-Version: 1.0 Content-Transfer-Encoding: 7bit On Mon, 2019-07-22 at 16:28 -0600, Jonathan Corbet wrote: > On Mon, 22 Jul 2019 15:24:33 -0700 > Joe Perches wrote: > > > > If the functions themselves are fully defined in the .h file, I'd just add > > > the kerneldoc there as well. That's how it's usually done, and you want > > > to keep the documentation and the prototypes together. > > > > In this case, it's a macro and yes, the kernel-doc could > > easily be set around the macro in the .h, but my desire > > is to keep all the string function kernel-doc output > > together so it should be added to lib/string.c > > > > Are you suggesting I move all the lib/string.c kernel-doc > > to include/linux/string.h ? > > If you want the *output* together, just put the kernel-doc directives > together in the RST file that pulls it all in. Or am I missing something > here? The negative of the kernel-doc separation of prototypes by .h and .c files is that the ordering of the functions in the .rst outout files doesn't make much logical sense. stracpy is pretty far away from strscpy in the list of functions.