linux-kernel - [PATCH 2/2] Documentation: Remove deprecated kernel-doc option 'functions'

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date: Mon, 22 Jan 2024 14:28:20 +0100
From: Anna-Maria Behnsen <anna-maria@...utronix.de>
To: linux-doc@...r.kernel.org
Cc: Jonathan Corbet <corbet@....net>,
	Thomas Gleixner <tglx@...utronix.de>,
	Ingo Molnar <mingo@...hat.com>,
	Borislav Petkov <bp@...en8.de>,
	x86@...nel.org,
	Mike Rapoport <rppt@...nel.org>,
	Herbert Xu <herbert@...dor.apana.org.au>,
	"David S. Miller" <davem@...emloft.net>,
	Marco Elver <elver@...gle.com>,
	Alexander Potapenko <glider@...gle.com>,
	Shuah Khan <shuah@...nel.org>,
	Johannes Berg <johannes@...solutions.net>,
	Moritz Fischer <mdf@...nel.org>,
	Wu Hao <hao.wu@...el.com>,
	Xu Yilun <yilun.xu@...el.com>,
	Dipen Patel <dipenp@...dia.com>,
	Philipp Zabel <p.zabel@...gutronix.de>,
	Heikki Krogerus <heikki.krogerus@...ux.intel.com>,
	David Airlie <airlied@...il.com>,
	Daniel Vetter <daniel@...ll.ch>,
	Maarten Lankhorst <maarten.lankhorst@...ux.intel.com>,
	Maxime Ripard <mripard@...nel.org>,
	Thomas Zimmermann <tzimmermann@...e.de>,
	Jiri Kosina <jikos@...nel.org>,
	Benjamin Tissoires <benjamin.tissoires@...hat.com>,
	linux-kernel@...r.kernel.org,
	Anna-Maria Behnsen <anna-maria@...utronix.de>
Subject: [PATCH 2/2] Documentation: Remove deprecated kernel-doc option 'functions'

As there are no more users of deprecated kernel-doc option 'functions', remove
the related parts in documentation and scripts.

Signed-off-by: Anna-Maria Behnsen <anna-maria@...utronix.de>
---
 Documentation/doc-guide/kernel-doc.rst | 3 ---
 Documentation/sphinx/kerneldoc.py      | 5 -----
 2 files changed, 8 deletions(-)

diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst
index 6ad72ac6861b..74d6408abcd3 100644
--- a/Documentation/doc-guide/kernel-doc.rst
+++ b/Documentation/doc-guide/kernel-doc.rst
@@ -505,9 +505,6 @@ no-identifiers: *[ function/type ...]*
     .. kernel-doc:: lib/bitmap.c
        :no-identifiers: bitmap_parselist
 
-functions: *[ function/type ...]*
-  This is an alias of the 'identifiers' directive and deprecated.
-
 doc: *title*
   Include documentation for the ``DOC:`` paragraph identified by *title* in
   *source*. Spaces are allowed in *title*; do not quote the *title*. The *title*
diff --git a/Documentation/sphinx/kerneldoc.py b/Documentation/sphinx/kerneldoc.py
index 7acf09963daa..2d57c464c76a 100644
--- a/Documentation/sphinx/kerneldoc.py
+++ b/Documentation/sphinx/kerneldoc.py
@@ -53,7 +53,6 @@ class KernelDocDirective(Directive):
         'internal': directives.unchanged,
         'identifiers': directives.unchanged,
         'no-identifiers': directives.unchanged,
-        'functions': directives.unchanged,
     }
     has_content = False
 
@@ -74,10 +73,6 @@ class KernelDocDirective(Directive):
 
         tab_width = self.options.get('tab-width', self.state.document.settings.tab_width)
 
-        # 'function' is an alias of 'identifiers'
-        if 'functions' in self.options:
-            self.options['identifiers'] = self.options.get('functions')
-
         # FIXME: make this nicer and more robust against errors
         if 'export' in self.options:
             cmd += ['-export']
-- 
2.39.2