Commit a3540495 authored by Linus Torvalds's avatar Linus Torvalds
Browse files

Merge tag 'docs-6.5' of git://git.lwn.net/linux 

Pull documentation updates from Jonathan Corbet:
 "It's been a relatively calm cycle in docsland. We do have:

   - Some initial page-table documentation from Linus (the other Linus)

   - Regression-handling documentation improvements from Thorsten

   - Addition of kerneldoc documentation for the ERR_PTR() and related
     macros from James Seo

  ... and the usual collection of fixes and updates"

* tag 'docs-6.5' of git://git.lwn.net/linux:
  docs: consolidate storage interfaces
  Documentation: update git configuration for Link: tag
  Documentation: KVM: make corrections to vcpu-requests.rst
  Documentation: KVM: make corrections to ppc-pv.rst
  Documentation: KVM: make corrections to locking.rst
  Documentation: KVM: make corrections to halt-polling.rst
  Documentation: virt: correct location of haltpoll module params
  Documentation/mm: Initial page table documentation
  docs: crypto: async-tx-api: fix typo in struct name
  docs/doc-guide: Clarify how to write tables
  docs: handling-regressions: rework section about fixing procedures
  docs: process: fix a typoed cross-reference
  docs: submitting-patches: Discuss interleaved replies
  MAINTAINERS: direct process doc changes to a dedicated ML
  Documentation: core-api: Add error pointer functions to kernel-api
  err.h: Add missing kerneldocs for error pointer functions
  Documentation: conf.py: Add __force to c_id_attributes
  docs: clarify KVM related kernel parameters' descriptions
  docs: consolidate human interface subsystems
  docs: admin-guide: Add information about intel_pstate active mode
parents dedbf31a a1e72bb0

Documentation/admin-guide/kernel-parameters.txt

+39 −24
Original line number Diff line number Diff line
@@ -2112,6 +2112,16 @@ 
			disable

			  Do not enable intel_pstate as the default

			  scaling driver for the supported processors

                        active

                          Use intel_pstate driver to bypass the scaling

                          governors layer of cpufreq and provides it own

                          algorithms for p-state selection. There are two

                          P-state selection algorithms provided by

                          intel_pstate in the active mode: powersave and

                          performance.  The way they both operate depends

                          on whether or not the hardware managed P-states

                          (HWP) feature has been enabled in the processor

                          and possibly on the processor model.

			passive

			  Use intel_pstate as a scaling driver, but configure it

			  to work with generic cpufreq governors (instead of
@@ -2546,12 +2556,13 @@ 
			If the value is 0 (the default), KVM will pick a period based

			on the ratio, such that a page is zapped after 1 hour on average.



	kvm-amd.nested=	[KVM,AMD] Allow nested virtualization in KVM/SVM.

			Default is 1 (enabled)

	kvm-amd.nested=	[KVM,AMD] Control nested virtualization feature in

			KVM/SVM. Default is 1 (enabled).



	kvm-amd.npt=	[KVM,AMD] Disable nested paging (virtualized MMU)

			for all guests.

			Default is 1 (enabled) if in 64-bit or 32-bit PAE mode.

	kvm-amd.npt=	[KVM,AMD] Control KVM's use of Nested Page Tables,

			a.k.a. Two-Dimensional Page Tables. Default is 1

			(enabled). Disable by KVM if hardware lacks support

			for NPT.



	kvm-arm.mode=

			[KVM,ARM] Select one of KVM/arm64's modes of operation.
@@ -2597,30 +2608,33 @@ 
			Format: <integer>

			Default: 5



	kvm-intel.ept=	[KVM,Intel] Disable extended page tables

			(virtualized MMU) support on capable Intel chips.

			Default is 1 (enabled)

	kvm-intel.ept=	[KVM,Intel] Control KVM's use of Extended Page Tables,

			a.k.a. Two-Dimensional Page Tables.  Default is 1

			(enabled). Disable by KVM if hardware lacks support

			for EPT.



	kvm-intel.emulate_invalid_guest_state=

			[KVM,Intel] Disable emulation of invalid guest state.

			Ignored if kvm-intel.enable_unrestricted_guest=1, as

			guest state is never invalid for unrestricted guests.

			This param doesn't apply to nested guests (L2), as KVM

			never emulates invalid L2 guest state.

			Default is 1 (enabled)

			[KVM,Intel] Control whether to emulate invalid guest

			state. Ignored if kvm-intel.enable_unrestricted_guest=1,

			as guest state is never invalid for unrestricted

			guests. This param doesn't apply to nested guests (L2),

			as KVM never emulates invalid L2 guest state.

			Default is 1 (enabled).



	kvm-intel.flexpriority=

			[KVM,Intel] Disable FlexPriority feature (TPR shadow).

			Default is 1 (enabled)

			[KVM,Intel] Control KVM's use of FlexPriority feature

			(TPR shadow). Default is 1 (enabled). Disalbe by KVM if

			hardware lacks support for it.



	kvm-intel.nested=

			[KVM,Intel] Enable VMX nesting (nVMX).

			Default is 0 (disabled)

			[KVM,Intel] Control nested virtualization feature in

			KVM/VMX. Default is 1 (enabled).



	kvm-intel.unrestricted_guest=

			[KVM,Intel] Disable unrestricted guest feature

			(virtualized real and unpaged mode) on capable

			Intel chips. Default is 1 (enabled)

			[KVM,Intel] Control KVM's use of unrestricted guest

			feature (virtualized real and unpaged mode). Default

			is 1 (enabled). Disable by KVM if EPT is disabled or

			hardware lacks support for it.



	kvm-intel.vmentry_l1d_flush=[KVM,Intel] Mitigation for L1 Terminal Fault

			CVE-2018-3620.
@@ -2634,9 +2648,10 @@ 


			Default is cond (do L1 cache flush in specific instances)



	kvm-intel.vpid=	[KVM,Intel] Disable Virtual Processor Identification

			feature (tagged TLBs) on capable Intel chips.

			Default is 1 (enabled)

	kvm-intel.vpid=	[KVM,Intel] Control KVM's use of Virtual Processor

			Identification feature (tagged TLBs). Default is 1

			(enabled). Disable by KVM if hardware lacks support

			for it.



	l1d_flush=	[X86,INTEL]

			Control mitigation for L1D based snooping vulnerability.

Documentation/conf.py

+1 −0
Original line number Diff line number Diff line
@@ -74,6 +74,7 @@ if major >= 3: 
            "__percpu",

            "__rcu",

            "__user",

            "__force",



            # include/linux/compiler_attributes.h:

            "__alias",

Documentation/core-api/kernel-api.rst

+6 −0
Original line number Diff line number Diff line
@@ -96,6 +96,12 @@ Command-line Parsing 
.. kernel-doc:: lib/cmdline.c

   :export:



Error Pointers

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



.. kernel-doc:: include/linux/err.h

   :internal:



Sorting

-------

Documentation/crypto/async-tx-api.rst

+1 −1
Original line number Diff line number Diff line
@@ -66,7 +66,7 @@ features surfaced as a result: 
::



  struct dma_async_tx_descriptor *

  async_<operation>(<op specific parameters>, struct async_submit ctl *submit)

  async_<operation>(<op specific parameters>, struct async_submit_ctl *submit)



3.2 Supported operations

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

Documentation/doc-guide/sphinx.rst

+10 −1
Original line number Diff line number Diff line
@@ -313,9 +313,18 @@ the documentation build system will automatically turn a reference to 
function name exists.  If you see ``c:func:`` use in a kernel document,

please feel free to remove it.



Tables

------



ReStructuredText provides several options for table syntax. Kernel style for

tables is to prefer *simple table* syntax or *grid table* syntax. See the

`reStructuredText user reference for table syntax`_ for more details.



.. _reStructuredText user reference for table syntax:

   https://docutils.sourceforge.io/docs/user/rst/quickref.html#tables



list tables

-----------

~~~~~~~~~~~



The list-table formats can be useful for tables that are not easily laid

out in the usual Sphinx ASCII-art formats.  These formats are nearly