Skip to content

Commit 15f5d20

Browse files
committed
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
2 parents bbc8218 + d181bfe commit 15f5d20

File tree

5 files changed

+30
-7
lines changed

5 files changed

+30
-7
lines changed

Documentation/ABI/stable/sysfs-driver-dma-ioatdma

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
1-
What: sys/devices/pciXXXX:XX/0000:XX:XX.X/dma/dma<n>chan<n>/quickdata/cap
1+
What: /sys/devices/pciXXXX:XX/0000:XX:XX.X/dma/dma<n>chan<n>/quickdata/cap
22
Date: December 3, 2009
33
KernelVersion: 2.6.32
44
55
Description: Capabilities the DMA supports.Currently there are DMA_PQ, DMA_PQ_VAL,
66
DMA_XOR,DMA_XOR_VAL,DMA_INTERRUPT.
77

8-
What: sys/devices/pciXXXX:XX/0000:XX:XX.X/dma/dma<n>chan<n>/quickdata/ring_active
8+
What: /sys/devices/pciXXXX:XX/0000:XX:XX.X/dma/dma<n>chan<n>/quickdata/ring_active
99
Date: December 3, 2009
1010
KernelVersion: 2.6.32
1111
1212
Description: The number of descriptors active in the ring.
1313

14-
What: sys/devices/pciXXXX:XX/0000:XX:XX.X/dma/dma<n>chan<n>/quickdata/ring_size
14+
What: /sys/devices/pciXXXX:XX/0000:XX:XX.X/dma/dma<n>chan<n>/quickdata/ring_size
1515
Date: December 3, 2009
1616
KernelVersion: 2.6.32
1717
1818
Description: Descriptor ring size, total number of descriptors available.
1919

20-
What: sys/devices/pciXXXX:XX/0000:XX:XX.X/dma/dma<n>chan<n>/quickdata/version
20+
What: /sys/devices/pciXXXX:XX/0000:XX:XX.X/dma/dma<n>chan<n>/quickdata/version
2121
Date: December 3, 2009
2222
KernelVersion: 2.6.32
2323
2424
Description: Version of ioatdma device.
2525

26-
What: sys/devices/pciXXXX:XX/0000:XX:XX.X/dma/dma<n>chan<n>/quickdata/intr_coalesce
26+
What: /sys/devices/pciXXXX:XX/0000:XX:XX.X/dma/dma<n>chan<n>/quickdata/intr_coalesce
2727
Date: August 8, 2017
2828
KernelVersion: 4.14
2929

Documentation/ABI/testing/sysfs-class-net

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ Description:
152152
When an interface is under test, it cannot be expected
153153
to pass packets as normal.
154154

155-
What: /sys/clas/net/<iface>/duplex
155+
What: /sys/class/net/<iface>/duplex
156156
Date: October 2009
157157
KernelVersion: 2.6.33
158158

Documentation/leds/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,4 @@ LEDs
2525
leds-lp5562
2626
leds-lp55xx
2727
leds-mlxcpld
28+
leds-sc27xx

Documentation/misc-devices/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ fit into other categories.
2424
isl29003
2525
lis3lv02d
2626
max6875
27-
mic/index
2827
pci-endpoint-test
2928
spear-pcie-gadget
3029
uacce

scripts/get_abi.pl

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -287,6 +287,8 @@ sub create_labels {
287287
sub output_rest {
288288
create_labels();
289289

290+
my $part = "";
291+
290292
foreach my $what (sort {
291293
($data{$a}->{type} eq "File") cmp ($data{$b}->{type} eq "File") ||
292294
$a cmp $b
@@ -306,6 +308,21 @@ sub output_rest {
306308
$w =~ s/([\(\)\_\-\*\=\^\~\\])/\\$1/g;
307309

308310
if ($type ne "File") {
311+
my $cur_part = $what;
312+
if ($what =~ '/') {
313+
if ($what =~ m#^(\/?(?:[\w\-]+\/?){1,2})#) {
314+
$cur_part = "Symbols under $1";
315+
$cur_part =~ s,/$,,;
316+
}
317+
}
318+
319+
if ($cur_part ne "" && $part ne $cur_part) {
320+
$part = $cur_part;
321+
my $bar = $part;
322+
$bar =~ s/./-/g;
323+
print "$part\n$bar\n\n";
324+
}
325+
309326
printf ".. _%s:\n\n", $data{$what}->{label};
310327

311328
my @names = split /, /,$w;
@@ -352,6 +369,12 @@ sub output_rest {
352369

353370
if (!($desc =~ /^\s*$/)) {
354371
if ($description_is_rst) {
372+
# Remove title markups from the description
373+
# Having titles inside ABI files will only work if extra
374+
# care would be taken in order to strictly follow the same
375+
# level order for each markup.
376+
$desc =~ s/\n[\-\*\=\^\~]+\n/\n\n/g;
377+
355378
# Enrich text by creating cross-references
356379

357380
$desc =~ s,Documentation/(?!devicetree)(\S+)\.rst,:doc:`/$1`,g;

0 commit comments

Comments
 (0)