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=-6.6 required=3.0 tests=DKIM_INVALID,DKIM_SIGNED, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_PASS,URIBL_BLOCKED autolearn=ham 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 AE8C1ECDE3B for ; Wed, 17 Oct 2018 22:41:49 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 6F50A21473 for ; Wed, 17 Oct 2018 22:41:49 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="Rrr28sIU" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 6F50A21473 Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727577AbeJRGjg (ORCPT ); Thu, 18 Oct 2018 02:39:36 -0400 Received: from bombadil.infradead.org ([198.137.202.133]:60468 "EHLO bombadil.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727188AbeJRGjg (ORCPT ); Thu, 18 Oct 2018 02:39:36 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20170209; h=Content-Transfer-Encoding: Content-Type:In-Reply-To:MIME-Version:Date:Message-ID:From:References:Cc:To: Subject:Sender:Reply-To:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Id: List-Help:List-Unsubscribe:List-Subscribe:List-Post:List-Owner:List-Archive; bh=/GeNbQ7N59Uk/lY2UmvSe+yGDeqM6Ue0NDbSm2tdI5g=; b=Rrr28sIU7jNUVzUBNYLlru+ol 5faVgHbs6pGz0bNhiMxfwYYgfXlLEj/ELnuWV9VWOHJEgTd/Vx4HU1JeETGqOElqyagFB8q9/2xf4 1q88FHIGTp6DLzxqHenKXfAIiIwBUs/4XfKQnOdjWvY5ipqOckeVbmv0i+5FgLIkvPTg1ODV64Jlh 566XdmhfF3ZcmEfr21MmR60b+W18x6B947nvkGvuo3isjReY4XO9CHwDE0zNYedWo1cuUaCB9msMl YWhELWP9d9st7b2aGj6IetwKHfd0SA/O4Rtn63eNNA/OgYRGfqBDbLaTORxhaibMz1zdT6T5HZhgW ichiWhkLw==; Received: from static-50-53-52-16.bvtn.or.frontiernet.net ([50.53.52.16] helo=dragon.dunlab) by bombadil.infradead.org with esmtpsa (Exim 4.90_1 #2 (Red Hat Linux)) id 1gCuVe-0005NE-UC; Wed, 17 Oct 2018 22:41:46 +0000 Subject: Re: [PATCH] docs: Introduce deprecated APIs list To: Kees Cook Cc: Jani Nikula , Jonathan Corbet , "open list:DOCUMENTATION" , LKML , Stephen Rothwell References: <20181017021708.GA22211@beast> <875zy0ki3r.fsf@intel.com> <70d6b61f-25af-f903-0693-46e649c08aff@infradead.org> From: Randy Dunlap Message-ID: <193ca5ac-a3ef-3cfe-ca91-3b142ef9c50b@infradead.org> Date: Wed, 17 Oct 2018 15:41:46 -0700 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Thunderbird/60.2.1 MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On 10/17/18 3:37 PM, Kees Cook wrote: > On Wed, Oct 17, 2018 at 10:08 AM, Randy Dunlap wrote: >> On 10/17/18 3:00 AM, Jani Nikula wrote: >>> On Tue, 16 Oct 2018, Randy Dunlap wrote: >>>> On 10/16/18 7:17 PM, Kees Cook wrote: >>>>> As discussed in the "API replacement/deprecation" thread[1], this >>>>> makes an effort to document what things shouldn't get (re)added to the >>>>> kernel, by introducing Documentation/process/deprecated.rst. It also >>>>> adds the overflow kerndoc to ReST output, and tweaks the struct_size() >>>>> documentation to parse correctly. >>>>> >>>>> [1] https://lists.linuxfoundation.org/pipermail/ksummit-discuss/2018-September/005282.html >>>>> >>>>> Signed-off-by: Kees Cook >>>>> --- >>>>> Documentation/driver-api/basics.rst | 3 + >>>>> Documentation/process/deprecated.rst | 99 ++++++++++++++++++++++++++++ >>>>> Documentation/process/index.rst | 1 + >>>>> include/linux/overflow.h | 2 +- >>>>> 4 files changed, 104 insertions(+), 1 deletion(-) >>>>> create mode 100644 Documentation/process/deprecated.rst >>>> >>>> >>>>> diff --git a/include/linux/overflow.h b/include/linux/overflow.h >>>>> index 40b48e2133cb..2f224f43dd06 100644 >>>>> --- a/include/linux/overflow.h >>>>> +++ b/include/linux/overflow.h >>>>> @@ -291,7 +291,7 @@ static inline __must_check size_t __ab_c_size(size_t n, size_t size, size_t c) >>>>> } >>>>> >>>>> /** >>>>> - * struct_size() - Calculate size of structure with trailing array. >>>>> + * function struct_size() - Calculate size of structure with trailing array. >>>> >>>> That syntax is not explained nor documented in Documentation/doc-guide/kernel-doc.rst. >>>> >>>> Is the root problem that the function name begins with "struct"? >>>> Please explain in the patch description. >>> >>> Indeed, shouldn't be needed. > > I actually thought the problem was with it not knowing how to deal > with struct_size() being a macro instead of a real function. > >> Well, this is just a guess (no testing), but in scripts/kernel-doc (at line >> 1907 in 4.19-rc8), we can see: >> >> if ($identifier =~ m/^struct/) { >> $decl_type = 'struct'; >> } elsif ($identifier =~ m/^union/) { >> $decl_type = 'union'; >> } elsif ($identifier =~ m/^enum/) { >> $decl_type = 'enum'; >> } elsif ($identifier =~ m/^typedef/) { >> $decl_type = 'typedef'; >> } else { >> $decl_type = 'function'; >> } >> >> I wouldn't be surprised if a function named "struct_size" looks like a >> type struct. Maybe it needs to be more strict, with either a space or >> word boundary at the end of each type string. E.g.: >> >> if ($identifier =~ m/^struct\b/) { >> $decl_type = 'struct'; >> } elsif ($identifier =~ m/^union\b/) { >> $decl_type = 'union'; >> } elsif ($identifier =~ m/^enum\b/) { >> $decl_type = 'enum'; >> } elsif ($identifier =~ m/^typedef\b/) { >> $decl_type = 'typedef'; >> } else { >> $decl_type = 'function'; >> } > > But I see it's actually the prefix! :P > > Using the above code fixes it for me. Can you send this fix with my > Tested-by, and I'll spin a v2 of my "deprecated.rst" patch without the > overflow.h change? OK, but I'll have to first test for unexpected consequences of it. (i.e., run full docs build with and without the patch) -- ~Randy