Driver core documentation fixes for 5.10-rc3

Here are some small Documentation fixes for 5.10-rc3 that were fallout
 from the larger documentation update we did in 5.10-rc2.  Nothing major
 here at all, but all of these have been in linux-next and resolve build
 warnings when building the documentation files.
 
 Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
 -----BEGIN PGP SIGNATURE-----
 
 iG0EABECAC0WIQT0tgzFv3jCIUoxPcsxR9QN2y37KQUCX6g8vw8cZ3JlZ0Brcm9h
 aC5jb20ACgkQMUfUDdst+ykdGQCgjEHwT/N2jltd8yHF1Kca5yR+FJYAoMb3sbJS
 gR1iX48G20OhkrPNSIUw
 =HDyQ
 -----END PGP SIGNATURE-----

Merge tag 'driver-core-5.10-rc3' of git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/driver-core

Pull driver core documentation fixes from Greg KH:
 "Some small Documentation fixes that were fallout from the larger
  documentation update we did in 5.10-rc2.

  Nothing major here at all, but all of these have been in linux-next
  and resolve build warnings when building the documentation files"

* tag 'driver-core-5.10-rc3' of git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/driver-core:
  Documentation: remove mic/index from misc-devices/index.rst
  scripts: get_api.pl: Add sub-titles to ABI output
  scripts: get_abi.pl: Don't let ABI files to create subtitles
  docs: leds: index.rst: add a missing file
  docs: ABI: sysfs-class-net: fix a typo
  docs: ABI: sysfs-driver-dma-ioatdma: what starts with /sys
This commit is contained in:
Linus Torvalds 2020-11-08 11:30:25 -08:00
Родитель bbc821849e d181bfe367
Коммит 15f5d201c1
5 изменённых файлов: 30 добавлений и 7 удалений

Просмотреть файл

@ -1,29 +1,29 @@
What: sys/devices/pciXXXX:XX/0000:XX:XX.X/dma/dma<n>chan<n>/quickdata/cap What: /sys/devices/pciXXXX:XX/0000:XX:XX.X/dma/dma<n>chan<n>/quickdata/cap
Date: December 3, 2009 Date: December 3, 2009
KernelVersion: 2.6.32 KernelVersion: 2.6.32
Contact: dmaengine@vger.kernel.org Contact: dmaengine@vger.kernel.org
Description: Capabilities the DMA supports.Currently there are DMA_PQ, DMA_PQ_VAL, Description: Capabilities the DMA supports.Currently there are DMA_PQ, DMA_PQ_VAL,
DMA_XOR,DMA_XOR_VAL,DMA_INTERRUPT. DMA_XOR,DMA_XOR_VAL,DMA_INTERRUPT.
What: sys/devices/pciXXXX:XX/0000:XX:XX.X/dma/dma<n>chan<n>/quickdata/ring_active What: /sys/devices/pciXXXX:XX/0000:XX:XX.X/dma/dma<n>chan<n>/quickdata/ring_active
Date: December 3, 2009 Date: December 3, 2009
KernelVersion: 2.6.32 KernelVersion: 2.6.32
Contact: dmaengine@vger.kernel.org Contact: dmaengine@vger.kernel.org
Description: The number of descriptors active in the ring. Description: The number of descriptors active in the ring.
What: sys/devices/pciXXXX:XX/0000:XX:XX.X/dma/dma<n>chan<n>/quickdata/ring_size What: /sys/devices/pciXXXX:XX/0000:XX:XX.X/dma/dma<n>chan<n>/quickdata/ring_size
Date: December 3, 2009 Date: December 3, 2009
KernelVersion: 2.6.32 KernelVersion: 2.6.32
Contact: dmaengine@vger.kernel.org Contact: dmaengine@vger.kernel.org
Description: Descriptor ring size, total number of descriptors available. Description: Descriptor ring size, total number of descriptors available.
What: sys/devices/pciXXXX:XX/0000:XX:XX.X/dma/dma<n>chan<n>/quickdata/version What: /sys/devices/pciXXXX:XX/0000:XX:XX.X/dma/dma<n>chan<n>/quickdata/version
Date: December 3, 2009 Date: December 3, 2009
KernelVersion: 2.6.32 KernelVersion: 2.6.32
Contact: dmaengine@vger.kernel.org Contact: dmaengine@vger.kernel.org
Description: Version of ioatdma device. Description: Version of ioatdma device.
What: sys/devices/pciXXXX:XX/0000:XX:XX.X/dma/dma<n>chan<n>/quickdata/intr_coalesce What: /sys/devices/pciXXXX:XX/0000:XX:XX.X/dma/dma<n>chan<n>/quickdata/intr_coalesce
Date: August 8, 2017 Date: August 8, 2017
KernelVersion: 4.14 KernelVersion: 4.14
Contact: dmaengine@vger.kernel.org Contact: dmaengine@vger.kernel.org

Просмотреть файл

@ -152,7 +152,7 @@ Description:
When an interface is under test, it cannot be expected When an interface is under test, it cannot be expected
to pass packets as normal. to pass packets as normal.
What: /sys/clas/net/<iface>/duplex What: /sys/class/net/<iface>/duplex
Date: October 2009 Date: October 2009
KernelVersion: 2.6.33 KernelVersion: 2.6.33
Contact: netdev@vger.kernel.org Contact: netdev@vger.kernel.org

Просмотреть файл

@ -25,3 +25,4 @@ LEDs
leds-lp5562 leds-lp5562
leds-lp55xx leds-lp55xx
leds-mlxcpld leds-mlxcpld
leds-sc27xx

Просмотреть файл

@ -24,7 +24,6 @@ fit into other categories.
isl29003 isl29003
lis3lv02d lis3lv02d
max6875 max6875
mic/index
pci-endpoint-test pci-endpoint-test
spear-pcie-gadget spear-pcie-gadget
uacce uacce

Просмотреть файл

@ -287,6 +287,8 @@ my $bondary = qr { (?<![\w\/\`\{])(?=[\w\/\`\{])|(?<=[\w\/\`\{])(?![\w\/\`\{]) }
sub output_rest { sub output_rest {
create_labels(); create_labels();
my $part = "";
foreach my $what (sort { foreach my $what (sort {
($data{$a}->{type} eq "File") cmp ($data{$b}->{type} eq "File") || ($data{$a}->{type} eq "File") cmp ($data{$b}->{type} eq "File") ||
$a cmp $b $a cmp $b
@ -306,6 +308,21 @@ sub output_rest {
$w =~ s/([\(\)\_\-\*\=\^\~\\])/\\$1/g; $w =~ s/([\(\)\_\-\*\=\^\~\\])/\\$1/g;
if ($type ne "File") { if ($type ne "File") {
my $cur_part = $what;
if ($what =~ '/') {
if ($what =~ m#^(\/?(?:[\w\-]+\/?){1,2})#) {
$cur_part = "Symbols under $1";
$cur_part =~ s,/$,,;
}
}
if ($cur_part ne "" && $part ne $cur_part) {
$part = $cur_part;
my $bar = $part;
$bar =~ s/./-/g;
print "$part\n$bar\n\n";
}
printf ".. _%s:\n\n", $data{$what}->{label}; printf ".. _%s:\n\n", $data{$what}->{label};
my @names = split /, /,$w; my @names = split /, /,$w;
@ -352,6 +369,12 @@ sub output_rest {
if (!($desc =~ /^\s*$/)) { if (!($desc =~ /^\s*$/)) {
if ($description_is_rst) { if ($description_is_rst) {
# Remove title markups from the description
# Having titles inside ABI files will only work if extra
# care would be taken in order to strictly follow the same
# level order for each markup.
$desc =~ s/\n[\-\*\=\^\~]+\n/\n\n/g;
# Enrich text by creating cross-references # Enrich text by creating cross-references
$desc =~ s,Documentation/(?!devicetree)(\S+)\.rst,:doc:`/$1`,g; $desc =~ s,Documentation/(?!devicetree)(\S+)\.rst,:doc:`/$1`,g;