linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 0/9] Extend automarkup support for ABI symbols
@ 2025-02-11  6:22 Mauro Carvalho Chehab
  2025-02-11  6:22 ` [PATCH 1/9] docs: media: Allow creating cross-references for RC ABI Mauro Carvalho Chehab
                   ` (9 more replies)
  0 siblings, 10 replies; 15+ messages in thread
From: Mauro Carvalho Chehab @ 2025-02-11  6:22 UTC (permalink / raw)
  To: Linux Doc Mailing List, Jonathan Corbet
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
	David S. Miller, Alex Shi, Andreas Noever, Avadhut Naik,
	Carlos Bilbao, Catalin Marinas, Eric Dumazet, Hu Haowen,
	Jakub Kicinski, Lars-Peter Clausen, Michael Jamet,
	Mika Westerberg, Paolo Abeni, Sean Young, Simon Horman,
	Will Deacon, William Breathitt Gray, Yanteng Si, Yehezkel Bernat,
	linux-arm-kernel, linux-iio, linux-media, linux-usb, netdev,
	workflows

Now that ABI creates a python dictionary, use automarkup to create cross
references for ABI symbols as well. 

Mauro Carvalho Chehab (9):
  docs: media: Allow creating cross-references for RC ABI
  docs: automarkup: drop legacy support
  docs: thunderbolt: Allow creating cross-references for ABI
  docs: arm: asymmetric-32bit: Allow creating cross-references for ABI
  docs: arm: generic-counter: Allow creating cross-references for ABI
  docs: iio: Allow creating cross-references ABI
  docs: networking: Allow creating cross-references statistics ABI
  docs: submit-checklist: Allow creating cross-references for ABI README
  docs: translations: Allow creating cross-references for ABI README

 Documentation/admin-guide/thunderbolt.rst     |  2 +-
 Documentation/arch/arm64/asymmetric-32bit.rst |  2 +-
 Documentation/driver-api/generic-counter.rst  |  4 +-
 Documentation/driver-api/iio/core.rst         |  2 +-
 Documentation/iio/iio_devbuf.rst              |  2 +-
 Documentation/networking/statistics.rst       |  2 +-
 Documentation/process/submit-checklist.rst    |  2 +-
 Documentation/sphinx/automarkup.py            | 47 ++++++++-----------
 .../it_IT/process/submit-checklist.rst        |  2 +-
 .../sp_SP/process/submit-checklist.rst        |  2 +-
 .../zh_CN/process/submit-checklist.rst        |  2 +-
 .../zh_TW/process/submit-checklist.rst        |  2 +-
 .../userspace-api/media/rc/rc-sysfs-nodes.rst |  2 +-
 13 files changed, 32 insertions(+), 41 deletions(-)

-- 
2.48.1



^ permalink raw reply	[flat|nested] 15+ messages in thread

* [PATCH 1/9] docs: media: Allow creating cross-references for RC ABI
  2025-02-11  6:22 [PATCH 0/9] Extend automarkup support for ABI symbols Mauro Carvalho Chehab
@ 2025-02-11  6:22 ` Mauro Carvalho Chehab
  2025-02-11  6:22 ` [PATCH 2/9] docs: automarkup: drop legacy support Mauro Carvalho Chehab
                   ` (8 subsequent siblings)
  9 siblings, 0 replies; 15+ messages in thread
From: Mauro Carvalho Chehab @ 2025-02-11  6:22 UTC (permalink / raw)
  To: Linux Doc Mailing List, Jonathan Corbet
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Sean Young,
	linux-kernel, linux-media

Now that Documentation/ABI is processed by automarkup, let it
generate cross-references for RC sysfs devnodes.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/sphinx/automarkup.py              | 17 +++++++++++++----
 .../userspace-api/media/rc/rc-sysfs-nodes.rst   |  2 +-
 2 files changed, 14 insertions(+), 5 deletions(-)

diff --git a/Documentation/sphinx/automarkup.py b/Documentation/sphinx/automarkup.py
index 22defc18d6d2..03bb7020f5cb 100644
--- a/Documentation/sphinx/automarkup.py
+++ b/Documentation/sphinx/automarkup.py
@@ -88,13 +88,13 @@ def markup_refs(docname, app, node):
     # Associate each regex with the function that will markup its matches
     #
     markup_func_sphinx2 = {RE_doc: markup_doc_ref,
-                           RE_abi_file: markup_abi_ref,
+                           RE_abi_file: markup_abi_file_ref,
                            RE_abi_symbol: markup_abi_ref,
                            RE_function: markup_c_ref,
                            RE_generic_type: markup_c_ref}
 
     markup_func_sphinx3 = {RE_doc: markup_doc_ref,
-                           RE_abi_file: markup_abi_ref,
+                           RE_abi_file: markup_abi_file_ref,
                            RE_abi_symbol: markup_abi_ref,
                            RE_function: markup_func_ref_sphinx3,
                            RE_struct: markup_c_ref,
@@ -279,10 +279,10 @@ def markup_doc_ref(docname, app, match):
         return nodes.Text(match.group(0))
 
 #
-# Try to replace a documentation reference of the form Documentation/ABI/...
+# Try to replace a documentation reference for ABI symbols and files
 # with a cross reference to that page
 #
-def markup_abi_ref(docname, app, match):
+def markup_abi_ref(docname, app, match, warning=False):
     stddom = app.env.domains['std']
     #
     # Go through the dance of getting an xref out of the std domain
@@ -294,6 +294,8 @@ def markup_abi_ref(docname, app, match):
 
     # Kernel ABI doesn't describe such file or symbol
     if not target:
+        if warning:
+            kernel_abi.log.warning("%s not found", fname)
         return nodes.Text(match.group(0))
 
     pxref = addnodes.pending_xref('', refdomain = 'std', reftype = 'ref',
@@ -317,6 +319,13 @@ def markup_abi_ref(docname, app, match):
     else:
         return nodes.Text(match.group(0))
 
+#
+# Variant of markup_abi_ref() that warns whan a reference is not found
+#
+def markup_abi_file_ref(docname, app, match):
+    return markup_abi_ref(docname, app, match, warning=True)
+
+
 def get_c_namespace(app, docname):
     source = app.env.doc2path(docname)
     with open(source) as f:
diff --git a/Documentation/userspace-api/media/rc/rc-sysfs-nodes.rst b/Documentation/userspace-api/media/rc/rc-sysfs-nodes.rst
index 34d6a0a1f4d3..70b5966aaff8 100644
--- a/Documentation/userspace-api/media/rc/rc-sysfs-nodes.rst
+++ b/Documentation/userspace-api/media/rc/rc-sysfs-nodes.rst
@@ -6,7 +6,7 @@
 Remote Controller's sysfs nodes
 *******************************
 
-As defined at ``Documentation/ABI/testing/sysfs-class-rc``, those are
+As defined at Documentation/ABI/testing/sysfs-class-rc, those are
 the sysfs nodes that control the Remote Controllers:
 
 
-- 
2.48.1


^ permalink raw reply related	[flat|nested] 15+ messages in thread

* [PATCH 2/9] docs: automarkup: drop legacy support
  2025-02-11  6:22 [PATCH 0/9] Extend automarkup support for ABI symbols Mauro Carvalho Chehab
  2025-02-11  6:22 ` [PATCH 1/9] docs: media: Allow creating cross-references for RC ABI Mauro Carvalho Chehab
@ 2025-02-11  6:22 ` Mauro Carvalho Chehab
  2025-02-11  6:22 ` [PATCH 3/9] docs: thunderbolt: Allow creating cross-references for ABI Mauro Carvalho Chehab
                   ` (7 subsequent siblings)
  9 siblings, 0 replies; 15+ messages in thread
From: Mauro Carvalho Chehab @ 2025-02-11  6:22 UTC (permalink / raw)
  To: Linux Doc Mailing List, Jonathan Corbet
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel

Python 2 is already EOL for quite some time. Drop support for
it.

Also, the minimal Sphinx version is now 3.4.3. So, we can drop
support for Sphinx < 3.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/sphinx/automarkup.py | 32 +++++++-----------------------
 1 file changed, 7 insertions(+), 25 deletions(-)

diff --git a/Documentation/sphinx/automarkup.py b/Documentation/sphinx/automarkup.py
index 03bb7020f5cb..ecf54d22e9dc 100644
--- a/Documentation/sphinx/automarkup.py
+++ b/Documentation/sphinx/automarkup.py
@@ -13,14 +13,6 @@ from itertools import chain
 
 from kernel_abi import get_kernel_abi
 
-#
-# Python 2 lacks re.ASCII...
-#
-try:
-    ascii_p3 = re.ASCII
-except AttributeError:
-    ascii_p3 = 0
-
 #
 # Regex nastiness.  Of course.
 # Try to identify "function()" that's not already marked up some
@@ -28,22 +20,22 @@ except AttributeError:
 # :c:func: block (i.e. ":c:func:`mmap()`s" flakes out), so the last
 # bit tries to restrict matches to things that won't create trouble.
 #
-RE_function = re.compile(r'\b(([a-zA-Z_]\w+)\(\))', flags=ascii_p3)
+RE_function = re.compile(r'\b(([a-zA-Z_]\w+)\(\))', flags=re.ASCII)
 
 #
 # Sphinx 2 uses the same :c:type role for struct, union, enum and typedef
 #
 RE_generic_type = re.compile(r'\b(struct|union|enum|typedef)\s+([a-zA-Z_]\w+)',
-                             flags=ascii_p3)
+                             flags=re.ASCII)
 
 #
 # Sphinx 3 uses a different C role for each one of struct, union, enum and
 # typedef
 #
-RE_struct = re.compile(r'\b(struct)\s+([a-zA-Z_]\w+)', flags=ascii_p3)
-RE_union = re.compile(r'\b(union)\s+([a-zA-Z_]\w+)', flags=ascii_p3)
-RE_enum = re.compile(r'\b(enum)\s+([a-zA-Z_]\w+)', flags=ascii_p3)
-RE_typedef = re.compile(r'\b(typedef)\s+([a-zA-Z_]\w+)', flags=ascii_p3)
+RE_struct = re.compile(r'\b(struct)\s+([a-zA-Z_]\w+)', flags=re.ASCII)
+RE_union = re.compile(r'\b(union)\s+([a-zA-Z_]\w+)', flags=re.ASCII)
+RE_enum = re.compile(r'\b(enum)\s+([a-zA-Z_]\w+)', flags=re.ASCII)
+RE_typedef = re.compile(r'\b(typedef)\s+([a-zA-Z_]\w+)', flags=re.ASCII)
 
 #
 # Detects a reference to a documentation page of the form Documentation/... with
@@ -87,13 +79,8 @@ def markup_refs(docname, app, node):
     #
     # Associate each regex with the function that will markup its matches
     #
-    markup_func_sphinx2 = {RE_doc: markup_doc_ref,
-                           RE_abi_file: markup_abi_file_ref,
-                           RE_abi_symbol: markup_abi_ref,
-                           RE_function: markup_c_ref,
-                           RE_generic_type: markup_c_ref}
 
-    markup_func_sphinx3 = {RE_doc: markup_doc_ref,
+    markup_func = {RE_doc: markup_doc_ref,
                            RE_abi_file: markup_abi_file_ref,
                            RE_abi_symbol: markup_abi_ref,
                            RE_function: markup_func_ref_sphinx3,
@@ -103,11 +90,6 @@ def markup_refs(docname, app, node):
                            RE_typedef: markup_c_ref,
                            RE_git: markup_git}
 
-    if sphinx.version_info[0] >= 3:
-        markup_func = markup_func_sphinx3
-    else:
-        markup_func = markup_func_sphinx2
-
     match_iterators = [regex.finditer(t) for regex in markup_func]
     #
     # Sort all references by the starting position in text
-- 
2.48.1


^ permalink raw reply related	[flat|nested] 15+ messages in thread

* [PATCH 3/9] docs: thunderbolt: Allow creating cross-references for ABI
  2025-02-11  6:22 [PATCH 0/9] Extend automarkup support for ABI symbols Mauro Carvalho Chehab
  2025-02-11  6:22 ` [PATCH 1/9] docs: media: Allow creating cross-references for RC ABI Mauro Carvalho Chehab
  2025-02-11  6:22 ` [PATCH 2/9] docs: automarkup: drop legacy support Mauro Carvalho Chehab
@ 2025-02-11  6:22 ` Mauro Carvalho Chehab
  2025-02-11  6:22 ` [PATCH 4/9] docs: arm: asymmetric-32bit: " Mauro Carvalho Chehab
                   ` (6 subsequent siblings)
  9 siblings, 0 replies; 15+ messages in thread
From: Mauro Carvalho Chehab @ 2025-02-11  6:22 UTC (permalink / raw)
  To: Linux Doc Mailing List, Jonathan Corbet
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Andreas Noever,
	Michael Jamet, Mika Westerberg, Yehezkel Bernat, linux-kernel,
	linux-usb

Now that Documentation/ABI is processed by automarkup, let it
generate cross-references for the corresponding ABI file.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: Mika Westerberg <mika.westerberg@linux.intel.com>
---
 Documentation/admin-guide/thunderbolt.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/admin-guide/thunderbolt.rst b/Documentation/admin-guide/thunderbolt.rst
index 2ed79f41a411..d0502691dfa1 100644
--- a/Documentation/admin-guide/thunderbolt.rst
+++ b/Documentation/admin-guide/thunderbolt.rst
@@ -28,7 +28,7 @@ should be a userspace tool that handles all the low-level details, keeps
 a database of the authorized devices and prompts users for new connections.
 
 More details about the sysfs interface for Thunderbolt devices can be
-found in ``Documentation/ABI/testing/sysfs-bus-thunderbolt``.
+found in Documentation/ABI/testing/sysfs-bus-thunderbolt.
 
 Those users who just want to connect any device without any sort of
 manual work can add following line to
-- 
2.48.1


^ permalink raw reply related	[flat|nested] 15+ messages in thread

* [PATCH 4/9] docs: arm: asymmetric-32bit: Allow creating cross-references for ABI
  2025-02-11  6:22 [PATCH 0/9] Extend automarkup support for ABI symbols Mauro Carvalho Chehab
                   ` (2 preceding siblings ...)
  2025-02-11  6:22 ` [PATCH 3/9] docs: thunderbolt: Allow creating cross-references for ABI Mauro Carvalho Chehab
@ 2025-02-11  6:22 ` Mauro Carvalho Chehab
  2025-02-11  6:22 ` [PATCH 5/9] docs: arm: generic-counter: " Mauro Carvalho Chehab
                   ` (5 subsequent siblings)
  9 siblings, 0 replies; 15+ messages in thread
From: Mauro Carvalho Chehab @ 2025-02-11  6:22 UTC (permalink / raw)
  To: Linux Doc Mailing List, Jonathan Corbet
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Catalin Marinas,
	Will Deacon, linux-arm-kernel, linux-kernel

Now that Documentation/ABI is processed by automarkup, let it
generate cross-references for the corresponding ABI file.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/arch/arm64/asymmetric-32bit.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/arch/arm64/asymmetric-32bit.rst b/Documentation/arch/arm64/asymmetric-32bit.rst
index 1ca2b359a907..57b8d7476f71 100644
--- a/Documentation/arch/arm64/asymmetric-32bit.rst
+++ b/Documentation/arch/arm64/asymmetric-32bit.rst
@@ -55,7 +55,7 @@ sysfs
 
 The subset of CPUs capable of running 32-bit tasks is described in
 ``/sys/devices/system/cpu/aarch32_el0`` and is documented further in
-``Documentation/ABI/testing/sysfs-devices-system-cpu``.
+Documentation/ABI/testing/sysfs-devices-system-cpu.
 
 **Note:** CPUs are advertised by this file as they are detected and so
 late-onlining of 32-bit-capable CPUs can result in the file contents
-- 
2.48.1


^ permalink raw reply related	[flat|nested] 15+ messages in thread

* [PATCH 5/9] docs: arm: generic-counter: Allow creating cross-references for ABI
  2025-02-11  6:22 [PATCH 0/9] Extend automarkup support for ABI symbols Mauro Carvalho Chehab
                   ` (3 preceding siblings ...)
  2025-02-11  6:22 ` [PATCH 4/9] docs: arm: asymmetric-32bit: " Mauro Carvalho Chehab
@ 2025-02-11  6:22 ` Mauro Carvalho Chehab
  2025-02-11  6:23 ` [PATCH 6/9] docs: iio: Allow creating cross-references ABI Mauro Carvalho Chehab
                   ` (4 subsequent siblings)
  9 siblings, 0 replies; 15+ messages in thread
From: Mauro Carvalho Chehab @ 2025-02-11  6:22 UTC (permalink / raw)
  To: Linux Doc Mailing List, Jonathan Corbet
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab,
	William Breathitt Gray, linux-iio, linux-kernel

Now that Documentation/ABI is processed by automarkup, let it
generate cross-references for the corresponding ABI file.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/driver-api/generic-counter.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/driver-api/generic-counter.rst b/Documentation/driver-api/generic-counter.rst
index 71ccc30e586b..e826f16ea43d 100644
--- a/Documentation/driver-api/generic-counter.rst
+++ b/Documentation/driver-api/generic-counter.rst
@@ -467,7 +467,7 @@ Counter sysfs
 Translates counter data to the standard Counter sysfs interface format
 and vice versa.
 
-Please refer to the ``Documentation/ABI/testing/sysfs-bus-counter`` file
+Please refer to the Documentation/ABI/testing/sysfs-bus-counter file
 for a detailed breakdown of the available Generic Counter interface
 sysfs attributes.
 
@@ -483,7 +483,7 @@ Sysfs Interface
 Several sysfs attributes are generated by the Generic Counter interface,
 and reside under the ``/sys/bus/counter/devices/counterX`` directory,
 where ``X`` is to the respective counter device id. Please see
-``Documentation/ABI/testing/sysfs-bus-counter`` for detailed information
+Documentation/ABI/testing/sysfs-bus-counter for detailed information
 on each Generic Counter interface sysfs attribute.
 
 Through these sysfs attributes, programs and scripts may interact with
-- 
2.48.1


^ permalink raw reply related	[flat|nested] 15+ messages in thread

* [PATCH 6/9] docs: iio: Allow creating cross-references ABI
  2025-02-11  6:22 [PATCH 0/9] Extend automarkup support for ABI symbols Mauro Carvalho Chehab
                   ` (4 preceding siblings ...)
  2025-02-11  6:22 ` [PATCH 5/9] docs: arm: generic-counter: " Mauro Carvalho Chehab
@ 2025-02-11  6:23 ` Mauro Carvalho Chehab
  2025-02-11  6:23 ` [PATCH 7/9] docs: networking: Allow creating cross-references statistics ABI Mauro Carvalho Chehab
                   ` (3 subsequent siblings)
  9 siblings, 0 replies; 15+ messages in thread
From: Mauro Carvalho Chehab @ 2025-02-11  6:23 UTC (permalink / raw)
  To: Linux Doc Mailing List, Jonathan Corbet
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Cameron,
	Lars-Peter Clausen, Thorsten Scherer, linux-iio, linux-kernel,
	Jonathan Cameron

Now that Documentation/ABI is processed by automarkup, let it
generate cross-references for the corresponding ABI file.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
---
 Documentation/driver-api/iio/core.rst | 2 +-
 Documentation/iio/iio_devbuf.rst      | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/driver-api/iio/core.rst b/Documentation/driver-api/iio/core.rst
index dfe438dc91a7..42b580fb2989 100644
--- a/Documentation/driver-api/iio/core.rst
+++ b/Documentation/driver-api/iio/core.rst
@@ -60,7 +60,7 @@ directory.  Common attributes are:
 * :file:`sampling_frequency_available`, available discrete set of sampling
   frequency values for device.
 * Available standard attributes for IIO devices are described in the
-  :file:`Documentation/ABI/testing/sysfs-bus-iio` file in the Linux kernel
+  :file:Documentation/ABI/testing/sysfs-bus-iio file in the Linux kernel
   sources.
 
 IIO device channels
diff --git a/Documentation/iio/iio_devbuf.rst b/Documentation/iio/iio_devbuf.rst
index 9919e4792d0e..dca1f0200b0d 100644
--- a/Documentation/iio/iio_devbuf.rst
+++ b/Documentation/iio/iio_devbuf.rst
@@ -148,5 +148,5 @@ applied), however there are corner cases in which the buffered data may be found
 in a processed form. Please note that these corner cases are not addressed by
 this documentation.
 
-Please see ``Documentation/ABI/testing/sysfs-bus-iio`` for a complete
+Please see Documentation/ABI/testing/sysfs-bus-iio for a complete
 description of the attributes.
-- 
2.48.1


^ permalink raw reply related	[flat|nested] 15+ messages in thread

* [PATCH 7/9] docs: networking: Allow creating cross-references statistics ABI
  2025-02-11  6:22 [PATCH 0/9] Extend automarkup support for ABI symbols Mauro Carvalho Chehab
                   ` (5 preceding siblings ...)
  2025-02-11  6:23 ` [PATCH 6/9] docs: iio: Allow creating cross-references ABI Mauro Carvalho Chehab
@ 2025-02-11  6:23 ` Mauro Carvalho Chehab
  2025-02-13 16:07   ` Jakub Kicinski
  2025-02-11  6:23 ` [PATCH 8/9] docs: submit-checklist: Allow creating cross-references for ABI README Mauro Carvalho Chehab
                   ` (2 subsequent siblings)
  9 siblings, 1 reply; 15+ messages in thread
From: Mauro Carvalho Chehab @ 2025-02-11  6:23 UTC (permalink / raw)
  To: Linux Doc Mailing List, Jonathan Corbet
  Cc: Mauro Carvalho Chehab, David S. Miller, Mauro Carvalho Chehab,
	Eric Dumazet, Jakub Kicinski, Paolo Abeni, Simon Horman,
	linux-kernel, netdev

Now that Documentation/ABI is processed by automarkup, let it
generate cross-references for the corresponding ABI file.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/networking/statistics.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/networking/statistics.rst b/Documentation/networking/statistics.rst
index 75e017dfa825..518284e287b0 100644
--- a/Documentation/networking/statistics.rst
+++ b/Documentation/networking/statistics.rst
@@ -143,7 +143,7 @@ reading multiple stats as it internally performs a full dump of
 and reports only the stat corresponding to the accessed file.
 
 Sysfs files are documented in
-`Documentation/ABI/testing/sysfs-class-net-statistics`.
+Documentation/ABI/testing/sysfs-class-net-statistics.
 
 
 netlink
-- 
2.48.1


^ permalink raw reply related	[flat|nested] 15+ messages in thread

* [PATCH 8/9] docs: submit-checklist: Allow creating cross-references for ABI README
  2025-02-11  6:22 [PATCH 0/9] Extend automarkup support for ABI symbols Mauro Carvalho Chehab
                   ` (6 preceding siblings ...)
  2025-02-11  6:23 ` [PATCH 7/9] docs: networking: Allow creating cross-references statistics ABI Mauro Carvalho Chehab
@ 2025-02-11  6:23 ` Mauro Carvalho Chehab
  2025-02-11  6:23 ` [PATCH 9/9] docs: translations: " Mauro Carvalho Chehab
  2025-02-12 11:25 ` [PATCH 0/9] Extend automarkup support for ABI symbols Bagas Sanjaya
  9 siblings, 0 replies; 15+ messages in thread
From: Mauro Carvalho Chehab @ 2025-02-11  6:23 UTC (permalink / raw)
  To: Linux Doc Mailing List, Jonathan Corbet
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
	workflows

Now that Documentation/ABI is processed by automarkup, let it
generate cross-references for the ABI README file.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/process/submit-checklist.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/process/submit-checklist.rst b/Documentation/process/submit-checklist.rst
index 88b6358258d7..2abf8831cf74 100644
--- a/Documentation/process/submit-checklist.rst
+++ b/Documentation/process/submit-checklist.rst
@@ -52,7 +52,7 @@ Provide documentation
 4) All new module parameters are documented with ``MODULE_PARM_DESC()``
 
 5) All new userspace interfaces are documented in ``Documentation/ABI/``.
-   See ``Documentation/ABI/README`` for more information.
+   See Documentation/ABI/README for more information.
    Patches that change userspace interfaces should be CCed to
    linux-api@vger.kernel.org.
 
-- 
2.48.1


^ permalink raw reply related	[flat|nested] 15+ messages in thread

* [PATCH 9/9] docs: translations: Allow creating cross-references for ABI README
  2025-02-11  6:22 [PATCH 0/9] Extend automarkup support for ABI symbols Mauro Carvalho Chehab
                   ` (7 preceding siblings ...)
  2025-02-11  6:23 ` [PATCH 8/9] docs: submit-checklist: Allow creating cross-references for ABI README Mauro Carvalho Chehab
@ 2025-02-11  6:23 ` Mauro Carvalho Chehab
  2025-02-12 11:25 ` [PATCH 0/9] Extend automarkup support for ABI symbols Bagas Sanjaya
  9 siblings, 0 replies; 15+ messages in thread
From: Mauro Carvalho Chehab @ 2025-02-11  6:23 UTC (permalink / raw)
  To: Linux Doc Mailing List, Jonathan Corbet
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Alex Shi,
	Avadhut Naik, Carlos Bilbao, Federico Vaga, Hu Haowen,
	Randy Dunlap, Remington Brasga, Yanteng Si, linux-kernel

Update translations to also generate cross references for the ABI
readme file.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/translations/it_IT/process/submit-checklist.rst | 2 +-
 Documentation/translations/sp_SP/process/submit-checklist.rst | 2 +-
 Documentation/translations/zh_CN/process/submit-checklist.rst | 2 +-
 Documentation/translations/zh_TW/process/submit-checklist.rst | 2 +-
 4 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/translations/it_IT/process/submit-checklist.rst b/Documentation/translations/it_IT/process/submit-checklist.rst
index 692be4af9c9b..3308c3084c60 100644
--- a/Documentation/translations/it_IT/process/submit-checklist.rst
+++ b/Documentation/translations/it_IT/process/submit-checklist.rst
@@ -58,7 +58,7 @@ Fornite documentazione
 4) Tutti i nuovi parametri dei moduli sono documentati con ``MODULE_PARM_DESC()``.
 
 5) Tutte le nuove interfacce verso lo spazio utente sono documentate in
-    ``Documentation/ABI/``.  Leggete ``Documentation/ABI/README`` per maggiori
+    ``Documentation/ABI/``.  Leggete Documentation/ABI/README per maggiori
     informazioni.  Le patch che modificano le interfacce utente dovrebbero
     essere inviate in copia anche a linux-api@vger.kernel.org.
 
diff --git a/Documentation/translations/sp_SP/process/submit-checklist.rst b/Documentation/translations/sp_SP/process/submit-checklist.rst
index 0d6651f9d871..3087ba80e818 100644
--- a/Documentation/translations/sp_SP/process/submit-checklist.rst
+++ b/Documentation/translations/sp_SP/process/submit-checklist.rst
@@ -97,7 +97,7 @@ y en otros lugares con respecto al envío de parches del kernel de Linux.
     ``MODULE_PARM_DESC()``.
 
 18) Todas las nuevas interfaces de espacio de usuario están documentadas
-    en ``Documentation/ABI/``. Consulte ``Documentation/ABI/README`` para
+    en ``Documentation/ABI/``. Consulte Documentation/ABI/README para
     obtener más información. Los parches que cambian las interfaces del
     espacio de usuario deben ser CCed a linux-api@vger.kernel.org.
 
diff --git a/Documentation/translations/zh_CN/process/submit-checklist.rst b/Documentation/translations/zh_CN/process/submit-checklist.rst
index 10536b74aeec..5c20a7f0936b 100644
--- a/Documentation/translations/zh_CN/process/submit-checklist.rst
+++ b/Documentation/translations/zh_CN/process/submit-checklist.rst
@@ -82,7 +82,7 @@ Linux内核补丁提交检查单
 17) 所有新的模块参数都记录在 ``MODULE_PARM_DESC()``
 
 18) 所有新的用户空间接口都记录在 ``Documentation/ABI/`` 中。有关详细信息,
-    请参阅 ``Documentation/ABI/README`` 。更改用户空间接口的补丁应该抄送
+    请参阅 Documentation/ABI/README 。更改用户空间接口的补丁应该抄送
     linux-api@vger.kernel.org。
 
 19) 已通过至少注入slab和page分配失败进行检查。请参阅 ``Documentation/fault-injection/`` 。
diff --git a/Documentation/translations/zh_TW/process/submit-checklist.rst b/Documentation/translations/zh_TW/process/submit-checklist.rst
index 0ecb187753e4..b09d29b0cc1b 100644
--- a/Documentation/translations/zh_TW/process/submit-checklist.rst
+++ b/Documentation/translations/zh_TW/process/submit-checklist.rst
@@ -85,7 +85,7 @@ Linux內核補丁提交檢查單
 17) 所有新的模塊參數都記錄在 ``MODULE_PARM_DESC()``
 
 18) 所有新的用戶空間接口都記錄在 ``Documentation/ABI/`` 中。有關詳細信息,
-    請參閱 ``Documentation/ABI/README`` 。更改用戶空間接口的補丁應該抄送
+    請參閱 Documentation/ABI/README 。更改用戶空間接口的補丁應該抄送
     linux-api@vger.kernel.org。
 
 19) 已通過至少注入slab和page分配失敗進行檢查。請參閱 ``Documentation/fault-injection/`` 。
-- 
2.48.1


^ permalink raw reply related	[flat|nested] 15+ messages in thread

* Re: [PATCH 0/9] Extend automarkup support for ABI symbols
  2025-02-11  6:22 [PATCH 0/9] Extend automarkup support for ABI symbols Mauro Carvalho Chehab
                   ` (8 preceding siblings ...)
  2025-02-11  6:23 ` [PATCH 9/9] docs: translations: " Mauro Carvalho Chehab
@ 2025-02-12 11:25 ` Bagas Sanjaya
  2025-02-12 12:58   ` Mauro Carvalho Chehab
  9 siblings, 1 reply; 15+ messages in thread
From: Bagas Sanjaya @ 2025-02-12 11:25 UTC (permalink / raw)
  To: Mauro Carvalho Chehab, Linux Doc Mailing List, Jonathan Corbet
  Cc: linux-kernel, David S. Miller, Andreas Noever, Avadhut Naik,
	Catalin Marinas, Eric Dumazet, Hu Haowen, Lars-Peter Clausen,
	Michael Jamet, Mika Westerberg, Paolo Abeni, Sean Young,
	Yanteng Si, Yehezkel Bernat, Thomas Gleixner, Michael Ellerman,
	Shrikanth Hegde, Russell King (Oracle), Pawan Gupta, James Morse,
	Nysal Jan K.A, Tom Lendacky, Sourabh Jain, Stephen Rothwell,
	Frederic Barrat, Andrew Donnellan, Madhavan Srinivasan,
	Nicholas Piggin, Christophe Leroy, Naveen N Rao, linux-arm-kernel,
	linux-iio, linux-media, linux-usb, netdev, workflows,
	linuxppc-dev

[-- Attachment #1: Type: text/plain, Size: 851 bytes --]

On Tue, Feb 11, 2025 at 07:22:54AM +0100, Mauro Carvalho Chehab wrote:
> Now that ABI creates a python dictionary, use automarkup to create cross
> references for ABI symbols as well. 

I get three new warnings:

WARNING: /sys/devices/system/cpu/cpuX/topology/physical_package_id is defined 2 times: /home/bagas/repo/linux-kernel/Documentation/ABI/stable/sysfs-devices-system-cpu:27; /home/bagas/repo/linux-kernel/Documentation/ABI/testing/sysfs-devices-system-cpu:70
WARNING: /sys/devices/system/cpu/cpuX/topology/ppin is defined 2 times: /home/bagas/repo/linux-kernel/Documentation/ABI/stable/sysfs-devices-system-cpu:89; /home/bagas/repo/linux-kernel/Documentation/ABI/testing/sysfs-devices-system-cpu:70
WARNING: Documentation/ABI/testing/sysfs-class-cxl not found

Thanks.

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

^ permalink raw reply	[flat|nested] 15+ messages in thread

* Re: [PATCH 0/9] Extend automarkup support for ABI symbols
  2025-02-12 11:25 ` [PATCH 0/9] Extend automarkup support for ABI symbols Bagas Sanjaya
@ 2025-02-12 12:58   ` Mauro Carvalho Chehab
  2025-02-13  0:39     ` Andrew Donnellan
  2025-02-18 20:52     ` Jonathan Corbet
  0 siblings, 2 replies; 15+ messages in thread
From: Mauro Carvalho Chehab @ 2025-02-12 12:58 UTC (permalink / raw)
  To: Bagas Sanjaya
  Cc: Linux Doc Mailing List, Jonathan Corbet, linux-kernel,
	David S. Miller, Andreas Noever, Avadhut Naik, Catalin Marinas,
	Eric Dumazet, Hu Haowen, Lars-Peter Clausen, Michael Jamet,
	Mika Westerberg, Paolo Abeni, Sean Young, Yanteng Si,
	Yehezkel Bernat, Thomas Gleixner, Michael Ellerman,
	Shrikanth Hegde, Russell King (Oracle), Pawan Gupta, James Morse,
	Nysal Jan K.A, Tom Lendacky, Sourabh Jain, Stephen Rothwell,
	Frederic Barrat, Andrew Donnellan, Madhavan Srinivasan,
	Nicholas Piggin, Christophe Leroy, Naveen N Rao, linux-arm-kernel,
	linux-iio, linux-media, linux-usb, netdev, workflows,
	linuxppc-dev

Em Wed, 12 Feb 2025 18:25:15 +0700
Bagas Sanjaya <bagasdotme@gmail.com> escreveu:

> On Tue, Feb 11, 2025 at 07:22:54AM +0100, Mauro Carvalho Chehab wrote:
> > Now that ABI creates a python dictionary, use automarkup to create cross
> > references for ABI symbols as well.   
> 
> I get three new warnings:
> 
> WARNING: /sys/devices/system/cpu/cpuX/topology/physical_package_id is defined 2 times: /home/bagas/repo/linux-kernel/Documentation/ABI/stable/sysfs-devices-system-cpu:27; /home/bagas/repo/linux-kernel/Documentation/ABI/testing/sysfs-devices-system-cpu:70
> WARNING: /sys/devices/system/cpu/cpuX/topology/ppin is defined 2 times: /home/bagas/repo/linux-kernel/Documentation/ABI/stable/sysfs-devices-system-cpu:89; /home/bagas/repo/linux-kernel/Documentation/ABI/testing/sysfs-devices-system-cpu:70

Those two are new reports that get_abi.py detects after the recent changes.
In the past, symbol duplication were detected only within the same group
(testing, stable, ...). The new version can detect symbols that are
duplicated on different parts of the ABI. In this specific case, the same
symbols exist on both stable and testing.

There is a fix for them already at:

https://lore.kernel.org/linux-doc/673e9543783349b0fcf625018e38e4e93fe98f52.1738020236.git.mchehab+huawei@kernel.org/

> WARNING: Documentation/ABI/testing/sysfs-class-cxl not found

I need to double-check verify this one, as it didn't appear on
my tests. Are you getting it against docs-next or linux-next?

Thanks,
Mauro

^ permalink raw reply	[flat|nested] 15+ messages in thread

* Re: [PATCH 0/9] Extend automarkup support for ABI symbols
  2025-02-12 12:58   ` Mauro Carvalho Chehab
@ 2025-02-13  0:39     ` Andrew Donnellan
  2025-02-18 20:52     ` Jonathan Corbet
  1 sibling, 0 replies; 15+ messages in thread
From: Andrew Donnellan @ 2025-02-13  0:39 UTC (permalink / raw)
  To: Mauro Carvalho Chehab, Bagas Sanjaya
  Cc: Linux Doc Mailing List, Jonathan Corbet, linux-kernel,
	David S. Miller, Andreas Noever, Avadhut Naik, Catalin Marinas,
	Eric Dumazet, Hu Haowen, Lars-Peter Clausen, Michael Jamet,
	Mika Westerberg, Paolo Abeni, Sean Young, Yanteng Si,
	Yehezkel Bernat, Thomas Gleixner, Michael Ellerman,
	Shrikanth Hegde, Russell King (Oracle), Pawan Gupta, James Morse,
	Nysal Jan K.A, Tom Lendacky, Sourabh Jain, Stephen Rothwell,
	Frederic Barrat, Madhavan Srinivasan, Nicholas Piggin,
	Christophe Leroy, Naveen N Rao, linux-arm-kernel, linux-iio,
	linux-media, linux-usb, netdev, workflows, linuxppc-dev

On Wed, 2025-02-12 at 13:58 +0100, Mauro Carvalho Chehab wrote:
> > WARNING: Documentation/ABI/testing/sysfs-class-cxl not found
> 
> I need to double-check verify this one, as it didn't appear on
> my tests. Are you getting it against docs-next or linux-next?
> 

This is moved to obsolete/ by 5731d41af924b which was merged in rc1,
and will be moved again to removed/ by [0].

Andrew

[0]
https://patchwork.ozlabs.org/project/linuxppc-dev/patch/20250203072801.365551-3-ajd@linux.ibm.com/

-- 
Andrew Donnellan    OzLabs, ADL Canberra
ajd@linux.ibm.com   IBM Australia Limited

^ permalink raw reply	[flat|nested] 15+ messages in thread

* Re: [PATCH 7/9] docs: networking: Allow creating cross-references statistics ABI
  2025-02-11  6:23 ` [PATCH 7/9] docs: networking: Allow creating cross-references statistics ABI Mauro Carvalho Chehab
@ 2025-02-13 16:07   ` Jakub Kicinski
  0 siblings, 0 replies; 15+ messages in thread
From: Jakub Kicinski @ 2025-02-13 16:07 UTC (permalink / raw)
  To: Mauro Carvalho Chehab
  Cc: Linux Doc Mailing List, Jonathan Corbet, David S. Miller,
	Eric Dumazet, Paolo Abeni, linux-kernel, netdev

On Tue, 11 Feb 2025 07:23:01 +0100 Mauro Carvalho Chehab wrote:
> Now that Documentation/ABI is processed by automarkup, let it
> generate cross-references for the corresponding ABI file.

Acked-by: Jakub Kicinski <kuba@kernel.org>

^ permalink raw reply	[flat|nested] 15+ messages in thread

* Re: [PATCH 0/9] Extend automarkup support for ABI symbols
  2025-02-12 12:58   ` Mauro Carvalho Chehab
  2025-02-13  0:39     ` Andrew Donnellan
@ 2025-02-18 20:52     ` Jonathan Corbet
  1 sibling, 0 replies; 15+ messages in thread
From: Jonathan Corbet @ 2025-02-18 20:52 UTC (permalink / raw)
  To: Mauro Carvalho Chehab, Bagas Sanjaya
  Cc: Linux Doc Mailing List, linux-kernel, David S. Miller,
	Andreas Noever, Avadhut Naik, Catalin Marinas, Eric Dumazet,
	Hu Haowen, Lars-Peter Clausen, Michael Jamet, Mika Westerberg,
	Paolo Abeni, Sean Young, Yanteng Si, Yehezkel Bernat,
	Thomas Gleixner, Michael Ellerman, Shrikanth Hegde,
	Russell King (Oracle), Pawan Gupta, James Morse, Nysal Jan K.A,
	Tom Lendacky, Sourabh Jain, Stephen Rothwell, Frederic Barrat,
	Andrew Donnellan, Madhavan Srinivasan, Nicholas Piggin,
	Christophe Leroy, Naveen N Rao, linux-arm-kernel, linux-iio,
	linux-media, linux-usb, netdev, workflows, linuxppc-dev

Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:

>> WARNING: Documentation/ABI/testing/sysfs-class-cxl not found
>
> I need to double-check verify this one, as it didn't appear on
> my tests. Are you getting it against docs-next or linux-next?

I get this one too, FWIW.

I've gone ahead and applied the series, but this would be nice to get
cleaned up.

Thanks,

jon

^ permalink raw reply	[flat|nested] 15+ messages in thread

end of thread, other threads:[~2025-02-18 20:52 UTC | newest]

Thread overview: 15+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-02-11  6:22 [PATCH 0/9] Extend automarkup support for ABI symbols Mauro Carvalho Chehab
2025-02-11  6:22 ` [PATCH 1/9] docs: media: Allow creating cross-references for RC ABI Mauro Carvalho Chehab
2025-02-11  6:22 ` [PATCH 2/9] docs: automarkup: drop legacy support Mauro Carvalho Chehab
2025-02-11  6:22 ` [PATCH 3/9] docs: thunderbolt: Allow creating cross-references for ABI Mauro Carvalho Chehab
2025-02-11  6:22 ` [PATCH 4/9] docs: arm: asymmetric-32bit: " Mauro Carvalho Chehab
2025-02-11  6:22 ` [PATCH 5/9] docs: arm: generic-counter: " Mauro Carvalho Chehab
2025-02-11  6:23 ` [PATCH 6/9] docs: iio: Allow creating cross-references ABI Mauro Carvalho Chehab
2025-02-11  6:23 ` [PATCH 7/9] docs: networking: Allow creating cross-references statistics ABI Mauro Carvalho Chehab
2025-02-13 16:07   ` Jakub Kicinski
2025-02-11  6:23 ` [PATCH 8/9] docs: submit-checklist: Allow creating cross-references for ABI README Mauro Carvalho Chehab
2025-02-11  6:23 ` [PATCH 9/9] docs: translations: " Mauro Carvalho Chehab
2025-02-12 11:25 ` [PATCH 0/9] Extend automarkup support for ABI symbols Bagas Sanjaya
2025-02-12 12:58   ` Mauro Carvalho Chehab
2025-02-13  0:39     ` Andrew Donnellan
2025-02-18 20:52     ` Jonathan Corbet

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).