Merge tag 'docs-5.4' of git://git.lwn.net/linux
authorLinus Torvalds <torvalds@linux-foundation.org>
Tue, 17 Sep 2019 23:22:26 +0000 (16:22 -0700)
committerLinus Torvalds <torvalds@linux-foundation.org>
Tue, 17 Sep 2019 23:22:26 +0000 (16:22 -0700)
Pull documentation updates from Jonathan Corbet:
 "It's a somewhat calmer cycle for docs this time, as the churn of the
  mass RST conversion is happily mostly behind us.

   - A new document on reproducible builds.

   - We finally got around to zapping the documentation for hardware
     support that was removed in 2004; one doesn't want to rush these
     things.

   - The usual assortment of fixes, typo corrections, etc"

* tag 'docs-5.4' of git://git.lwn.net/linux: (67 commits)
  Documentation: kbuild: Add document about reproducible builds
  docs: printk-formats: Stop encouraging use of unnecessary %h[xudi] and %hh[xudi]
  Documentation: Add "earlycon=sbi" to the admin guide
  doc:lock: remove reference to clever use of read-write lock
  devices.txt: improve entry for comedi (char major 98)
  docs: mtd: Update spi nor reference driver
  doc: arm64: fix grammar dtb placed in no attributes region
  Documentation: sysrq: don't recommend 'S' 'U' before 'B'
  mailmap: Update email address for Quentin Perret
  docs: ftrace: clarify when tracing is disabled by the trace file
  docs: process: fix broken link
  Documentation/arm/samsung-s3c24xx: Remove stray U+FEFF character to fix title
  Documentation/arm/sa1100/assabet: Fix 'make assabet_defconfig' command
  Documentation/arm/sa1100: Remove some obsolete documentation
  docs/zh_CN: update Chinese howto.rst for latexdocs making
  Documentation: virt: Fix broken reference to virt tree's index
  docs: Fix typo on pull requests guide
  kernel-doc: Allow anonymous enum
  Documentation: sphinx: Don't parse socket() as identifier reference
  Documentation: sphinx: Add missing comma to list of strings
  ...

13 files changed:
1  2 
.mailmap
Documentation/admin-guide/cifs/todo.rst
Documentation/admin-guide/kernel-parameters.txt
Documentation/hwmon/shtc1.rst
Documentation/riscv/boot-image-header.rst
Documentation/security/tpm/index.rst
MAINTAINERS
drivers/auxdisplay/Kconfig
drivers/hwmon/smm665.c
drivers/i2c/busses/Kconfig
drivers/i2c/busses/i2c-i801.c
drivers/i2c/i2c-core-base.c
drivers/spi/Kconfig

diff --cc .mailmap
index 1ad4fd6556193e5610397cd7ba20bc1a32856785,afbce4d329a1f9d70cb7137ca3e9a451c1ea894d..62bf76cb9972f4b51845ee5c61399be3c58baef6
+++ b/.mailmap
@@@ -178,9 -177,13 +185,14 @@@ Morten Welinder <welinder@darter.rentec
  Morten Welinder <welinder@troll.com>
  Mythri P K <mythripk@ti.com>
  Nguyen Anh Quynh <aquynh@gmail.com>
 +Nicolas Ferre <nicolas.ferre@microchip.com> <nicolas.ferre@atmel.com>
  Nicolas Pitre <nico@fluxnic.net> <nicolas.pitre@linaro.org>
  Nicolas Pitre <nico@fluxnic.net> <nico@linaro.org>
+ Oleksij Rempel <linux@rempel-privat.de> <bug-track@fisher-privat.net>
+ Oleksij Rempel <linux@rempel-privat.de> <external.Oleksij.Rempel@de.bosch.com>
+ Oleksij Rempel <linux@rempel-privat.de> <fixed-term.Oleksij.Rempel@de.bosch.com>
+ Oleksij Rempel <linux@rempel-privat.de> <o.rempel@pengutronix.de>
+ Oleksij Rempel <linux@rempel-privat.de> <ore@pengutronix.de>
  Paolo 'Blaisorblade' Giarrusso <blaisorblade@yahoo.it>
  Patrick Mochel <mochel@digitalimplant.org>
  Paul Burton <paul.burton@mips.com> <paul.burton@imgtec.com>
index edbbccda1942e4c84bf5b3dd3e5d3c1bd7959b32,95f18e8c9b8a5e1a4eeef97a96f448ec6b628b6a..084c25f92dcb00fb43e879453e2443a8a2eef0a0
@@@ -13,52 -18,49 +18,54 @@@ a) SMB3 (and SMB3.1.1) missing optiona
     - T10 copy offload ie "ODX" (copy chunk, and "Duplicate Extents" ioctl
       currently the only two server side copy mechanisms supported)
  
 -b) improved sparse file support
 +b) improved sparse file support (fiemap and SEEK_HOLE are implemented
- but additional features would be supportable by the protocol).
++   but additional features would be supportable by the protocol).
  
  c) Directory entry caching relies on a 1 second timer, rather than
- using Directory Leases, currently only the root file handle is cached longer
   using Directory Leases, currently only the root file handle is cached longer
  
  d) quota support (needs minor kernel change since quota calls
- to make it to network filesystems or deviceless filesystems)
   to make it to network filesystems or deviceless filesystems)
  
- e) Additional use cases can be optimized to use "compounding"
- (e.g. open/query/close and open/setinfo/close) to reduce the number
- of roundtrips to the server and improve performance. Various cases
- (stat, statfs, create, unlink, mkdir) already have been improved by
- using compounding but more can be done.  In addition we could significantly
- reduce redundant opens by using deferred close (with handle caching leases)
- and better using reference counters on file handles.
 -e) Additional use cases where we use "compoounding" (e.g. open/query/close
 -   and open/setinfo/close) to reduce the number of roundtrips, and also
 -   open to reduce redundant opens (using deferred close and reference counts
 -   more).
++e) Additional use cases can be optimized to use "compounding" (e.g.
++   open/query/close and open/setinfo/close) to reduce the number of
++   roundtrips to the server and improve performance. Various cases
++   (stat, statfs, create, unlink, mkdir) already have been improved by
++   using compounding but more can be done. In addition we could
++   significantly reduce redundant opens by using deferred close (with
++   handle caching leases) and better using reference counters on file
++   handles.
  
  f) Finish inotify support so kde and gnome file list windows
- will autorefresh (partially complete by Asser). Needs minor kernel
- vfs change to support removing D_NOTIFY on a file.   
   will autorefresh (partially complete by Asser). Needs minor kernel
+    vfs change to support removing D_NOTIFY on a file.
  
  g) Add GUI tool to configure /proc/fs/cifs settings and for display of
- the CIFS statistics (started)
   the CIFS statistics (started)
  
  h) implement support for security and trusted categories of xattrs
- (requires minor protocol extension) to enable better support for SELINUX
   (requires minor protocol extension) to enable better support for SELINUX
  
  i) Add support for tree connect contexts (see MS-SMB2) a new SMB3.1.1 protocol
     feature (may be especially useful for virtualization).
  
  j) Create UID mapping facility so server UIDs can be mapped on a per
- mount or a per server basis to client UIDs or nobody if no mapping
- exists. Also better integration with winbind for resolving SID owners
   mount or a per server basis to client UIDs or nobody if no mapping
   exists. Also better integration with winbind for resolving SID owners
  
  k) Add tools to take advantage of more smb3 specific ioctls and features
- (passthrough ioctl/fsctl is now implemented in cifs.ko to allow sending
- various SMB3 fsctls and query info and set info calls directly from user space)
- Add tools to make setting various non-POSIX metadata attributes easier
- from tools (e.g. extending what was done in smb-info tool).
 -   (passthrough ioctl/fsctl for sending various SMB3 fsctls to the server
 -   is in progress, and a passthrough query_info call is already implemented
 -   in cifs.ko to allow smb3 info levels queries to be sent from userspace)
++   (passthrough ioctl/fsctl is now implemented in cifs.ko to allow
++   sending various SMB3 fsctls and query info and set info calls
++   directly from user space) Add tools to make setting various non-POSIX
++   metadata attributes easier from tools (e.g. extending what was done
++   in smb-info tool).
  
  l) encrypted file support
  
  m) improved stats gathering tools (perhaps integration with nfsometer?)
- to extend and make easier to use what is currently in /proc/fs/cifs/Stats
   to extend and make easier to use what is currently in /proc/fs/cifs/Stats
  
 -n) allow setting more NTFS/SMB3 file attributes remotely (currently limited to
 -   compressed file attribute via chflags) and improve user space tools for
 -   managing and viewing them.
 +n) Add support for claims based ACLs ("DAC")
  
  o) mount helper GUI (to simplify the various configuration options on mount)
  
@@@ -74,22 -76,21 +81,23 @@@ q) Allow mount.cifs to be more verbose 
  r) updating cifs documentation, and user guide.
  
  s) Addressing bugs found by running a broader set of xfstests in standard
- file system xfstest suite.
   file system xfstest suite.
  
  t) split cifs and smb3 support into separate modules so legacy (and less
- secure) CIFS dialect can be disabled in environments that don't need it
- and simplify the code.
   secure) CIFS dialect can be disabled in environments that don't need it
   and simplify the code.
  
  v) POSIX Extensions for SMB3.1.1 (started, create and mkdir support added
- so far).
   so far).
  
  w) Add support for additional strong encryption types, and additional spnego
- authentication mechanisms (see MS-SMB2)
   authentication mechanisms (see MS-SMB2)
  
- KNOWN BUGS
- ====================================
 +x) Finish support for SMB3.1.1 compression
 +
+ Known Bugs
+ ==========
  See http://bugzilla.samba.org - search on product "CifsVFS" for
  current bug list.  Also check http://bugzilla.kernel.org (Product = File System, Component = CIFS)
  
index 9b0f1eee5bf2adad564efba59a791da5039400d4,70c1192bbd8c368fcfa677a42f014a373b4e5bcb..08380f21ab6a052a954d6261ca470670297ab2d2
@@@ -40,12 -30,13 +40,12 @@@ Author
  Description
  -----------
  
 -This driver implements support for the Sensirion SHTC1 chip, a humidity and
 -temperature sensor. Temperature is measured in degrees celsius, relative
 -humidity is expressed as a percentage. Driver can be used as well for SHTW1
 -chip, which has the same electrical interface.
 +This driver implements support for the Sensirion SHTC1, SHTW1, and SHTC3
 +chips, a humidity and temperature sensor. Temperature is measured in degrees
 +celsius, relative humidity is expressed as a percentage.
  
  The device communicates with the I2C protocol. All sensors are set to I2C
- address 0x70. See Documentation/i2c/instantiating-devices for methods to
+ address 0x70. See Documentation/i2c/instantiating-devices.rst for methods to
  instantiate the device.
  
  There are two options configurable by means of shtc1_platform_data:
index 14b1492f689bbe71c983a1baba1756d4e79e4204,43e9bd0731d5f1642d5abe604200217444bdf599..7b4d1d747585e7717b489300908ae3bf35aae82b
@@@ -15,10 -18,10 +18,10 @@@ The following 64-byte header is presen
        u64 image_size;           /* Effective Image size, little endian */
        u64 flags;                /* kernel flags, little endian */
        u32 version;              /* Version of this header */
-       u32 res1  = 0;            /* Reserved */
-       u64 res2  = 0;            /* Reserved */
+       u32 res1 = 0;             /* Reserved */
+       u64 res2 = 0;             /* Reserved */
        u64 magic = 0x5643534952; /* Magic number, little endian, "RISCV" */
 -      u32 res3;                 /* Reserved for additional RISC-V specific header */
 +      u32 magic2 = 0x56534905;  /* Magic number 2, little endian, "RSC\x05" */
        u32 res4;                 /* Reserved for PE COFF offset */
  
  This header format is compliant with PE/COFF header and largely inspired from
@@@ -32,20 -37,25 +37,26 @@@ Note
    code0 should be replaced with "MZ" magic string and res5(at offset 0x3c) should
    point to the rest of the PE/COFF header.
  
- - version field indicate header version number.
-       Bits 0:15  - Minor version
-       Bits 16:31 - Major version
+ - version field indicate header version number
+       ==========  =============
+       Bits 0:15   Minor version
+       Bits 16:31  Major version
+       ==========  =============
  
    This preserves compatibility across newer and older version of the header.
 -  The current version is defined as 0.1.
 +  The current version is defined as 0.2.
  
 -- res3 is reserved for offset to any other additional fields. This makes the
 -  header extendible in future. One example would be to accommodate ISA
 -  extension for RISC-V in future. For current version, it is set to be zero.
 +- The "magic" field is deprecated as of version 0.2.  In a future
 +  release, it may be removed.  This originally should have matched up
 +  with the ARM64 header "magic" field, but unfortunately does not.
 +  The "magic2" field replaces it, matching up with the ARM64 header.
  
 -- In current header, the flag field has only one field.
 +- In current header, the flags field has only one field.
-       Bit 0: Kernel endianness. 1 if BE, 0 if LE.
+       =====  ====================================
+       Bit 0  Kernel endianness. 1 if BE, 0 if LE.
+       =====  ====================================
  
  - Image size is mandatory for boot loader to load kernel image. Booting will
    fail otherwise.
index 487852fda33e959cf8d24a32d949e6fe0ad5bf92,2bae8e8ca4bcf436d6d05c08101cefeeb2955ba2..fc40e9f23c8599b3dbf384afad78257540364c49
@@@ -4,6 -4,6 +4,7 @@@ Trusted Platform Module documentatio
  
  .. toctree::
  
+    tpm_event_log
     tpm_vtpm_proxy
     xen-tpmfront
 +   tpm_ftpm_tee
diff --cc MAINTAINERS
Simple merge
Simple merge
Simple merge
Simple merge
Simple merge
Simple merge
Simple merge