Add ABI and features docs to the Kernel documentation
Get series with b4
b4 am [email protected]Versions newest first
- v2 Latest22 patches 4 repliesIn review
Changes in v2 from the cover letter
- Some additional fixes and improvements to get_abi.pl script;
- get_abi.pl script now optionally suports parsing ABI files with
Patches in v2 No applies recorded yet
| # | Subject and files | Size | Replies | Applied |
|---|---|---|---|---|
| 1/22 | ABI: sysfs-bus-pci-devices-aer_stats uses an invalid tagDocumentation/ | +6 | 1 reply | |
| 2/22 | ABI: Fix KernelVersion tagsDocumentation/ Documentation/ Documentation/ +7 more | +31 | 1 reply | |
| 3/22 | scripts: add an script to parse the ABI filesscripts/ | +212 | 0 replies | |
| 4/22 | scripts/get_abi.pl: parse files with text at beginningscripts/ | +54 | 0 replies | |
| 5/22 | scripts/get_abi.pl: avoid use literal blocks when not neededscripts/ | +78 | 0 replies | |
| 6/22 | scripts/get_abi.pl: split label naming from xref logicscripts/ | +53 | 0 replies | |
| 7/22 | scripts/get_abi.pl: add support for searching for ABI symbolsscripts/ | +103 | 0 replies | |
| 8/22 | scripts/get_abi.pl: represent what in tablesscripts/ | +36 | 0 replies | |
| 9/22 | scripts/get_abi.pl: fix parse issues with some filesscripts/ | +2 | 0 replies | |
| 10/22 | scripts/get_abi.pl: avoid creating duplicate namesscripts/ | +9 | 0 replies | |
| 11/22 | scripts/get_abi.pl: add a handler for invalid "where" tagscripts/ | +6 | 0 replies | |
| 12/22 | scripts/get_abi.pl: add a validate commandscripts/ | +9 | 0 replies | |
| 13/22 | doc-rst: add ABI documentation to the admin-guide bookDocumentation/ Documentation/ Documentation/ +5 more | +214 | 0 replies | |
| 14/22 | docs: sphinx/kernel_abi.py: fix UTF-8 supportDocumentation/ | +7 | 0 replies | |
| 15/22 | sphinx/kernel_abi.py: make it compatible with Sphinx 1.7+Documentation/ | +27 | 0 replies | |
| 16/22 | docs: Kconfig/Makefile: add a check for broken ABI filesDocumentation/ Documentation/ lib/ +1 more | +29 | 0 replies | |
| 17/22 | docs: kernel_abi.py: Update copyrightsDocumentation/ | +2 | 0 replies | |
| 18/22 | doc: ABI scripts: add a SPDX header fileDocumentation/ scripts/ | +2 | 0 replies | |
| 19/22 | scripts: add a script to handle Documentation/featuresscripts/ | +472 | 0 replies | |
| 20/22 | docs: admin-guide, x86: add a features listDocumentation/ Documentation/ Documentation/ +3 more | +178 | 0 replies | |
| 21/22 | scripts/get_feat.pl: handle ".." special casescripts/ | +2 | 0 replies | |
| 22/22 | scripts/get_abi.pl: change script to allow parsing in ReST modescripts/ | +48 | 0 replies |
Reviews trailers per patch
2 of 22 patches have a Reviewed-by or Acked-by.
| Patch | Bjorn Helgaas | Kees Cook |
|---|---|---|
| 1/22 | A-b | |
| 2/22 | R-b | |
| 3/22 | ||
| 4/22 | ||
| 5/22 | ||
| 6/22 | ||
| 7/22 | ||
| 8/22 | ||
| 9/22 | ||
| 10/22 | ||
| 11/22 | ||
| 12/22 | ||
| 13/22 | ||
| 14/22 | ||
| 15/22 | ||
| 16/22 | ||
| 17/22 | ||
| 18/22 | ||
| 19/22 | ||
| 20/22 | ||
| 21/22 | ||
| 22/22 |
Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.
Cover letter [PATCH v2 00/22] Add ABI and features docs to the Kernel documentation
This is a rebased version of the scripts with parse Documentation/ABI and Documentation/feature files and produce a ReST output. Those scripts are added to the Kernel building system, in order to output their contents inside the Kernel documentation.
Please notice that, as discussed, I added support at get_abi.pl to handle ABI files as if they're compatible with ReST. Right now, this feature can't be enabled for normal builds, as it will cause Sphinx crashes. After getting the offending ABI files fixed, a single line change will be enough to make it default.
a version "0" was sent back on 2017.
v1:
- rebased version of ABI scripts requested during KS/2019 discussions,
with some additional changes for it to parse newer ABI files;
v2:
- Some additional fixes and improvements to get_abi.pl script;
- get_abi.pl script now optionally suports parsing ABI files with
uses ReST format (by default, this is disabled);
- Added scripts/get_feat.pl to parse Documentation/features;
- Added SPDX headers.
Mauro Carvalho Chehab (22):
ABI: sysfs-bus-pci-devices-aer_stats uses an invalid tag
ABI: Fix KernelVersion tags
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 scripts/get_abi.pl: avoid creating duplicate names scripts/get_abi.pl: add a handler for invalid "where" tag scripts/get_abi.pl: add a validate command
doc-rst: add ABI documentation to the admin-guide book
docs: sphinx/kernel_abi.py: fix UTF-8 support sphinx/kernel_abi.py: make it compatible with Sphinx 1.7+
docs: Kconfig/Makefile: add a check for broken ABI files
docs: kernel_abi.py: Update copyrights
doc: ABI scripts: add a SPDX header file
scripts: add a script to handle Documentation/features
docs: admin-guide, x86: add a features list scripts/get_feat.pl: handle ".." special case scripts/get_abi.pl: change script to allow parsing in ReST mode
Documentation/ABI/testing/pstore | 2 +- .../sysfs-bus-event_source-devices-format | 2 +- .../ABI/testing/sysfs-bus-i2c-devices-hm6352 | 6 +- .../testing/sysfs-bus-pci-devices-aer_stats | 24 +- .../ABI/testing/sysfs-bus-pci-devices-cciss | 22 +- .../testing/sysfs-bus-usb-devices-usbsevseg | 10 +- .../ABI/testing/sysfs-driver-altera-cvp | 2 +- Documentation/ABI/testing/sysfs-driver-ppi | 2 +- Documentation/ABI/testing/sysfs-driver-st | 2 +- Documentation/ABI/testing/sysfs-driver-wacom | 2 +- Documentation/Kconfig | 11 + Documentation/Makefile | 5 + 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/features.rst | 3 + Documentation/admin-guide/index.rst | 2 + Documentation/conf.py | 2 +- Documentation/sphinx/kernel_abi.py | 166 ++++++ Documentation/sphinx/kernel_feat.py | 169 ++++++ Documentation/x86/features.rst | 3 + Documentation/x86/index.rst | 1 + lib/Kconfig.debug | 2 + scripts/get_abi.pl | 498 ++++++++++++++++++ scripts/get_feat.pl | 474 +++++++++++++++++ 27 files changed, 1429 insertions(+), 38 deletions(-) create mode 100644 Documentation/Kconfig 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/admin-guide/features.rst create mode 100644 Documentation/sphinx/kernel_abi.py create mode 100644 Documentation/sphinx/kernel_feat.py create mode 100644 Documentation/x86/features.rst create mode 100755 scripts/get_abi.pl create mode 100755 scripts/get_feat.pl
Signature · 1 line
2.21.0