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.7 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS, URIBL_BLOCKED autolearn=unavailable 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 BF64CCA9EA0 for ; Fri, 25 Oct 2019 06:58:11 +0000 (UTC) Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by mail.kernel.org (Postfix) with ESMTP id 66C3120867 for ; Fri, 25 Oct 2019 06:58:11 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 66C3120867 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linux.intel.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=owner-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix) id A8FE16B0003; Fri, 25 Oct 2019 02:58:10 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id A678A6B0006; Fri, 25 Oct 2019 02:58:10 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 97E276B0007; Fri, 25 Oct 2019 02:58:10 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from forelay.hostedemail.com (smtprelay0002.hostedemail.com [216.40.44.2]) by kanga.kvack.org (Postfix) with ESMTP id 76ECD6B0003 for ; Fri, 25 Oct 2019 02:58:10 -0400 (EDT) Received: from smtpin05.hostedemail.com (10.5.19.251.rfc1918.com [10.5.19.251]) by forelay03.hostedemail.com (Postfix) with SMTP id 00BD18249980 for ; Fri, 25 Oct 2019 06:58:09 +0000 (UTC) X-FDA: 76081402698.05.bee08_643ea0a29552d X-HE-Tag: bee08_643ea0a29552d X-Filterd-Recvd-Size: 4943 Received: from mga17.intel.com (mga17.intel.com [192.55.52.151]) by imf30.hostedemail.com (Postfix) with ESMTP for ; Fri, 25 Oct 2019 06:58:08 +0000 (UTC) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga008.jf.intel.com ([10.7.209.65]) by fmsmga107.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 24 Oct 2019 23:58:03 -0700 X-IronPort-AV: E=Sophos;i="5.68,227,1569308400"; d="scan'208";a="192446754" Received: from jnikula-mobl3.fi.intel.com (HELO localhost) ([10.237.66.161]) by orsmga008-auth.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 24 Oct 2019 23:57:52 -0700 From: Jani Nikula To: Jonathan Corbet , Changbin Du Cc: 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' In-Reply-To: <20191024121940.1d6a64df@lwn.net> Organization: Intel Finland Oy - BIC 0357606-4 - Westendinkatu 7, 02160 Espoo References: <20191020131717.28990-1-changbin.du@gmail.com> <20191024121940.1d6a64df@lwn.net> Date: Fri, 25 Oct 2019 09:57:48 +0300 Message-ID: <87woctb9cj.fsf@intel.com> MIME-Version: 1.0 Content-Type: text/plain 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 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") else: self.options.set('identifiers', self.options.get('functions')) BR, Jani. -- Jani Nikula, Intel Open Source Graphics Center