]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/commitdiff
Merge tag 'docs-5.9-2' of git://git.lwn.net/linux
authorLinus Torvalds <torvalds@linux-foundation.org>
Thu, 13 Aug 2020 20:57:45 +0000 (13:57 -0700)
committerLinus Torvalds <torvalds@linux-foundation.org>
Thu, 13 Aug 2020 20:57:45 +0000 (13:57 -0700)
Pull documentation fixes from Jonathan Corbet:
 "A handful of obvious fixes that wandered in during the merge window"

* tag 'docs-5.9-2' of git://git.lwn.net/linux:
  Documentation/locking/locktypes: fix the typo
  doc/zh_CN: resolve undefined label warning in admin-guide index
  doc/zh_CN: fix title heading markup in admin-guide cpu-load
  docs: remove the 2.6 "Upgrading I2C Drivers" guide
  docs: Correct the release date of 5.2 stable
  mailmap: Update comments for with format and more detalis
  docs: cdrom: Fix a typo and rst markup
  Doc: admin-guide: use correct legends in kernel-parameters.txt
  Documentation/features: refresh RISC-V arch support files
  documentation: coccinelle: Improve command example for make C={1,2}
  Core-api: Documentation: Replace deprecated :c:func: Usage
  Dev-tools: Documentation: Replace deprecated :c:func: Usage
  Filesystems: Documentation: Replace deprecated :c:func: Usage
  docs: trace: fix a typo

1  2 
.mailmap
Documentation/admin-guide/kernel-parameters.txt
Documentation/cdrom/cdrom-standard.rst
Documentation/features/debug/stackprotector/arch-support.txt
Documentation/features/locking/lockdep/arch-support.txt
Documentation/features/time/context-tracking/arch-support.txt

diff --combined .mailmap
index a96f1b38fa589b674cfd78b02a080e8bdb814e3d,787df6ec8908dcbc786bae2173aa5b656abdb247..83d8d0158f3b70612cb781ac1fc9d11bf149f925
+++ b/.mailmap
@@@ -2,11 -2,16 +2,16 @@@
  # This list is used by git-shortlog to fix a few botched name translations
  # in the git archive, either because the author's full name was messed up
  # and/or not always written the same way, making contributions from the
- # same person appearing not to be so or badly displayed.
+ # same person appearing not to be so or badly displayed. Also allows for
+ # old email addresses to map to new email addresses.
  #
+ # For format details, see "MAPPING AUTHORS" in "man git-shortlog".
+ #
+ # Please keep this list dictionary sorted.
+ #
+ # This comment is parsed by git-shortlog:
  # repo-abbrev: /pub/scm/linux/kernel/git/
  #
  Aaron Durbin <adurbin@google.com>
  Adam Oldham <oldhamca@gmail.com>
  Adam Radford <aradford@gmail.com>
@@@ -93,16 -98,11 +98,16 @@@ Frank Rowand <frowand.list@gmail.com> <
  Frank Zago <fzago@systemfabricworks.com>
  Gao Xiang <xiang@kernel.org> <gaoxiang25@huawei.com>
  Gao Xiang <xiang@kernel.org> <hsiangkao@aol.com>
 +Gerald Schaefer <gerald.schaefer@linux.ibm.com> <gerald.schaefer@de.ibm.com>
 +Gerald Schaefer <gerald.schaefer@linux.ibm.com> <geraldsc@de.ibm.com>
 +Gerald Schaefer <gerald.schaefer@linux.ibm.com> <geraldsc@linux.vnet.ibm.com>
  Greg Kroah-Hartman <greg@echidna.(none)>
  Greg Kroah-Hartman <gregkh@suse.de>
  Greg Kroah-Hartman <greg@kroah.com>
  Gregory CLEMENT <gregory.clement@bootlin.com> <gregory.clement@free-electrons.com>
  Hanjun Guo <guohanjun@huawei.com> <hanjun.guo@linaro.org>
 +Heiko Carstens <hca@linux.ibm.com> <h.carstens@de.ibm.com>
 +Heiko Carstens <hca@linux.ibm.com> <heiko.carstens@de.ibm.com>
  Henk Vergonet <Henk.Vergonet@gmail.com>
  Henrik Kretzschmar <henne@nachtwindheim.de>
  Henrik Rydberg <rydberg@bitmath.org>
@@@ -207,9 -207,6 +212,9 @@@ Maxime Ripard <mripard@kernel.org> <max
  Mayuresh Janorkar <mayur@ti.com>
  Michael Buesch <m@bues.ch>
  Michel Dänzer <michel@tungstengraphics.com>
 +Mike Rapoport <rppt@kernel.org> <mike@compulab.co.il>
 +Mike Rapoport <rppt@kernel.org> <mike.rapoport@gmail.com>
 +Mike Rapoport <rppt@kernel.org> <rppt@linux.ibm.com>
  Miodrag Dinic <miodrag.dinic@mips.com> <miodrag.dinic@imgtec.com>
  Miquel Raynal <miquel.raynal@bootlin.com> <miquel.raynal@free-electrons.com>
  Mitesh shah <mshah@teja.com>
index 98ea67f278091ef412d48e8d83af5ef609966f51,8ccf1985a2a3942d4eacf4546c3a58a03f87ace8..bdc1f33fd3d10a409ec0830ee4cb1770b78af566
        cpufreq.off=1   [CPU_FREQ]
                        disable the cpufreq sub-system
  
 +      cpufreq.default_governor=
 +                      [CPU_FREQ] Name of the default cpufreq governor or
 +                      policy to use. This governor must be registered in the
 +                      kernel before the cpufreq driver probes.
 +
        cpu_init_udelay=N
                        [X86] Delay for N microsec between assert and de-assert
                        of APIC INIT to start processors.  This delay occurs
                        memory region [offset, offset + size] for that kernel
                        image. If '@offset' is omitted, then a suitable offset
                        is selected automatically.
-                       [KNL, x86_64] select a region under 4G first, and
+                       [KNL, X86-64] Select a region under 4G first, and
                        fall back to reserve region above 4G when '@offset'
                        hasn't been specified.
                        See Documentation/admin-guide/kdump/kdump.rst for further details.
                        Documentation/admin-guide/kdump/kdump.rst for an example.
  
        crashkernel=size[KMG],high
-                       [KNL, x86_64] range could be above 4G. Allow kernel
+                       [KNL, X86-64] range could be above 4G. Allow kernel
                        to allocate physical memory region from top, so could
                        be above 4G if system have more than 4G ram installed.
                        Otherwise memory region will be allocated below 4G, if
                        available.
                        It will be ignored if crashkernel=X is specified.
        crashkernel=size[KMG],low
-                       [KNL, x86_64] range under 4G. When crashkernel=X,high
+                       [KNL, X86-64] range under 4G. When crashkernel=X,high
                        is passed, kernel could allocate physical memory region
                        above 4G, that cause second kernel crash on system
                        that require some amount of low memory, e.g. swiotlb
                        useful to also enable the page_owner functionality.
                        on: enable the feature
  
 +      debugfs=        [KNL] This parameter enables what is exposed to userspace
 +                      and debugfs internal clients.
 +                      Format: { on, no-mount, off }
 +                      on:     All functions are enabled.
 +                      no-mount:
 +                              Filesystem is not registered but kernel clients can
 +                              access APIs and a crashkernel can be used to read
 +                              its content. There is nothing to mount.
 +                      off:    Filesystem is not registered and clients
 +                              get a -EPERM as result when trying to register files
 +                              or directories within debugfs.
 +                              This is equivalent of the runtime functionality if
 +                              debugfs was not enabled in the kernel at all.
 +                      Default value is set in build-time with a kernel configuration.
 +
        debugpat        [X86] Enable PAT debugging
  
        decnet.addr=    [HW,NET]
        disable_radix   [PPC]
                        Disable RADIX MMU mode on POWER9
  
 +      radix_hcall_invalidate=on  [PPC/PSERIES]
 +                      Disable RADIX GTSE feature and use hcall for TLB
 +                      invalidate.
 +
        disable_tlbie   [PPC]
                        Disable TLBIE instruction. Currently does not work
                        with KVM, with HASH MMU, or with coherent accelerators.
  
        gamma=          [HW,DRM]
  
-       gart_fix_e820=  [X86_64] disable the fix e820 for K8 GART
+       gart_fix_e820=  [X86-64] disable the fix e820 for K8 GART
                        Format: off | on
                        default: on
  
                        Format: 0 | 1
                        Default set by CONFIG_INIT_ON_FREE_DEFAULT_ON.
  
-       init_pkru=      [x86] Specify the default memory protection keys rights
+       init_pkru=      [X86] Specify the default memory protection keys rights
                        register contents for all processes.  0x55555554 by
                        default (disallow access to all but pkey 0).  Can
                        override in debugfs after boot.
        inport.irq=     [HW] Inport (ATI XL and Microsoft) busmouse driver
                        Format: <irq>
  
-       int_pln_enable  [x86] Enable power limit notification interrupt
+       int_pln_enable  [X86] Enable power limit notification interrupt
  
        integrity_audit=[IMA]
                        Format: { "0" | "1" }
                        bypassed by not enabling DMAR with this option. In
                        this case, gfx device will use physical address for
                        DMA.
-               forcedac [x86_64]
+               forcedac [X86-64]
                        With this option iommu will not optimize to look
                        for io virtual address below 32-bit forcing dual
                        address cycle on pci bus for cards supporting greater
                strict  regions from userspace.
                relaxed
  
-       iommu=          [x86]
+       iommu=          [X86]
                off
                force
                noforce
                merge
                nomerge
                soft
-               pt              [x86]
-               nopt            [x86]
+               pt              [X86]
+               nopt            [X86]
                nobypass        [PPC/POWERNV]
                        Disable IOMMU bypass, using IOMMU for PCI devices.
  
  
        iucv=           [HW,NET]
  
-       ivrs_ioapic     [HW,X86_64]
+       ivrs_ioapic     [HW,X86-64]
                        Provide an override to the IOAPIC-ID<->DEVICE-ID
                        mapping provided in the IVRS ACPI table. For
                        example, to map IOAPIC-ID decimal 10 to
                        PCI device 00:14.0 write the parameter as:
                                ivrs_ioapic[10]=00:14.0
  
-       ivrs_hpet       [HW,X86_64]
+       ivrs_hpet       [HW,X86-64]
                        Provide an override to the HPET-ID<->DEVICE-ID
                        mapping provided in the IVRS ACPI table. For
                        example, to map HPET-ID decimal 0 to
                        PCI device 00:14.0 write the parameter as:
                                ivrs_hpet[0]=00:14.0
  
-       ivrs_acpihid    [HW,X86_64]
+       ivrs_acpihid    [HW,X86-64]
                        Provide an override to the ACPI-HID:UID<->DEVICE-ID
                        mapping provided in the IVRS ACPI table. For
                        example, to map UART-HID:UID AMD0020:0 to
        lapic           [X86-32,APIC] Enable the local APIC even if BIOS
                        disabled it.
  
-       lapic=          [x86,APIC] "notscdeadline" Do not use TSC deadline
+       lapic=          [X86,APIC] "notscdeadline" Do not use TSC deadline
                        value for LAPIC timer one-shot implementation. Default
                        back to the programmable timer unit in the LAPIC.
  
        no5lvl          [X86-64] Disable 5-level paging mode. Forces
                        kernel to use 4-level paging instead.
  
 +      nofsgsbase      [X86] Disables FSGSBASE instructions.
 +
        no_console_suspend
                        [HW] Never suspend the console
                        Disable suspending of consoles during suspend and
                        register save and restore. The kernel will only save
                        legacy floating-point registers on task switch.
  
-       nohugeiomap     [KNL,x86,PPC] Disable kernel huge I/O mappings.
+       nohugeiomap     [KNL,X86,PPC] Disable kernel huge I/O mappings.
  
        nosmt           [KNL,S390] Disable symmetric multithreading (SMT).
                        Equivalent to smt=1.
  
-                       [KNL,x86] Disable symmetric multithreading (SMT).
+                       [KNL,X86] Disable symmetric multithreading (SMT).
                        nosmt=force: Force disable SMT, cannot be undone
                                     via the sysfs control file.
  
        pt.             [PARIDE]
                        See Documentation/admin-guide/blockdev/paride.rst.
  
-       pti=            [X86_64] Control Page Table Isolation of user and
+       pti=            [X86-64] Control Page Table Isolation of user and
                        kernel address spaces.  Disabling this feature
                        removes hardening, but improves performance of
                        system calls and interrupts.
  
                        Not specifying this option is equivalent to pti=auto.
  
-       nopti           [X86_64]
+       nopti           [X86-64]
                        Equivalent to pti=off
  
        pty.legacy_count=
                        latencies, which will choose a value aligned
                        with the appropriate hardware boundaries.
  
 +      rcutree.rcu_min_cached_objs= [KNL]
 +                      Minimum number of objects which are cached and
 +                      maintained per one CPU. Object size is equal
 +                      to PAGE_SIZE. The cache allows to reduce the
 +                      pressure to page allocator, also it makes the
 +                      whole algorithm to behave better in low memory
 +                      condition.
 +
        rcutree.jiffies_till_first_fqs= [KNL]
                        Set delay from grace-period initialization to
                        first attempt to force quiescent states.
                        Set time (jiffies) between CPU-hotplug operations,
                        or zero to disable CPU-hotplug testing.
  
 +      rcutorture.read_exit= [KNL]
 +                      Set the number of read-then-exit kthreads used
 +                      to test the interaction of RCU updaters and
 +                      task-exit processing.
 +
 +      rcutorture.read_exit_burst= [KNL]
 +                      The number of times in a given read-then-exit
 +                      episode that a set of read-then-exit kthreads
 +                      is spawned.
 +
 +      rcutorture.read_exit_delay= [KNL]
 +                      The delay, in seconds, between successive
 +                      read-then-exit testing episodes.
 +
        rcutorture.shuffle_interval= [KNL]
                        Set task-shuffle interval (s).  Shuffling tasks
                        allows some CPUs to go into dyntick-idle mode
                              reboot_cpu is s[mp]#### with #### being the processor
                                        to be used for rebooting.
  
 +      refscale.holdoff= [KNL]
 +                      Set test-start holdoff period.  The purpose of
 +                      this parameter is to delay the start of the
 +                      test until boot completes in order to avoid
 +                      interference.
 +
 +      refscale.loops= [KNL]
 +                      Set the number of loops over the synchronization
 +                      primitive under test.  Increasing this number
 +                      reduces noise due to loop start/end overhead,
 +                      but the default has already reduced the per-pass
 +                      noise to a handful of picoseconds on ca. 2020
 +                      x86 laptops.
 +
 +      refscale.nreaders= [KNL]
 +                      Set number of readers.  The default value of -1
 +                      selects N, where N is roughly 75% of the number
 +                      of CPUs.  A value of zero is an interesting choice.
 +
 +      refscale.nruns= [KNL]
 +                      Set number of runs, each of which is dumped onto
 +                      the console log.
 +
 +      refscale.readdelay= [KNL]
 +                      Set the read-side critical-section duration,
 +                      measured in microseconds.
 +
 +      refscale.scale_type= [KNL]
 +                      Specify the read-protection implementation to test.
 +
 +      refscale.shutdown= [KNL]
 +                      Shut down the system at the end of the performance
 +                      test.  This defaults to 1 (shut it down) when
 +                      rcuperf is built into the kernel and to 0 (leave
 +                      it running) when rcuperf is built as a module.
 +
 +      refscale.verbose= [KNL]
 +                      Enable additional printk() statements.
 +
        relax_domain_level=
                        [KNL, SMP] Set scheduler's default relax_domain_level.
                        See Documentation/admin-guide/cgroup-v1/cpusets.rst.
                        fragmentation.  Defaults to 1 for systems with
                        more than 32MB of RAM, 0 otherwise.
  
 -      slub_debug[=options[,slabs]]    [MM, SLUB]
 +      slub_debug[=options[,slabs][;[options[,slabs]]...]      [MM, SLUB]
                        Enabling slub_debug allows one to determine the
                        culprit if slab objects become corrupted. Enabling
                        slub_debug can create guard zones around objects and
                        Prevent the CPU-hotplug component of torturing
                        until after init has spawned.
  
 +      torture.ftrace_dump_at_shutdown= [KNL]
 +                      Dump the ftrace buffer at torture-test shutdown,
 +                      even if there were no errors.  This can be a
 +                      very costly operation when many torture tests
 +                      are running concurrently, especially on systems
 +                      with rotating-rust storage.
 +
        tp720=          [HW,PS2]
  
        tpm_suspend_pcr=[HW,TPM]
                        panic() code such as dumping handler.
  
        xen_nopvspin    [X86,XEN]
 -                      Disables the ticketlock slowpath using Xen PV
 -                      optimizations.
 +                      Disables the qspinlock slowpath using Xen PV optimizations.
 +                      This parameter is obsoleted by "nopvspin" parameter, which
 +                      has equivalent effect for XEN platform.
  
        xen_nopv        [X86]
                        Disables the PV optimizations forcing the HVM guest to
                        as generic guest with no PV drivers. Currently support
                        XEN HVM, KVM, HYPER_V and VMWARE guest.
  
 +      nopvspin        [X86,XEN,KVM]
 +                      Disables the qspinlock slow path using PV optimizations
 +                      which allow the hypervisor to 'idle' the guest on lock
 +                      contention.
 +
        xirc2ps_cs=     [NET,PCMCIA]
                        Format:
                        <irq>,<irq_mask>,<io>,<full_duplex>,<do_sound>,<lockup_hack>[,<irq2>[,<irq3>[,<irq4>]]]
index 2de90581059033ec465333a70e6ae755d2eb7f3e,5a1305638be7b235d1fac076f00cc1f496f42321..70500b189cc84431e266de9017cd082fd04e5b3f
@@@ -157,6 -157,7 +157,6 @@@ with the kernel as a block device by re
                cdrom_release,          /∗ release ∗/
                NULL,                   /∗ fsync ∗/
                NULL,                   /∗ fasync ∗/
 -              cdrom_media_changed,    /∗ media change ∗/
                NULL                    /∗ revalidate ∗/
        };
  
@@@ -365,6 -366,19 +365,6 @@@ which may or may not be in the drive). 
        CDS_DRIVE_NOT_READY     /* something is wrong, tray is moving? */
        CDS_DISC_OK             /* a disc is loaded and everything is fine */
  
 -::
 -
 -      int media_changed(struct cdrom_device_info *cdi, int disc_nr)
 -
 -This function is very similar to the original function in $struct
 -file_operations*. It returns 1 if the medium of the device *cdi->dev*
 -has changed since the last call, and 0 otherwise. The parameter
 -*disc_nr* identifies a specific slot in a juke-box, it should be
 -ignored for single-disc drives. Note that by `re-routing` this
 -function through *cdrom_media_changed()*, we can implement separate
 -queues for the VFS and a new *ioctl()* function that can report device
 -changes to software (e. g., an auto-mounting daemon).
 -
  ::
  
        int tray_move(struct cdrom_device_info *cdi, int position)
@@@ -557,7 -571,7 +557,7 @@@ phase. Currently, the capabilities are 
        CDC_DRIVE_STATUS        /* driver implements drive status */
  
  The capability flag is declared *const*, to prevent drivers from
- accidentally tampering with the contents. The capability fags actually
+ accidentally tampering with the contents. The capability flags actually
  inform `cdrom.c` of what the driver can do. If the drive found
  by the driver does not have the capability, is can be masked out by
  the *cdrom_device_info* variable *mask*. For instance, the SCSI CD-ROM
@@@ -736,7 -750,7 +736,7 @@@ Description of routines in `cdrom.c
  
  Only a few routines in `cdrom.c` are exported to the drivers. In this
  new section we will discuss these, as well as the functions that `take
- over' the CD-ROM interface to the kernel. The header file belonging
+ over` the CD-ROM interface to the kernel. The header file belonging
  to `cdrom.c` is called `cdrom.h`. Formerly, some of the contents of this
  file were placed in the file `ucdrom.h`, but this file has now been
  merged back into `cdrom.h`.
@@@ -903,7 -917,9 +903,7 @@@ commands can be identified by the under
        maximum number of discs in the juke-box found in the *cdrom_dops*.
  `CDROM_MEDIA_CHANGED`
        Returns 1 if a disc has been changed since the last call.
 -      Note that calls to *cdrom_media_changed* by the VFS are treated
 -      by an independent queue, so both mechanisms will detect a
 -      media change once. For juke-boxes, an extra argument *arg*
 +      For juke-boxes, an extra argument *arg*
        specifies the slot for which the information is given. The special
        value *CDSL_CURRENT* requests that information about the currently
        selected slot be returned.
index 3db4763aa3f557c9e5becafcfb6e8b88853b003d,79233416c05f6e4f4fe8d9d6ccb2d6739a02d659..3329559c8207dd85e31b03cddad85f5867f636fd
      |    openrisc: | TODO |
      |      parisc: | TODO |
      |     powerpc: |  ok  |
-     |       riscv: | TODO |
+     |       riscv: |  ok  |
      |        s390: | TODO |
      |          sh: |  ok  |
      |       sparc: | TODO |
      |          um: | TODO |
 -    |   unicore32: | TODO |
      |         x86: |  ok  |
      |      xtensa: |  ok  |
      -----------------------
index 4f844ecd06803c721edf8bd89960fdb3ad5cce98,56c7cf1404dac8788cebf6f0bc06bfa6a87d4b3d..940b0bd02957542c89856e7d73fd254f395e089a
      |    openrisc: |  ok  |
      |      parisc: | TODO |
      |     powerpc: |  ok  |
-     |       riscv: | TODO |
+     |       riscv: |  ok  |
      |        s390: |  ok  |
      |          sh: |  ok  |
      |       sparc: |  ok  |
      |          um: |  ok  |
 -    |   unicore32: |  ok  |
      |         x86: |  ok  |
      |      xtensa: |  ok  |
      -----------------------
index a71f3a945285d857fbbc5454edf9cd0ad9709b06,0d211d737c9cc4230f2a1ee6947d31802d729ea9..266c81e8a721dc6c65529e7b7011d7f289ebd171
      |    openrisc: | TODO |
      |      parisc: | TODO |
      |     powerpc: |  ok  |
-     |       riscv: | TODO |
+     |       riscv: |  ok  |
      |        s390: | TODO |
      |          sh: | TODO |
      |       sparc: |  ok  |
      |          um: | TODO |
 -    |   unicore32: | TODO |
      |         x86: |  ok  |
      |      xtensa: | TODO |
      -----------------------