* Re: [PATCH v2 08/39] scripts: get_abi.pl: prevent duplicated file names
@ 2020-12-08 13:35 Nícolas F. R. A. Prado
0 siblings, 0 replies; 2+ messages in thread
From: Nícolas F. R. A. Prado @ 2020-12-08 13:35 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Linux Doc Mailing List, Jonathan Corbet, Jonathan Cameron,
Oded Gabbay, Tom Rix, Vaibhav Jain, linux-kernel
On Fri, Oct 30, 2020 at 08:40:27AM +0100, Mauro Carvalho Chehab wrote:
> The same filename may exist on multiple directories within
> ABI. Create separate entries at the internal database for
> each of them.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
> scripts/get_abi.pl | 15 ++++++++++-----
> 1 file changed, 10 insertions(+), 5 deletions(-)
>
> diff --git a/scripts/get_abi.pl b/scripts/get_abi.pl
> index e5a5588a8639..5612f019fae0 100755
> --- a/scripts/get_abi.pl
> +++ b/scripts/get_abi.pl
> @@ -65,7 +65,10 @@ sub parse_abi {
> my $name = $file;
> $name =~ s,.*/,,;
>
> - my $nametag = "File $name";
> + my $fn = $file;
> + $fn =~ s,Documentation/ABI/,,;
> +
> + my $nametag = "File $fn";
> $data{$nametag}->{what} = "File $name";
> $data{$nametag}->{type} = "File";
> $data{$nametag}->{file} = $name;
> @@ -320,16 +323,18 @@ sub output_rest {
> my $fileref = "abi_file_".$path;
>
> if ($type eq "File") {
> - my $bar = $w;
> - $bar =~ s/./-/g;
> -
> print ".. _$fileref:\n\n";
> - print "$w\n$bar\n\n";
> } else {
> print "Defined on file :ref:`$f <$fileref>`\n\n";
> }
> }
>
> + if ($type eq "File") {
> + my $bar = $w;
> + $bar =~ s/./-/g;
> + print "$w\n$bar\n\n";
> + }
> +
> my $desc = "";
> $desc = $data{$what}->{description} if (defined($data{$what}->{description}));
> $desc =~ s/\s+$/\n/;
> --
> 2.26.2
>
Hey Mauro,
just a heads-up.
It seems the ABI page is showing the full file names as shown in [1], like "File
/srv/docbuild/lib/git/linux/stable/firewire-cdev", while only the file name
would be enough, like "File firewire-cdev".
By reverting this patch I got exactly the intended behavior, but it seems you
were fixing other things with this, so perhaps just reverting is breaking
something that I can't see.
Could you look into what would be the right fix for this? :)
Thanks,
Nícolas
[1] https://www.kernel.org/doc/html/latest/admin-guide/abi.html
^ permalink raw reply [flat|nested] 2+ messages in thread* [PATCH v2 00/39] ABI: add it to the documentation build system
@ 2020-10-30 7:40 Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 08/39] scripts: get_abi.pl: prevent duplicated file names Mauro Carvalho Chehab
0 siblings, 1 reply; 2+ messages in thread
From: Mauro Carvalho Chehab @ 2020-10-30 7:40 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet,
Alexandre Torgue, Andreas Klinger, Andrew Lunn, Anton Vorontsov,
Baolin Wang, Bartosz Golaszewski, Benson Leung, Bjorn Andersson,
Boris Brezillon, Chao Yu, Chunyan Zhang, Colin Cross,
Daniel Thompson, Enric Balletbo i Serra, Fabrice Gasnier,
Heikki Krogerus, Heiner Kallweit, Jaegeuk Kim, Jingoo Han,
Johan Hovold, Johannes Berg, Kees Cook, Lee Jones, Linus Walleij,
Mathieu Poirier, Maxime Coquelin, Mike Kravetz, Ohad Ben-Cohen,
Orson Zhai, Peter Rosin, Richard Cochran, Richard Gong,
Sebastian Reichel, Srinivas Kandagatla, Stefan Achatz, Tony Luck,
Wu Hao
Hi Greg,
That's the second version of the ABI documentation patches,
adding support for having the Linux ABI documentted inside
the Linux admin manual.
When compared with the version I sent years ago, this
version has:
- a logic to detect duplicated ABI symbols;
- it auto-generate cross-reference markups for ABI symbols,
ABI files and .rst files;
- Other files from 5.10-rc1 required adjustments in order
to be accepted by the script in rst-source mode;
- Some bug fixes.
v2:
- fixed pedantic warnings with "search command;
- fixed the duplicated warning output in order to report properly the files;
- added a few more patches addressing ABI duplication.
Mauro Carvalho Chehab (39):
scripts: get_abi.pl: change script to allow parsing in ReST mode
scripts: get_abi.pl: fix parsing on ReST mode
scripts: get_abi.pl: Allow optionally record from where a line came
from
scripts: get_abi.pl: improve its parser to better catch up indentation
scripts: get_abi.pl: cleanup ABI cross-reference logic
scripts: get_abi.pl: detect duplicated ABI definitions
scripts: get_abi.pl: output users in ReST format
scripts: get_abi.pl: prevent duplicated file names
scripts: get_abi.pl: use bold font for ABI definitions
scripts: get_abi.pl: auto-generate cross references
docs: kernellog.py: add support for info()
docs: kernel_abi.py: add a script to parse ABI documentation
docs: kernel_abi.py: fix UTF-8 support
docs: kernel_abi.py: make it compatible with Sphinx 1.7+
docs: kernel_abi.py: use --enable-lineno for get_abi.pl
docs: kernel_abi.py: Handle with a lazy Sphinx parser
docs: add ABI documentation to the admin-guide book
docs: ABI: README: specify that files should be ReST compatible
docs: ABI: stable: make files ReST compatible
docs: ABI: testing: make the files compatible with ReST output
docs: ABI: sysfs-uevent: make it compatible with ReST output
docs: ABI: make it parse ABI/stable as ReST-compatible files
docs: ABI: create a 2-depth index for ABI
docs: ABI: don't escape ReST-incompatible chars from obsolete and
removed
docs: abi-testing.rst: enable --rst-sources when building docs
docs: Kconfig/Makefile: add a check for broken ABI files
docs: ABI: convert testing/configfs-acpi to ReST
docs: ABI: fix syntax to be parsed using ReST notation
docs: ABI: vdso: use the right format for ABI
docs: ABI: sysfs-bus-nvdimm: use the right format for ABI
docs: ABI: cleanup several ABI documents
docs: ABI: change read/write attributes
docs: ABI: stable: remove a duplicated documentation
docs: ABI: unify /sys/class/leds/<led>/brightness documentation
docs: ABI: sysfs-class-power: unify duplicated properties
docs: ABI: sysfs-c2port: remove a duplicated entry
docs: ABI: sysfs-class-backlight: unify ABI documentation
docs: ABI: sysfs-class-led-trigger-pattern: remove hw_pattern
duplication
scripts: get_abi.pl: assume ReST format by default
Documentation/ABI/README | 10 +-
Documentation/ABI/obsolete/sysfs-class-dax | 8 +-
.../ABI/obsolete/sysfs-driver-hid-roccat-pyra | 3 +
Documentation/ABI/obsolete/sysfs-gpio | 2 +
Documentation/ABI/removed/devfs | 1 +
Documentation/ABI/removed/raw1394 | 1 +
Documentation/ABI/removed/sysfs-class-rfkill | 2 +-
Documentation/ABI/removed/video1394 | 1 +
Documentation/ABI/stable/firewire-cdev | 67 ++-
Documentation/ABI/stable/sysfs-acpi-pmprofile | 26 +-
Documentation/ABI/stable/sysfs-bus-firewire | 3 +
Documentation/ABI/stable/sysfs-bus-nvmem | 19 +-
Documentation/ABI/stable/sysfs-bus-usb | 6 +-
Documentation/ABI/stable/sysfs-bus-vmbus | 7 -
Documentation/ABI/stable/sysfs-bus-w1 | 1 +
.../ABI/stable/sysfs-class-backlight | 1 +
.../ABI/stable/sysfs-class-infiniband | 93 +++-
Documentation/ABI/stable/sysfs-class-rfkill | 13 +-
Documentation/ABI/stable/sysfs-class-tpm | 94 ++--
Documentation/ABI/stable/sysfs-devices | 5 +-
.../ABI/stable/sysfs-driver-firmware-zynqmp | 62 ++-
Documentation/ABI/stable/sysfs-driver-ib_srp | 1 +
Documentation/ABI/stable/sysfs-driver-speakup | 4 +
.../ABI/stable/sysfs-firmware-efi-vars | 4 +
.../ABI/stable/sysfs-firmware-opal-dump | 5 +
.../ABI/stable/sysfs-firmware-opal-elog | 2 +
Documentation/ABI/stable/sysfs-hypervisor-xen | 3 +
Documentation/ABI/stable/vdso | 11 +-
Documentation/ABI/testing/configfs-acpi | 34 +-
Documentation/ABI/testing/configfs-most | 135 +++--
.../ABI/testing/configfs-spear-pcie-gadget | 36 +-
Documentation/ABI/testing/configfs-usb-gadget | 83 +--
.../ABI/testing/configfs-usb-gadget-ecm | 12 +-
.../ABI/testing/configfs-usb-gadget-eem | 10 +-
.../ABI/testing/configfs-usb-gadget-hid | 10 +-
.../ABI/testing/configfs-usb-gadget-loopback | 6 +-
.../testing/configfs-usb-gadget-mass-storage | 18 +-
.../ABI/testing/configfs-usb-gadget-midi | 14 +-
.../ABI/testing/configfs-usb-gadget-printer | 6 +-
.../ABI/testing/configfs-usb-gadget-rndis | 16 +-
.../testing/configfs-usb-gadget-sourcesink | 18 +-
.../ABI/testing/configfs-usb-gadget-subset | 10 +-
.../ABI/testing/configfs-usb-gadget-uac1 | 18 +-
.../ABI/testing/configfs-usb-gadget-uac2 | 14 +-
.../ABI/testing/configfs-usb-gadget-uvc | 220 ++++----
.../ABI/testing/debugfs-cec-error-inj | 2 +-
.../ABI/testing/debugfs-driver-habanalabs | 12 +-
Documentation/ABI/testing/debugfs-ec | 11 +-
Documentation/ABI/testing/debugfs-moxtet | 30 +-
.../ABI/testing/debugfs-pfo-nx-crypto | 28 +-
Documentation/ABI/testing/debugfs-pktcdvd | 13 +-
.../ABI/testing/debugfs-turris-mox-rwtm | 15 +-
Documentation/ABI/testing/debugfs-wilco-ec | 21 +-
Documentation/ABI/testing/dell-smbios-wmi | 32 +-
Documentation/ABI/testing/dev-kmsg | 27 +-
Documentation/ABI/testing/evm | 17 +-
Documentation/ABI/testing/gpio-cdev | 13 +-
Documentation/ABI/testing/ima_policy | 30 +-
Documentation/ABI/testing/procfs-diskstats | 46 +-
Documentation/ABI/testing/procfs-smaps_rollup | 48 +-
Documentation/ABI/testing/pstore | 19 +-
Documentation/ABI/testing/sysfs-block | 38 +-
Documentation/ABI/testing/sysfs-block-device | 2 +
Documentation/ABI/testing/sysfs-block-rnbd | 4 +-
Documentation/ABI/testing/sysfs-bus-acpi | 19 +-
.../testing/sysfs-bus-coresight-devices-cti | 60 +-
.../testing/sysfs-bus-coresight-devices-etb10 | 21 +-
.../testing/sysfs-bus-coresight-devices-etm3x | 10 +-
.../testing/sysfs-bus-coresight-devices-etm4x | 76 +--
.../testing/sysfs-bus-coresight-devices-stm | 2 +-
.../testing/sysfs-bus-coresight-devices-tmc | 20 +-
Documentation/ABI/testing/sysfs-bus-css | 3 +
Documentation/ABI/testing/sysfs-bus-dfl | 2 +
.../sysfs-bus-event_source-devices-dfl_fme | 14 +-
.../sysfs-bus-event_source-devices-format | 3 +-
.../sysfs-bus-event_source-devices-hv_24x7 | 6 +-
.../sysfs-bus-event_source-devices-hv_gpci | 7 +-
Documentation/ABI/testing/sysfs-bus-fcoe | 68 ++-
Documentation/ABI/testing/sysfs-bus-fsl-mc | 12 +-
.../ABI/testing/sysfs-bus-i2c-devices-fsa9480 | 26 +-
.../ABI/testing/sysfs-bus-i2c-devices-pca954x | 27 +-
Documentation/ABI/testing/sysfs-bus-i3c | 2 +
Documentation/ABI/testing/sysfs-bus-iio | 30 +-
.../sysfs-bus-iio-adc-envelope-detector | 5 +-
.../ABI/testing/sysfs-bus-iio-adc-hi8435 | 5 +
.../ABI/testing/sysfs-bus-iio-adc-stm32 | 3 +
.../ABI/testing/sysfs-bus-iio-cros-ec | 2 +-
.../ABI/testing/sysfs-bus-iio-dfsdm-adc-stm32 | 8 +-
.../ABI/testing/sysfs-bus-iio-distance-srf08 | 7 +-
.../testing/sysfs-bus-iio-frequency-ad9523 | 2 +
.../testing/sysfs-bus-iio-frequency-adf4371 | 10 +-
.../ABI/testing/sysfs-bus-iio-health-afe440x | 12 +-
.../ABI/testing/sysfs-bus-iio-light-isl29018 | 6 +-
.../ABI/testing/sysfs-bus-iio-lptimer-stm32 | 29 +-
.../sysfs-bus-iio-magnetometer-hmc5843 | 19 +-
.../sysfs-bus-iio-temperature-max31856 | 19 +-
.../ABI/testing/sysfs-bus-iio-timer-stm32 | 137 +++--
.../testing/sysfs-bus-intel_th-devices-gth | 11 +-
.../testing/sysfs-bus-intel_th-devices-msc | 4 +
Documentation/ABI/testing/sysfs-bus-most | 6 +-
.../ABI/testing/sysfs-bus-moxtet-devices | 6 +-
Documentation/ABI/testing/sysfs-bus-nfit | 2 +-
Documentation/ABI/testing/sysfs-bus-nvdimm | 6 +
Documentation/ABI/testing/sysfs-bus-papr-pmem | 23 +-
Documentation/ABI/testing/sysfs-bus-pci | 22 +-
.../testing/sysfs-bus-pci-devices-aer_stats | 119 ++--
.../ABI/testing/sysfs-bus-pci-devices-catpt | 1 +
.../testing/sysfs-bus-pci-drivers-ehci_hcd | 4 +-
Documentation/ABI/testing/sysfs-bus-rapidio | 23 +-
Documentation/ABI/testing/sysfs-bus-rbd | 37 +-
Documentation/ABI/testing/sysfs-bus-siox | 3 +
.../ABI/testing/sysfs-bus-thunderbolt | 58 +-
Documentation/ABI/testing/sysfs-bus-usb | 32 +-
.../testing/sysfs-bus-usb-devices-usbsevseg | 7 +-
Documentation/ABI/testing/sysfs-bus-vfio-mdev | 10 +-
Documentation/ABI/testing/sysfs-c2port | 7 -
.../ABI/testing/sysfs-class-backlight | 60 ++
.../ABI/testing/sysfs-class-backlight-adp8860 | 21 +-
.../sysfs-class-backlight-driver-adp8870 | 30 +-
.../sysfs-class-backlight-driver-lm3533 | 26 +-
Documentation/ABI/testing/sysfs-class-bdi | 1 -
.../ABI/testing/sysfs-class-chromeos | 15 +-
Documentation/ABI/testing/sysfs-class-cxl | 23 +-
Documentation/ABI/testing/sysfs-class-devfreq | 6 +-
Documentation/ABI/testing/sysfs-class-devlink | 30 +-
Documentation/ABI/testing/sysfs-class-extcon | 34 +-
.../ABI/testing/sysfs-class-fpga-manager | 5 +-
Documentation/ABI/testing/sysfs-class-gnss | 2 +
Documentation/ABI/testing/sysfs-class-led | 28 +-
.../testing/sysfs-class-led-driver-el15203000 | 130 -----
.../ABI/testing/sysfs-class-led-driver-lm3533 | 44 +-
.../ABI/testing/sysfs-class-led-driver-sc27xx | 22 -
.../ABI/testing/sysfs-class-led-flash | 27 +-
.../ABI/testing/sysfs-class-led-multicolor | 23 +-
.../testing/sysfs-class-led-trigger-netdev | 7 +
.../testing/sysfs-class-led-trigger-pattern | 4 +-
.../testing/sysfs-class-led-trigger-usbport | 1 +
.../ABI/testing/sysfs-class-leds-gt683r | 8 +-
Documentation/ABI/testing/sysfs-class-mic | 52 +-
Documentation/ABI/testing/sysfs-class-net | 61 +-
.../ABI/testing/sysfs-class-net-cdc_ncm | 6 +-
.../ABI/testing/sysfs-class-net-phydev | 2 +
Documentation/ABI/testing/sysfs-class-ocxl | 17 +-
Documentation/ABI/testing/sysfs-class-pktcdvd | 36 +-
Documentation/ABI/testing/sysfs-class-power | 525 +++++++++---------
.../ABI/testing/sysfs-class-power-mp2629 | 1 +
.../ABI/testing/sysfs-class-power-twl4030 | 33 +-
.../ABI/testing/sysfs-class-power-wilco | 18 +-
Documentation/ABI/testing/sysfs-class-rapidio | 46 +-
Documentation/ABI/testing/sysfs-class-rc | 30 +-
.../ABI/testing/sysfs-class-regulator | 36 +-
.../ABI/testing/sysfs-class-remoteproc | 14 +-
.../ABI/testing/sysfs-class-rnbd-client | 93 ++--
...ysfs-class-rtc-rtc0-device-rtc_calibration | 1 +
.../ABI/testing/sysfs-class-rtrs-client | 23 +-
.../ABI/testing/sysfs-class-scsi_host | 7 +-
Documentation/ABI/testing/sysfs-class-typec | 12 +-
Documentation/ABI/testing/sysfs-class-uwb_rc | 13 +-
.../ABI/testing/sysfs-class-watchdog | 7 +-
Documentation/ABI/testing/sysfs-dev | 7 +-
.../ABI/testing/sysfs-devices-mapping | 41 +-
.../ABI/testing/sysfs-devices-memory | 15 +-
.../testing/sysfs-devices-platform-ACPI-TAD | 4 +
.../sysfs-devices-platform-_UDC_-gadget | 10 +-
.../ABI/testing/sysfs-devices-platform-docg3 | 10 +-
.../ABI/testing/sysfs-devices-platform-ipmi | 52 +-
.../sysfs-devices-platform-sh_mobile_lcdc_fb | 8 +-
.../sysfs-devices-platform-stratix10-rsu | 10 +
.../ABI/testing/sysfs-devices-system-cpu | 101 ++--
.../ABI/testing/sysfs-devices-system-ibm-rtl | 6 +-
.../testing/sysfs-driver-bd9571mwv-regulator | 4 +
Documentation/ABI/testing/sysfs-driver-genwqe | 11 +-
.../ABI/testing/sysfs-driver-hid-lenovo | 10 +
.../testing/sysfs-driver-hid-logitech-lg4ff | 18 +-
.../ABI/testing/sysfs-driver-hid-ntrig | 13 +-
.../ABI/testing/sysfs-driver-hid-roccat-kone | 19 +
.../ABI/testing/sysfs-driver-hid-wiimote | 12 +-
.../ABI/testing/sysfs-driver-input-exc3000 | 2 +
.../ABI/testing/sysfs-driver-jz4780-efuse | 6 +-
.../ABI/testing/sysfs-driver-pciback | 6 +-
.../ABI/testing/sysfs-driver-samsung-laptop | 13 +-
.../ABI/testing/sysfs-driver-toshiba_acpi | 26 +
.../ABI/testing/sysfs-driver-toshiba_haps | 2 +
Documentation/ABI/testing/sysfs-driver-ufs | 228 ++++++--
.../ABI/testing/sysfs-driver-w1_ds28e17 | 3 +
.../ABI/testing/sysfs-driver-w1_therm | 75 ++-
Documentation/ABI/testing/sysfs-driver-wacom | 4 +-
Documentation/ABI/testing/sysfs-firmware-acpi | 237 ++++----
.../ABI/testing/sysfs-firmware-dmi-entries | 50 +-
.../ABI/testing/sysfs-firmware-efi-esrt | 28 +-
.../testing/sysfs-firmware-efi-runtime-map | 14 +-
Documentation/ABI/testing/sysfs-firmware-gsmi | 2 +-
.../ABI/testing/sysfs-firmware-memmap | 16 +-
.../ABI/testing/sysfs-firmware-qemu_fw_cfg | 20 +-
Documentation/ABI/testing/sysfs-firmware-sfi | 6 +-
.../ABI/testing/sysfs-firmware-sgi_uv | 6 +-
.../testing/sysfs-firmware-turris-mox-rwtm | 10 +-
Documentation/ABI/testing/sysfs-fs-ext4 | 4 +-
Documentation/ABI/testing/sysfs-fs-f2fs | 48 +-
.../ABI/testing/sysfs-hypervisor-xen | 13 +-
.../ABI/testing/sysfs-kernel-boot_params | 23 +-
.../ABI/testing/sysfs-kernel-mm-hugepages | 12 +-
Documentation/ABI/testing/sysfs-kernel-mm-ksm | 5 +-
Documentation/ABI/testing/sysfs-kernel-slab | 3 +
Documentation/ABI/testing/sysfs-module | 17 +-
.../ABI/testing/sysfs-platform-asus-laptop | 21 +-
.../ABI/testing/sysfs-platform-asus-wmi | 1 +
Documentation/ABI/testing/sysfs-platform-at91 | 10 +-
.../ABI/testing/sysfs-platform-dell-laptop | 10 +-
.../ABI/testing/sysfs-platform-dell-smbios | 4 +-
.../ABI/testing/sysfs-platform-dfl-fme | 14 +-
Documentation/ABI/testing/sysfs-platform-dptf | 11 +-
.../ABI/testing/sysfs-platform-eeepc-laptop | 14 +-
.../testing/sysfs-platform-i2c-demux-pinctrl | 4 +-
.../ABI/testing/sysfs-platform-ideapad-laptop | 9 +-
.../sysfs-platform-intel-wmi-sbl-fw-update | 1 +
.../sysfs-platform-intel-wmi-thunderbolt | 1 +
Documentation/ABI/testing/sysfs-platform-kim | 1 +
.../testing/sysfs-platform-mellanox-bootctl | 50 +-
.../testing/sysfs-platform-phy-rcar-gen3-usb2 | 10 +-
.../ABI/testing/sysfs-platform-renesas_usb3 | 10 +-
.../ABI/testing/sysfs-platform-sst-atom | 13 +-
.../ABI/testing/sysfs-platform-usbip-vudc | 11 +-
.../ABI/testing/sysfs-platform-wilco-ec | 1 +
Documentation/ABI/testing/sysfs-power | 21 +-
Documentation/ABI/testing/sysfs-profiling | 2 +-
Documentation/ABI/testing/sysfs-ptp | 2 +-
Documentation/ABI/testing/sysfs-uevent | 28 +-
Documentation/ABI/testing/sysfs-wusb_cbaf | 3 +-
Documentation/ABI/testing/usb-charger-uevent | 82 +--
Documentation/ABI/testing/usb-uevent | 32 +-
Documentation/Kconfig | 10 +
Documentation/Makefile | 5 +
Documentation/admin-guide/abi-obsolete.rst | 11 +
Documentation/admin-guide/abi-removed.rst | 5 +
Documentation/admin-guide/abi-stable.rst | 14 +
Documentation/admin-guide/abi-testing.rst | 20 +
Documentation/admin-guide/abi.rst | 11 +
Documentation/admin-guide/index.rst | 2 +
Documentation/conf.py | 3 +-
Documentation/leds/index.rst | 1 +
Documentation/leds/leds-el15203000.rst | 140 +++++
Documentation/leds/leds-sc27xx.rst | 27 +
Documentation/sphinx/kernel_abi.py | 194 +++++++
Documentation/sphinx/kernellog.py | 6 +-
lib/Kconfig.debug | 2 +
scripts/get_abi.pl | 367 ++++++++----
247 files changed, 4107 insertions(+), 2463 deletions(-)
delete mode 100644 Documentation/ABI/testing/sysfs-class-led-driver-sc27xx
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/leds/leds-el15203000.rst
create mode 100644 Documentation/leds/leds-sc27xx.rst
create mode 100644 Documentation/sphinx/kernel_abi.py
--
2.26.2
^ permalink raw reply [flat|nested] 2+ messages in thread* [PATCH v2 08/39] scripts: get_abi.pl: prevent duplicated file names
2020-10-30 7:40 [PATCH v2 00/39] ABI: add it to the documentation build system Mauro Carvalho Chehab
@ 2020-10-30 7:40 ` Mauro Carvalho Chehab
0 siblings, 0 replies; 2+ messages in thread
From: Mauro Carvalho Chehab @ 2020-10-30 7:40 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, Jonathan Corbet, Jonathan Cameron,
Oded Gabbay, Tom Rix, Vaibhav Jain, linux-kernel
The same filename may exist on multiple directories within
ABI. Create separate entries at the internal database for
each of them.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
scripts/get_abi.pl | 15 ++++++++++-----
1 file changed, 10 insertions(+), 5 deletions(-)
diff --git a/scripts/get_abi.pl b/scripts/get_abi.pl
index e5a5588a8639..5612f019fae0 100755
--- a/scripts/get_abi.pl
+++ b/scripts/get_abi.pl
@@ -65,7 +65,10 @@ sub parse_abi {
my $name = $file;
$name =~ s,.*/,,;
- my $nametag = "File $name";
+ my $fn = $file;
+ $fn =~ s,Documentation/ABI/,,;
+
+ my $nametag = "File $fn";
$data{$nametag}->{what} = "File $name";
$data{$nametag}->{type} = "File";
$data{$nametag}->{file} = $name;
@@ -320,16 +323,18 @@ sub output_rest {
my $fileref = "abi_file_".$path;
if ($type eq "File") {
- my $bar = $w;
- $bar =~ s/./-/g;
-
print ".. _$fileref:\n\n";
- print "$w\n$bar\n\n";
} else {
print "Defined on file :ref:`$f <$fileref>`\n\n";
}
}
+ if ($type eq "File") {
+ my $bar = $w;
+ $bar =~ s/./-/g;
+ print "$w\n$bar\n\n";
+ }
+
my $desc = "";
$desc = $data{$what}->{description} if (defined($data{$what}->{description}));
$desc =~ s/\s+$/\n/;
--
2.26.2
^ permalink raw reply related [flat|nested] 2+ messages in thread
end of thread, other threads:[~2020-12-08 13:36 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2020-12-08 13:35 [PATCH v2 08/39] scripts: get_abi.pl: prevent duplicated file names Nícolas F. R. A. Prado
-- strict thread matches above, loose matches on Subject: below --
2020-10-30 7:40 [PATCH v2 00/39] ABI: add it to the documentation build system Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 08/39] scripts: get_abi.pl: prevent duplicated file names Mauro Carvalho Chehab
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox