Commit 15f5d201 authored by Linus Torvalds's avatar Linus Torvalds
Browse files

Merge tag 'driver-core-5.10-rc3' of... 

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
parents bbc82184 d181bfe3

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

+5 −5
Original line number Diff line number Diff line 
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

KernelVersion:  2.6.32

Contact:        dmaengine@vger.kernel.org

Description:	Capabilities the DMA supports.Currently there are DMA_PQ, DMA_PQ_VAL,

		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

KernelVersion:  2.6.32

Contact:        dmaengine@vger.kernel.org

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

KernelVersion:  2.6.32

Contact:        dmaengine@vger.kernel.org

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

KernelVersion:  2.6.32

Contact:        dmaengine@vger.kernel.org

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

KernelVersion:  4.14

Contact:        dmaengine@vger.kernel.org

Documentation/ABI/testing/sysfs-class-net

+1 −1
Original line number Diff line number Diff line
@@ -152,7 +152,7 @@ Description: 
		When an interface is under test, it cannot be expected

		to pass packets as normal.



What:		/sys/clas/net/<iface>/duplex

What:		/sys/class/net/<iface>/duplex

Date:		October 2009

KernelVersion:	2.6.33

Contact:	netdev@vger.kernel.org

Documentation/leds/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -25,3 +25,4 @@ LEDs 
   leds-lp5562

   leds-lp55xx

   leds-mlxcpld

   leds-sc27xx

Documentation/misc-devices/index.rst

+0 −1
Original line number Diff line number Diff line
@@ -24,7 +24,6 @@ fit into other categories. 
   isl29003

   lis3lv02d

   max6875

   mic/index

   pci-endpoint-test

   spear-pcie-gadget

   uacce

scripts/get_abi.pl

+23 −0
Original line number Diff line number Diff line
@@ -287,6 +287,8 @@ my $bondary = qr { (?<![\w\/\`\{])(?=[\w\/\`\{])|(?<=[\w\/\`\{])(?![\w\/\`\{]) } 
sub output_rest {

	create_labels();



	my $part = "";



	foreach my $what (sort {

				($data{$a}->{type} eq "File") cmp ($data{$b}->{type} eq "File") ||

				$a cmp $b
@@ -306,6 +308,21 @@ sub output_rest { 
		$w =~ s/([\(\)\_\-\*\=\^\~\\])/\\$1/g;



		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};



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


		if (!($desc =~ /^\s*$/)) {

			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



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

CRA Git | Maintained and supported by SUSTech CRA and CCSE