From nobody Mon Feb 9 22:38:13 2026 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1606901194; cv=none; d=zohomail.com; s=zohoarc; b=TrjOtfGrNaeadHe+iWUZP9cr4+geRM++6UlO/eFVubu2Cu+V/HqRMWiY6ivcSGRarlcPWxzNymHs4aBh38xmTm1P/gkq/I7uMOnTy2TS6OHmMBXavfBlkpDj9joTQb4TBpajeK71noSyxWQSouDD4W9KBSTCnbBkCDO1+uXaa58= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1606901194; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=Wdy6f88n2LIny//0BmS54CtVFj89l1KsmAMFogQ24V4=; b=OMkNJdlJqHo0qwXhtv3V3nxKAB+3wrRrLr+F9YVUwOC/mX3so6YBcxLdUciEz0IY4R9he+uxV5cGJRUz6/5LaxXi6zBx5NZVVY2rPrEwSO4Pbz6RxMLrGFH9KeGIYs3EZ0yh1v3vRH+H7PJt4lRp5cWeI6hb8OWNzVvR1BtAElw= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1606901194880218.7093433643255; Wed, 2 Dec 2020 01:26:34 -0800 (PST) Received: from localhost ([::1]:35660 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kkOPB-00069k-JY for importer@patchew.org; Wed, 02 Dec 2020 04:26:33 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:40936) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kkNDP-0003zo-Ei for qemu-devel@nongnu.org; Wed, 02 Dec 2020 03:10:19 -0500 Received: from us-smtp-delivery-124.mimecast.com ([63.128.21.124]:32267) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1kkNCe-0003ra-AQ for qemu-devel@nongnu.org; Wed, 02 Dec 2020 03:10:19 -0500 Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-510-iRlmIzzLMS-xGRh_C5hzyA-1; Wed, 02 Dec 2020 03:09:28 -0500 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 020481006C85 for ; Wed, 2 Dec 2020 08:09:28 +0000 (UTC) Received: from virtlab701.virt.lab.eng.bos.redhat.com (virtlab701.virt.lab.eng.bos.redhat.com [10.19.152.228]) by smtp.corp.redhat.com (Postfix) with ESMTP id B952160854 for ; Wed, 2 Dec 2020 08:09:27 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1606896571; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=Wdy6f88n2LIny//0BmS54CtVFj89l1KsmAMFogQ24V4=; b=BrfHtpdsajJwIzyeYIF2jMECb++TYcNaQr+AmdFoqvvz+OVi+aTaDrYwMCYmvV9bQoj+8T QE1kEmPIyOAgX/8rz6tbwS3mNw5L46u6FUJB5cp9cWfTkxOnagpa6oQSoMjIthu2TlJqgo CvBLoo8dlax1L9IH+aROsSG47eJ+Ehg= X-MC-Unique: iRlmIzzLMS-xGRh_C5hzyA-1 From: Paolo Bonzini To: qemu-devel@nongnu.org Subject: [PULL 101/113] scripts: kernel-doc: reimplement -nofunction argument Date: Wed, 2 Dec 2020 03:08:37 -0500 Message-Id: <20201202080849.4125477-102-pbonzini@redhat.com> In-Reply-To: <20201202080849.4125477-1-pbonzini@redhat.com> References: <20201202080849.4125477-1-pbonzini@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=pbonzini@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=63.128.21.124; envelope-from=pbonzini@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -35 X-Spam_score: -3.6 X-Spam_bar: --- X-Spam_report: (-3.6 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-1.497, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: pass (identity @redhat.com) Content-Type: text/plain; charset="utf-8" From: Mauro Carvalho Chehab Right now, the build system doesn't use -nofunction, as it is pretty much useless, because it doesn't consider the other output modes (extern, internal), working only with all. Also, it is limited to exclude functions. Re-implement it in order to allow excluding any symbols from the document output, no matter what mode is used. The parameter was also renamed to "-nosymbol", as it express better its meaning. Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Paolo Bonzini Message-Id: <20201117165312.118257-20-pbonzini@redhat.com> Signed-off-by: Paolo Bonzini --- scripts/kernel-doc | 44 +++++++++++++++++++++----------------------- 1 file changed, 21 insertions(+), 23 deletions(-) diff --git a/scripts/kernel-doc b/scripts/kernel-doc index f33a4b1cc7..35d60af834 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -66,9 +66,8 @@ Output selection (mutually exclusive): -function NAME Only output documentation for the given function(s) or DOC: section title(s). All other functions and DOC: sections are ignored. May be specified multiple times. - -nofunction NAME Do NOT output documentation for the given function(s); - only output documentation for the other functions and - DOC: sections. May be specified multiple times. + -nosymbol NAME Exclude the specified symbols from the output + documentation. May be specified multiple times. =20 Output selection modifiers: -no-doc-sections Do not output DOC: sections. @@ -288,9 +287,8 @@ my $modulename =3D "Kernel API"; use constant { OUTPUT_ALL =3D> 0, # output all symbols and doc sections OUTPUT_INCLUDE =3D> 1, # output only specified symbols - OUTPUT_EXCLUDE =3D> 2, # output everything except specified symbo= ls - OUTPUT_EXPORTED =3D> 3, # output exported symbols - OUTPUT_INTERNAL =3D> 4, # output non-exported symbols + OUTPUT_EXPORTED =3D> 2, # output exported symbols + OUTPUT_INTERNAL =3D> 3, # output non-exported symbols }; my $output_selection =3D OUTPUT_ALL; my $show_not_found =3D 0; # No longer used @@ -315,6 +313,7 @@ my $man_date =3D ('January', 'February', 'March', 'Apri= l', 'May', 'June', # CAVEAT EMPTOR! Some of the others I localised may not want to be, which # could cause "use of undefined value" or other bugs. my ($function, %function_table, %parametertypes, $declaration_purpose); +my %nosymbol_table =3D (); my $declaration_start_line; my ($type, $declaration_name, $return_type); my ($newsection, $newcontents, $prototype, $brcount, %source_map); @@ -434,10 +433,9 @@ while ($ARGV[0] =3D~ m/^--?(.*)/) { $output_selection =3D OUTPUT_INCLUDE; $function =3D shift @ARGV; $function_table{$function} =3D 1; - } elsif ($cmd eq "nofunction") { # output all except specific functions - $output_selection =3D OUTPUT_EXCLUDE; - $function =3D shift @ARGV; - $function_table{$function} =3D 1; + } elsif ($cmd eq "nosymbol") { # Exclude specific symbols + my $symbol =3D shift @ARGV; + $nosymbol_table{$symbol} =3D 1; } elsif ($cmd eq "export") { # only exported symbols $output_selection =3D OUTPUT_EXPORTED; %function_table =3D (); @@ -570,11 +568,11 @@ sub dump_doc_section { return; } =20 + return if (defined($nosymbol_table{$name})); + if (($output_selection =3D=3D OUTPUT_ALL) || - ($output_selection =3D=3D OUTPUT_INCLUDE && - defined($function_table{$name})) || - ($output_selection =3D=3D OUTPUT_EXCLUDE && - !defined($function_table{$name}))) + (($output_selection =3D=3D OUTPUT_INCLUDE) && + defined($function_table{$name}))) { dump_section($file, $name, $contents); output_blockhead({'sectionlist' =3D> \@sectionlist, @@ -800,6 +798,8 @@ sub output_blockhead_rst(%) { my ($parameter, $section); =20 foreach $section (@{$args{'sectionlist'}}) { + next if (defined($nosymbol_table{$section})); + if ($output_selection !=3D OUTPUT_INCLUDE) { print "**$section**\n\n"; } @@ -1115,12 +1115,14 @@ sub output_declaration { my $name =3D shift; my $functype =3D shift; my $func =3D "output_${functype}_$output_mode"; + + return if (defined($nosymbol_table{$name})); + if (($output_selection =3D=3D OUTPUT_ALL) || (($output_selection =3D=3D OUTPUT_INCLUDE || $output_selection =3D=3D OUTPUT_EXPORTED) && defined($function_table{$name})) || - (($output_selection =3D=3D OUTPUT_EXCLUDE || - $output_selection =3D=3D OUTPUT_INTERNAL) && + ($output_selection =3D=3D OUTPUT_INTERNAL && !($functype eq "function" && defined($function_table{$name})))) { &$func(@_); @@ -1301,6 +1303,8 @@ sub show_warnings($$) { my $functype =3D shift; my $name =3D shift; =20 + return 0 if (defined($nosymbol_table{$name})); + return 1 if ($output_selection =3D=3D OUTPUT_ALL); =20 if ($output_selection =3D=3D OUTPUT_EXPORTED) { @@ -1324,13 +1328,6 @@ sub show_warnings($$) { return 0; } } - if ($output_selection =3D=3D OUTPUT_EXCLUDE) { - if (!defined($function_table{$name})) { - return 1; - } else { - return 0; - } - } die("Please add the new output type at show_warnings()"); } =20 @@ -1952,6 +1949,7 @@ sub process_export_file($) { =20 while () { if (/$export_symbol/) { + next if (defined($nosymbol_table{$2})); $function_table{$2} =3D 1; } } --=20 2.26.2