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=-8.3 required=3.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_SANE_1 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 B4F3FCA9EC0 for ; Tue, 29 Oct 2019 00:31:38 +0000 (UTC) Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by mail.kernel.org (Postfix) with ESMTP id 5CC92217D6 for ; Tue, 29 Oct 2019 00:31:38 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="WnOJ3SqY" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 5CC92217D6 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=gmail.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=owner-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix) id 076D36B0005; Mon, 28 Oct 2019 20:31:38 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 026D56B0006; Mon, 28 Oct 2019 20:31:37 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id E58766B0007; Mon, 28 Oct 2019 20:31:37 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from forelay.hostedemail.com (smtprelay0035.hostedemail.com [216.40.44.35]) by kanga.kvack.org (Postfix) with ESMTP id C34116B0005 for ; Mon, 28 Oct 2019 20:31:37 -0400 (EDT) Received: from smtpin09.hostedemail.com (10.5.19.251.rfc1918.com [10.5.19.251]) by forelay04.hostedemail.com (Postfix) with SMTP id 6637852A6 for ; Tue, 29 Oct 2019 00:31:37 +0000 (UTC) X-FDA: 76094943834.09.pigs29_e0e3902b5531 X-HE-Tag: pigs29_e0e3902b5531 X-Filterd-Recvd-Size: 8158 Received: from mail-wm1-f67.google.com (mail-wm1-f67.google.com [209.85.128.67]) by imf06.hostedemail.com (Postfix) with ESMTP for ; Tue, 29 Oct 2019 00:31:36 +0000 (UTC) Received: by mail-wm1-f67.google.com with SMTP id p21so782396wmg.2 for ; Mon, 28 Oct 2019 17:31:36 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to:user-agent; bh=+D8dAg6wyuTSrA9lr5DiGJ+HgUlg76x4EWdaVB31KHg=; b=WnOJ3SqYw4EzB4LsY+VdHC/M5C2fdfATlBfV/U9GORaFAbMt0xRnkkYxgM55NA5EWM BFZjAoG6fIhPatBfQPD24sg3OspaMNPT4jec8U4Ndsz1KNPeF4vCoGgg1wY1RgBQPDMk n7CT/80tjNOvVtNSFzAQ2Atxa01teqDqh4f00F5vCjQZHeXTK4r6zL5b/geM8uassQFW heyCsLayoyBCEi5ZZbLqD7+0IBoV+wg1k7FBe/fuqBADy3vQ4li1Mb872dVSJmDPYlI0 PMfgRv2RJG6/aoWc7FTKZ4q1ENUNLSc2qGNBYvODVNXrh0zxtgF+09suG812OJH0H0uW i5Zg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to:user-agent; bh=+D8dAg6wyuTSrA9lr5DiGJ+HgUlg76x4EWdaVB31KHg=; b=DK21NbKQcYJWdxqJAwFfk62u8kXVbP30tWUlQcYRcHAZZnWOrKhkfwaoJkH7Y3wcSv xJwum9tspZRF9dwhknwDbpsK03uX0VD5iAik12pZaLrNRYy13W3HvSmHRWFf9eQl7Ls7 iaBb5KbSqJWki4x3z/jpFnsZAVndWnV0GLwiCY1YaasPa93tlfXH7Yf6AKKzvC8grAE9 z5qO+LIIzhx68Rj2D/vMBPVQCR7npZVz0rg3Br0ADGC1/t/moFYO5M9frZvpthzFJng2 ksrwUN4mkmNK2oyPCD1nwih3eWAwKobq+acJzeYbckhJiKr/nXGpfC2kijB5X40pB6y6 9+iA== X-Gm-Message-State: APjAAAUDDmMRQYbrIoPXcMq+R3uf/OaYsMn197t7IAOt3GksEP7svShy IK9T5ekVZsxn5n9ZGK1CqbU= X-Google-Smtp-Source: APXvYqyynmRqmdd3kL5UW/yq8tfwkLVzOUvEW0e21C3/Pe9ufZJ43RT/NMWvApoj/D5Cryll4ll8xQ== X-Received: by 2002:a1c:998f:: with SMTP id b137mr1687363wme.104.1572309095171; Mon, 28 Oct 2019 17:31:35 -0700 (PDT) Received: from mail.google.com ([104.238.174.53]) by smtp.gmail.com with ESMTPSA id s21sm17840387wrb.31.2019.10.28.17.31.26 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 28 Oct 2019 17:31:34 -0700 (PDT) Date: Tue, 29 Oct 2019 08:31:22 +0800 From: Changbin Du To: Jani Nikula Cc: Changbin Du , Jonathan Corbet , linux-pci@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, linux-mm@kvack.org, linux-crypto@vger.kernel.org, linux-kselftest@vger.kernel.org, linux-wireless@vger.kernel.org, linux-fpga@vger.kernel.org, linux-usb@vger.kernel.org, dri-devel@lists.freedesktop.org, intel-gfx@lists.freedesktop.org, Matthew Wilcox , Thomas Zimmermann Subject: Re: [PATCH v2] kernel-doc: rename the kernel-doc directive 'functions' to 'identifiers' Message-ID: <20191029003120.llve32crfw63ovpw@mail.google.com> References: <20191020131717.28990-1-changbin.du@gmail.com> <20191024121940.1d6a64df@lwn.net> <87woctb9cj.fsf@intel.com> <20191025144802.uixg2crhw6h7gghq@mail.google.com> <87v9s99q9l.fsf@intel.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <87v9s99q9l.fsf@intel.com> User-Agent: NeoMutt/20180716 X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: On Mon, Oct 28, 2019 at 11:24:22AM +0200, Jani Nikula wrote: > On Fri, 25 Oct 2019, Changbin Du wrote: > > On Fri, Oct 25, 2019 at 09:57:48AM +0300, Jani Nikula wrote: > >> On Thu, 24 Oct 2019, Jonathan Corbet wrote: > >> > On Sun, 20 Oct 2019 21:17:17 +0800 > >> > Changbin Du wrote: > >> > > >> >> The 'functions' directive is not only for functions, but also works for > >> >> structs/unions. So the name is misleading. This patch renames it to > >> >> 'identifiers', which specific the functions/types to be included in > >> >> documentation. We keep the old name as an alias of the new one before > >> >> all documentation are updated. > >> >> > >> >> Signed-off-by: Changbin Du > >> > > >> > So I think this is basically OK, but I have one more request... > >> > > >> > [...] > >> > > >> >> diff --git a/Documentation/sphinx/kerneldoc.py b/Documentation/sphinx/kerneldoc.py > >> >> index 1159405cb920..0689f9c37f1e 100644 > >> >> --- a/Documentation/sphinx/kerneldoc.py > >> >> +++ b/Documentation/sphinx/kerneldoc.py > >> >> @@ -59,9 +59,10 @@ class KernelDocDirective(Directive): > >> >> optional_arguments = 4 > >> >> option_spec = { > >> >> 'doc': directives.unchanged_required, > >> >> - 'functions': directives.unchanged, > >> >> 'export': directives.unchanged, > >> >> 'internal': directives.unchanged, > >> >> + 'identifiers': directives.unchanged, > >> >> + 'functions': directives.unchanged, # alias of 'identifiers' > >> >> } > >> >> has_content = False > >> >> > >> >> @@ -71,6 +72,7 @@ class KernelDocDirective(Directive): > >> >> > >> >> filename = env.config.kerneldoc_srctree + '/' + self.arguments[0] > >> >> export_file_patterns = [] > >> >> + identifiers = None > >> >> > >> >> # Tell sphinx of the dependency > >> >> env.note_dependency(os.path.abspath(filename)) > >> >> @@ -86,19 +88,22 @@ class KernelDocDirective(Directive): > >> >> export_file_patterns = str(self.options.get('internal')).split() > >> >> elif 'doc' in self.options: > >> >> cmd += ['-function', str(self.options.get('doc'))] > >> >> + elif 'identifiers' in self.options: > >> >> + identifiers = self.options.get('identifiers').split() > >> >> elif 'functions' in self.options: > >> >> - functions = self.options.get('functions').split() > >> >> - if functions: > >> >> - for f in functions: > >> >> - cmd += ['-function', f] > >> >> - else: > >> >> - cmd += ['-no-doc-sections'] > >> >> + identifiers = self.options.get('functions').split() > >> > > >> > Rather than do this, can you just change the elif line to read: > >> > > >> > elif ('identifiers' in self.options) or ('functions' in self.options): > >> > > >> > ...then leave the rest of the code intact? It keeps the logic together, > >> > and avoids the confusing distinction between identifiers=='' and > >> > identifiers==None . > >> > >> I think the problem is you still need to distinguish between the two for > >> the get('functions') part. > >> > >> One option is to rename 'functions' to 'identifiers' in the above block, > >> and put something like this above the whole if ladder (untested): > >> > >> # backward compat > >> if 'functions' in self.options: > >> if 'identifiers' in self.options: > >> kernellog.warn(env.app, "fail") > > This will miss the content of 'functions' directive if both exist in > > same doc. > > Did you not notice your patch does the same, except silently, while this > would produce a warning? Which one is less surprising? > yes, my mistake. Mine does the same thing. > > > >> else: > >> self.options.set('identifiers', self.options.get('functions')) > >> > >> BR, > >> Jani. > >> > > After comparing, I still perfer my original code which is simpler. :) > > But is it, really? I agree with Jon about the distinction between None > and '' being confusing. > Here python is different from C. Both empty string and None are False in python. Note such condition is common in python. Again, I am ok with both. > > BR, > Jani. > > > > > > >> > >> -- > >> Jani Nikula, Intel Open Source Graphics Center > > -- > Jani Nikula, Intel Open Source Graphics Center -- Cheers, Changbin Du