From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> To: Linux Doc Mailing List <linux-doc@vger.kernel.org>, Greg Kroah-Hartman <gregkh@linuxfoundation.org> Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>, Mauro Carvalho Chehab <mchehab@infradead.org>, linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>, linuxppc-dev@lists.ozlabs.org, Andrew Donnellan <ajd@linux.ibm.com>, Jonathan Cameron <jic23@kernel.org>, Lars-Peter Clausen <lars@metafoo.de>, Anton Vorontsov <anton@enomsg.org>, linux-pm@vger.kernel.org, Colin Cross <ccross@android.com>, linux-iio@vger.kernel.org, Hartmut Knaack <knaack.h@gmx.de>, Sebastian Reichel <sre@kernel.org>, Frederic Barrat <fbarrat@linux.ibm.com>, Andreas Klinger <ak@it-klinger.de>, Tony Luck <tony.luck@intel.com>, Peter Meerwald-Stadler <pmeerw@pmeerw.net>, Stefan Achatz <erazor_de@users.sourceforge.net>, Kees Cook <keescook@chromium.org> Subject: [PATCH 00/14] Add support to generate ABI documentation at admin-guide Date: Thu, 13 Jun 2019 23:04:06 -0300 [thread overview] Message-ID: <cover.1560477540.git.mchehab+samsung@kernel.org> (raw) Greg, As promised, I'm resending the patch series with adds the Kernel ABI to Documentation/admin-guide. Those patches are basically the version 3 patchset I sent back in 2017, rebased on the top of linux-next (next-20190613), and with some fixes in order for it to work. - The 4 initial patches to fix some ABI descriptions that are violating the syntax described at Documentation/ABI/README; - The next 6 patches are the ones originally written in 2017 with a script with parses the ABI files; - The 11th patch is a new one: it relaxes a little bit the parser in order to parse file headers that contains colons on it; - The 12th patch adds the new script to the documentation build system, together with a new python Sphinx extension with calls it; - The 13th patch fixes the python script when running with newer Sphinx versions (1.7 and upper); - The final patch fixes an UTF-8 trouble. I noticed it only with Sphinx 1.4, but it could affect other versions too. So, I ended by changing the UTF-8 encoding logit to work version-independent, just like what happens with kerneldoc.py extension. Mauro Carvalho Chehab (14): ABI: fix some syntax issues at the ABI database ABI: sysfs-driver-hid: the "What" field doesn't parse fine ABI: sysfs-class-uwb_rc: remove a duplicated incomplete entry ABI: better identificate tables scripts: add an script to parse the ABI files scripts/get_abi.pl: parse files with text at beginning scripts/get_abi.pl: avoid use literal blocks when not needed scripts/get_abi.pl: split label naming from xref logic scripts/get_abi.pl: add support for searching for ABI symbols scripts/get_abi.pl: represent what in tables scripts/get_abi.pl: fix parse issues with some files doc-rst: add ABI documentation to the admin-guide book sphinx/kernel_abi.py: make it compatible with Sphinx 1.7+ docs: sphinx/kernel_abi.py: fix UTF-8 support .../ABI/obsolete/sysfs-driver-hid-roccat-pyra | 2 +- Documentation/ABI/testing/pstore | 2 +- .../sysfs-bus-event_source-devices-format | 2 +- .../ABI/testing/sysfs-bus-i2c-devices-hm6352 | 6 +- .../ABI/testing/sysfs-bus-iio-distance-srf08 | 4 +- .../testing/sysfs-bus-iio-proximity-as3935 | 4 +- .../ABI/testing/sysfs-bus-pci-devices-cciss | 22 +- .../testing/sysfs-bus-usb-devices-usbsevseg | 12 +- .../sysfs-class-backlight-driver-lm3533 | 6 +- Documentation/ABI/testing/sysfs-class-cxl | 6 +- Documentation/ABI/testing/sysfs-class-devfreq | 2 +- .../ABI/testing/sysfs-class-led-driver-lm3533 | 8 +- .../ABI/testing/sysfs-class-leds-gt683r | 4 +- .../ABI/testing/sysfs-class-powercap | 2 +- Documentation/ABI/testing/sysfs-class-uwb_rc | 6 - Documentation/ABI/testing/sysfs-driver-hid | 12 +- .../ABI/testing/sysfs-driver-hid-roccat-kone | 2 +- Documentation/ABI/testing/sysfs-kernel-fscaps | 2 +- .../ABI/testing/sysfs-kernel-vmcoreinfo | 2 +- Documentation/admin-guide/abi-obsolete.rst | 10 + Documentation/admin-guide/abi-removed.rst | 4 + Documentation/admin-guide/abi-stable.rst | 13 + Documentation/admin-guide/abi-testing.rst | 19 + Documentation/admin-guide/abi.rst | 11 + Documentation/admin-guide/index.rst | 1 + Documentation/conf.py | 2 +- Documentation/sphinx/kernel_abi.py | 172 +++++++ scripts/get_abi.pl | 450 ++++++++++++++++++ 28 files changed, 731 insertions(+), 57 deletions(-) create mode 100644 Documentation/admin-guide/abi-obsolete.rst create mode 100644 Documentation/admin-guide/abi-removed.rst create mode 100644 Documentation/admin-guide/abi-stable.rst create mode 100644 Documentation/admin-guide/abi-testing.rst create mode 100644 Documentation/admin-guide/abi.rst create mode 100644 Documentation/sphinx/kernel_abi.py create mode 100755 scripts/get_abi.pl -- 2.21.0
WARNING: multiple messages have this Message-ID (diff)
From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> To: Linux Doc Mailing List <linux-doc@vger.kernel.org>, Greg Kroah-Hartman <gregkh@linuxfoundation.org> Cc: Lars-Peter Clausen <lars@metafoo.de>, Andrew Donnellan <ajd@linux.ibm.com>, Kees Cook <keescook@chromium.org>, Jonathan Corbet <corbet@lwn.net>, linux-iio@vger.kernel.org, linux-pm@vger.kernel.org, Anton Vorontsov <anton@enomsg.org>, linux-kernel@vger.kernel.org, Andreas Klinger <ak@it-klinger.de>, Mauro Carvalho Chehab <mchehab@infradead.org>, Frederic Barrat <fbarrat@linux.ibm.com>, Tony Luck <tony.luck@intel.com>, Sebastian Reichel <sre@kernel.org>, Peter Meerwald-Stadler <pmeerw@pmeerw.net>, Colin Cross <ccross@android.com>, Mauro Carvalho Chehab <mchehab+samsung@kernel.org>, linuxppc-dev@lists.ozlabs.org, Stefan Achatz <erazor_de@users.sourceforge.net>, Jonathan Cameron <jic23@kernel.org>, Hartmut Knaack <knaack.h@gmx.de> Subject: [PATCH 00/14] Add support to generate ABI documentation at admin-guide Date: Thu, 13 Jun 2019 23:04:06 -0300 [thread overview] Message-ID: <cover.1560477540.git.mchehab+samsung@kernel.org> (raw) Greg, As promised, I'm resending the patch series with adds the Kernel ABI to Documentation/admin-guide. Those patches are basically the version 3 patchset I sent back in 2017, rebased on the top of linux-next (next-20190613), and with some fixes in order for it to work. - The 4 initial patches to fix some ABI descriptions that are violating the syntax described at Documentation/ABI/README; - The next 6 patches are the ones originally written in 2017 with a script with parses the ABI files; - The 11th patch is a new one: it relaxes a little bit the parser in order to parse file headers that contains colons on it; - The 12th patch adds the new script to the documentation build system, together with a new python Sphinx extension with calls it; - The 13th patch fixes the python script when running with newer Sphinx versions (1.7 and upper); - The final patch fixes an UTF-8 trouble. I noticed it only with Sphinx 1.4, but it could affect other versions too. So, I ended by changing the UTF-8 encoding logit to work version-independent, just like what happens with kerneldoc.py extension. Mauro Carvalho Chehab (14): ABI: fix some syntax issues at the ABI database ABI: sysfs-driver-hid: the "What" field doesn't parse fine ABI: sysfs-class-uwb_rc: remove a duplicated incomplete entry ABI: better identificate tables scripts: add an script to parse the ABI files scripts/get_abi.pl: parse files with text at beginning scripts/get_abi.pl: avoid use literal blocks when not needed scripts/get_abi.pl: split label naming from xref logic scripts/get_abi.pl: add support for searching for ABI symbols scripts/get_abi.pl: represent what in tables scripts/get_abi.pl: fix parse issues with some files doc-rst: add ABI documentation to the admin-guide book sphinx/kernel_abi.py: make it compatible with Sphinx 1.7+ docs: sphinx/kernel_abi.py: fix UTF-8 support .../ABI/obsolete/sysfs-driver-hid-roccat-pyra | 2 +- Documentation/ABI/testing/pstore | 2 +- .../sysfs-bus-event_source-devices-format | 2 +- .../ABI/testing/sysfs-bus-i2c-devices-hm6352 | 6 +- .../ABI/testing/sysfs-bus-iio-distance-srf08 | 4 +- .../testing/sysfs-bus-iio-proximity-as3935 | 4 +- .../ABI/testing/sysfs-bus-pci-devices-cciss | 22 +- .../testing/sysfs-bus-usb-devices-usbsevseg | 12 +- .../sysfs-class-backlight-driver-lm3533 | 6 +- Documentation/ABI/testing/sysfs-class-cxl | 6 +- Documentation/ABI/testing/sysfs-class-devfreq | 2 +- .../ABI/testing/sysfs-class-led-driver-lm3533 | 8 +- .../ABI/testing/sysfs-class-leds-gt683r | 4 +- .../ABI/testing/sysfs-class-powercap | 2 +- Documentation/ABI/testing/sysfs-class-uwb_rc | 6 - Documentation/ABI/testing/sysfs-driver-hid | 12 +- .../ABI/testing/sysfs-driver-hid-roccat-kone | 2 +- Documentation/ABI/testing/sysfs-kernel-fscaps | 2 +- .../ABI/testing/sysfs-kernel-vmcoreinfo | 2 +- Documentation/admin-guide/abi-obsolete.rst | 10 + Documentation/admin-guide/abi-removed.rst | 4 + Documentation/admin-guide/abi-stable.rst | 13 + Documentation/admin-guide/abi-testing.rst | 19 + Documentation/admin-guide/abi.rst | 11 + Documentation/admin-guide/index.rst | 1 + Documentation/conf.py | 2 +- Documentation/sphinx/kernel_abi.py | 172 +++++++ scripts/get_abi.pl | 450 ++++++++++++++++++ 28 files changed, 731 insertions(+), 57 deletions(-) create mode 100644 Documentation/admin-guide/abi-obsolete.rst create mode 100644 Documentation/admin-guide/abi-removed.rst create mode 100644 Documentation/admin-guide/abi-stable.rst create mode 100644 Documentation/admin-guide/abi-testing.rst create mode 100644 Documentation/admin-guide/abi.rst create mode 100644 Documentation/sphinx/kernel_abi.py create mode 100755 scripts/get_abi.pl -- 2.21.0
next reply other threads:[~2019-06-14 2:04 UTC|newest] Thread overview: 69+ messages / expand[flat|nested] mbox.gz Atom feed top 2019-06-14 2:04 Mauro Carvalho Chehab [this message] 2019-06-14 2:04 ` [PATCH 00/14] Add support to generate ABI documentation at admin-guide Mauro Carvalho Chehab 2019-06-14 2:04 ` [PATCH 01/14] ABI: fix some syntax issues at the ABI database Mauro Carvalho Chehab 2019-06-14 2:04 ` Mauro Carvalho Chehab 2019-06-14 7:20 ` Andrew Donnellan 2019-06-14 7:20 ` Andrew Donnellan 2019-06-14 16:16 ` Greg Kroah-Hartman 2019-06-14 16:16 ` Greg Kroah-Hartman 2019-06-14 8:30 ` Rafael J. Wysocki 2019-06-14 8:30 ` Rafael J. Wysocki 2019-06-14 2:04 ` [PATCH 02/14] ABI: sysfs-driver-hid: the "What" field doesn't parse fine Mauro Carvalho Chehab 2019-06-14 2:04 ` [PATCH 03/14] ABI: sysfs-class-uwb_rc: remove a duplicated incomplete entry Mauro Carvalho Chehab 2019-06-14 2:04 ` [PATCH 04/14] ABI: better identificate tables Mauro Carvalho Chehab 2019-06-19 12:51 ` Johan Hovold 2019-06-19 13:56 ` Mauro Carvalho Chehab 2019-06-19 15:02 ` Greg Kroah-Hartman 2019-06-19 16:14 ` Mauro Carvalho Chehab 2019-06-20 14:27 ` Mauro Carvalho Chehab 2019-06-21 7:21 ` Greg Kroah-Hartman 2019-06-21 9:49 ` Mauro Carvalho Chehab 2019-06-20 12:01 ` Johan Hovold 2019-06-20 12:54 ` Greg Kroah-Hartman 2019-06-20 14:20 ` Mauro Carvalho Chehab 2019-06-20 16:29 ` Greg Kroah-Hartman 2019-06-20 17:16 ` Mauro Carvalho Chehab 2019-06-20 17:55 ` Greg Kroah-Hartman 2019-06-14 2:04 ` [PATCH 05/14] scripts: add an script to parse the ABI files Mauro Carvalho Chehab 2019-06-14 13:31 ` Jani Nikula 2019-06-14 13:39 ` Greg Kroah-Hartman 2019-06-14 13:58 ` Mauro Carvalho Chehab 2019-06-14 14:00 ` Jani Nikula 2019-06-14 14:14 ` Jonathan Corbet 2019-06-14 16:24 ` Greg Kroah-Hartman 2019-06-14 2:04 ` [PATCH 06/14] scripts/get_abi.pl: parse files with text at beginning Mauro Carvalho Chehab 2019-06-14 2:04 ` [PATCH 07/14] scripts/get_abi.pl: avoid use literal blocks when not needed Mauro Carvalho Chehab 2019-06-14 2:04 ` [PATCH 08/14] scripts/get_abi.pl: split label naming from xref logic Mauro Carvalho Chehab 2019-06-14 2:04 ` [PATCH 09/14] scripts/get_abi.pl: add support for searching for ABI symbols Mauro Carvalho Chehab 2019-06-14 2:04 ` [PATCH 10/14] scripts/get_abi.pl: represent what in tables Mauro Carvalho Chehab 2019-06-14 2:04 ` [PATCH 11/14] scripts/get_abi.pl: fix parse issues with some files Mauro Carvalho Chehab 2019-06-14 2:04 ` [PATCH 12/14] doc-rst: add ABI documentation to the admin-guide book Mauro Carvalho Chehab 2019-06-14 13:42 ` Jani Nikula 2019-06-14 14:06 ` Greg Kroah-Hartman 2019-06-14 15:27 ` Mauro Carvalho Chehab 2019-06-17 12:36 ` Jani Nikula 2019-06-17 12:54 ` Greg Kroah-Hartman 2019-06-17 13:48 ` Jonathan Corbet 2019-06-17 13:50 ` Jani Nikula 2019-06-17 13:51 ` Mauro Carvalho Chehab 2019-06-18 8:47 ` Jani Nikula 2019-06-19 16:37 ` Mauro Carvalho Chehab 2019-06-21 14:27 ` Mauro Carvalho Chehab 2019-06-27 9:48 ` Jani Nikula 2019-06-27 10:52 ` Mauro Carvalho Chehab 2019-06-14 14:10 ` Markus Heiser 2019-06-14 14:15 ` Jonathan Corbet 2019-06-16 16:04 ` Markus Heiser 2019-06-17 9:11 ` Mauro Carvalho Chehab 2019-06-17 16:31 ` Markus Heiser 2019-06-14 2:04 ` [PATCH 13/14] sphinx/kernel_abi.py: make it compatible with Sphinx 1.7+ Mauro Carvalho Chehab 2019-06-14 2:04 ` [PATCH 14/14] docs: sphinx/kernel_abi.py: fix UTF-8 support Mauro Carvalho Chehab 2019-06-14 16:18 ` Greg Kroah-Hartman 2019-06-14 16:25 ` Mauro Carvalho Chehab 2019-06-15 6:16 ` Greg Kroah-Hartman 2019-06-16 15:43 ` Markus Heiser 2019-06-17 9:16 ` Mauro Carvalho Chehab 2019-06-17 13:56 ` Jonathan Corbet 2019-06-17 15:55 ` Mauro Carvalho Chehab 2019-06-14 16:20 ` [PATCH 00/14] Add support to generate ABI documentation at admin-guide Greg Kroah-Hartman 2019-06-14 16:20 ` Greg Kroah-Hartman
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=cover.1560477540.git.mchehab+samsung@kernel.org \ --to=mchehab+samsung@kernel.org \ --cc=ajd@linux.ibm.com \ --cc=ak@it-klinger.de \ --cc=anton@enomsg.org \ --cc=ccross@android.com \ --cc=corbet@lwn.net \ --cc=erazor_de@users.sourceforge.net \ --cc=fbarrat@linux.ibm.com \ --cc=gregkh@linuxfoundation.org \ --cc=jic23@kernel.org \ --cc=keescook@chromium.org \ --cc=knaack.h@gmx.de \ --cc=lars@metafoo.de \ --cc=linux-doc@vger.kernel.org \ --cc=linux-iio@vger.kernel.org \ --cc=linux-kernel@vger.kernel.org \ --cc=linux-pm@vger.kernel.org \ --cc=linuxppc-dev@lists.ozlabs.org \ --cc=mchehab@infradead.org \ --cc=pmeerw@pmeerw.net \ --cc=sre@kernel.org \ --cc=tony.luck@intel.com \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.