Commit 3f11de39 authored by Jonathan Corbet's avatar Jonathan Corbet
Browse files

Merge branch 'mauro' into docs-next 

Mauro sez:

Patches 1 to 5 contain changes to the documentation toolset:

- The first 3 patches help to reduce a lot the number of reported
  kernel-doc issues, by making the tool more smart.

- Patches 4 and 5 are meant to partially address the PDF
  build, with now requires Sphinx version 2.4 or upper.

The remaining patches fix broken references detected by
this tool:

        ./scripts/documentation-file-ref-check

and address other random errors due to tags being mis-interpreted
or mis-used.

They are independent each other, but some may depend on
the kernel-doc improvements.
parents 2f9c5025 4642289b

Documentation/ABI/stable/sysfs-devices-node

+1 −1
Original line number Diff line number Diff line
@@ -54,7 +54,7 @@ Date: October 2002 
Contact:	Linux Memory Management list <linux-mm@kvack.org>

Description:

		Provides information about the node's distribution and memory

		utilization. Similar to /proc/meminfo, see Documentation/filesystems/proc.txt

		utilization. Similar to /proc/meminfo, see Documentation/filesystems/proc.rst



What:		/sys/devices/system/node/nodeX/numastat

Date:		October 2002

Documentation/ABI/testing/procfs-smaps_rollup

+1 −1
Original line number Diff line number Diff line
@@ -11,7 +11,7 @@ Description: 
		Additionally, the fields Pss_Anon, Pss_File and Pss_Shmem

		are not present in /proc/pid/smaps.  These fields represent

		the sum of the Pss field of each type (anon, file, shmem).

		For more details, see Documentation/filesystems/proc.txt

		For more details, see Documentation/filesystems/proc.rst

		and the procfs man page.



		Typical output looks like this:

Documentation/Makefile

+5 −1
Original line number Diff line number Diff line
@@ -98,7 +98,11 @@ else # HAVE_PDFLATEX 


pdfdocs: latexdocs

	@$(srctree)/scripts/sphinx-pre-install --version-check

	$(foreach var,$(SPHINXDIRS), $(MAKE) PDFLATEX="$(PDFLATEX)" LATEXOPTS="$(LATEXOPTS)" -C $(BUILDDIR)/$(var)/latex || exit;)

	$(foreach var,$(SPHINXDIRS), \

	   $(MAKE) PDFLATEX="$(PDFLATEX)" LATEXOPTS="$(LATEXOPTS)" -C $(BUILDDIR)/$(var)/latex || exit; \

	   mkdir -p $(BUILDDIR)/$(var)/pdf; \

	   mv $(subst .tex,.pdf,$(wildcard $(BUILDDIR)/$(var)/latex/*.tex)) $(BUILDDIR)/$(var)/pdf/; \

	)



endif # HAVE_PDFLATEX

Documentation/PCI/boot-interrupts.rst

+19 −15
Original line number Diff line number Diff line
@@ -32,12 +32,13 @@ interrupt goes unhandled over time, they are tracked by the Linux kernel as 
Spurious Interrupts. The IRQ will be disabled by the Linux kernel after it

reaches a specific count with the error "nobody cared". This disabled IRQ

now prevents valid usage by an existing interrupt which may happen to share

the IRQ line.

the IRQ line::



  irq 19: nobody cared (try booting with the "irqpoll" option)

  CPU: 0 PID: 2988 Comm: irq/34-nipalk Tainted: 4.14.87-rt49-02410-g4a640ec-dirty #1

  Hardware name: National Instruments NI PXIe-8880/NI PXIe-8880, BIOS 2.1.5f1 01/09/2020

  Call Trace:



  <IRQ>

   ? dump_stack+0x46/0x5e

   ? __report_bad_irq+0x2e/0xb0
@@ -85,13 +86,16 @@ Mitigations 
The mitigations take the form of PCI quirks. The preference has been to

first identify and make use of a means to disable the routing to the PCH.

In such a case a quirk to disable boot interrupt generation can be

added.[1]

added. [1]_



Intel® 6300ESB I/O Controller Hub

  Alternate Base Address Register:

   BIE: Boot Interrupt Enable

	  0 = Boot interrupt is enabled.

	  1 = Boot interrupt is disabled.



	  ==  ===========================

	  0   Boot interrupt is enabled.

	  1   Boot interrupt is disabled.

	  ==  ===========================



Intel® Sandy Bridge through Sky Lake based Xeon servers:

  Coherent Interface Protocol Interrupt Control
@@ -109,12 +113,12 @@ line by default. Therefore, on chipsets where this INTx routing cannot be 
disabled, the Linux kernel will reroute the valid interrupt to its legacy

interrupt. This redirection of the handler will prevent the occurrence of

the spurious interrupt detection which would ordinarily disable the IRQ

line due to excessive unhandled counts.[2]

line due to excessive unhandled counts. [2]_



The config option X86_REROUTE_FOR_BROKEN_BOOT_IRQS exists to enable (or

disable) the redirection of the interrupt handler to the PCH interrupt

line. The option can be overridden by either pci=ioapicreroute or

pci=noioapicreroute.[3]

pci=noioapicreroute. [3]_





More Documentation
@@ -127,11 +131,11 @@ into the evolution of its handling with chipsets. 
Example of disabling of the boot interrupt

------------------------------------------



Intel® 6300ESB I/O Controller Hub (Document # 300641-004US)

      - Intel® 6300ESB I/O Controller Hub (Document # 300641-004US)

	5.7.3 Boot Interrupt

	https://www.intel.com/content/dam/doc/datasheet/6300esb-io-controller-hub-datasheet.pdf



Intel® Xeon® Processor E5-1600/2400/2600/4600 v3 Product Families

      - Intel® Xeon® Processor E5-1600/2400/2600/4600 v3 Product Families

	Datasheet - Volume 2: Registers (Document # 330784-003)

	6.6.41 cipintrc Coherent Interface Protocol Interrupt Control

	https://www.intel.com/content/dam/www/public/us/en/documents/datasheets/xeon-e5-v3-datasheet-vol-2.pdf
@@ -139,7 +143,7 @@ Datasheet - Volume 2: Registers (Document # 330784-003) 
Example of handler rerouting

----------------------------



Intel® 6700PXH 64-bit PCI Hub (Document # 302628)

      - Intel® 6700PXH 64-bit PCI Hub (Document # 302628)

	2.15.2 PCI Express Legacy INTx Support and Boot Interrupt

	https://www.intel.com/content/dam/doc/datasheet/6700pxh-64-bit-pci-hub-datasheet.pdf
@@ -150,6 +154,6 @@ Cheers, 
    Sean V Kelley

    sean.v.kelley@linux.intel.com



[1] https://lore.kernel.org/r/12131949181903-git-send-email-sassmann@suse.de/

[2] https://lore.kernel.org/r/12131949182094-git-send-email-sassmann@suse.de/

[3] https://lore.kernel.org/r/487C8EA7.6020205@suse.de/
 
.. [1] https://lore.kernel.org/r/12131949181903-git-send-email-sassmann@suse.de/

.. [2] https://lore.kernel.org/r/12131949182094-git-send-email-sassmann@suse.de/

.. [3] https://lore.kernel.org/r/487C8EA7.6020205@suse.de/

Documentation/admin-guide/cpu-load.rst

+1 −1
Original line number Diff line number Diff line
@@ -105,7 +105,7 @@ References 
----------



- http://lkml.org/lkml/2007/2/12/6

- Documentation/filesystems/proc.txt (1.8)

- Documentation/filesystems/proc.rst (1.8)





Thanks