Commit 624ad333 authored by Linus Torvalds's avatar Linus Torvalds
Browse files

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

Pull documentation updates from Jonathan Corbet:
 "This is a relatively unexciting cycle for documentation.

   - Some small scripts/kerneldoc fixes

   - More Chinese translation work, but at a much reduced rate.

   - The tip-tree maintainer's handbook

  ...plus the usual array of build fixes, typo fixes, etc"

* tag 'docs-5.16' of git://git.lwn.net/linux: (53 commits)
  kernel-doc: support DECLARE_PHY_INTERFACE_MASK()
  docs/zh_CN: add core-api xarray translation
  docs/zh_CN: add core-api assoc_array translation
  speakup: Fix typo in documentation "boo" -> "boot"
  docs: submitting-patches: make section about the Link: tag more explicit
  docs: deprecated.rst: Clarify open-coded arithmetic with literals
  scripts: documentation-file-ref-check: fix bpf selftests path
  scripts: documentation-file-ref-check: ignore hidden files
  coding-style.rst: trivial: fix location of driver model macros
  docs: f2fs: fix text alignment
  docs/zh_CN add PCI pci.rst translation
  docs/zh_CN add PCI index.rst translation
  docs: translations: zh_CN: memory-hotplug.rst: fix a typo
  docs: translations: zn_CN: irq-affinity.rst: add a missing extension
  block: add documentation for inflight
  scripts: kernel-doc: Ignore __alloc_size() attribute
  docs: pdfdocs: Adjust \headheight for fancyhdr
  docs: UML: user_mode_linux_howto_v2 edits
  docs: use the lore redirector everywhere
  docs: proc.rst: mountinfo: align columns
  ...
parents 313b6ffc 603bdf5d

Documentation/ABI/testing/sysfs-block

+16 −0
Original line number Diff line number Diff line
@@ -28,6 +28,22 @@ Description: 
		For more details refer Documentation/admin-guide/iostats.rst





What:		/sys/block/<disk>/inflight

Date:		October 2009

Contact:	Jens Axboe <axboe@kernel.dk>, Nikanth Karthikesan <knikanth@suse.de>

Description:

		Reports the number of I/O requests currently in progress

		(pending / in flight) in a device driver. This can be less

		than the number of requests queued in the block device queue.

		The report contains 2 fields: one for read requests

		and one for write requests.

		The value type is unsigned int.

		Cf. Documentation/block/stat.rst which contains a single value for

		requests in flight.

		This is related to nr_requests in Documentation/block/queue-sysfs.rst

		and for SCSI device also its queue_depth.





What:		/sys/block/<disk>/diskseq

Date:		February 2021

Contact:	Matteo Croce <mcroce@microsoft.com>

Documentation/ABI/testing/sysfs-driver-xen-blkback

+2 −2
Original line number Diff line number Diff line
@@ -29,7 +29,7 @@ Description: 
What:           /sys/module/xen_blkback/parameters/buffer_squeeze_duration_ms

Date:           December 2019

KernelVersion:  5.6

Contact:        SeongJae Park <sjpark@amazon.de>

Contact:        SeongJae Park <sj@kernel.org>

Description:

                When memory pressure is reported to blkback this option

                controls the duration in milliseconds that blkback will not
@@ -39,7 +39,7 @@ Description: 
What:           /sys/module/xen_blkback/parameters/feature_persistent

Date:           September 2020

KernelVersion:  5.10

Contact:        SeongJae Park <sjpark@amazon.de>

Contact:        SeongJae Park <sj@kernel.org>

Description:

                Whether to enable the persistent grants feature or not.  Note

                that this option only takes effect on newly created backends.

Documentation/ABI/testing/sysfs-driver-xen-blkfront

+1 −1
Original line number Diff line number Diff line
@@ -12,7 +12,7 @@ Description: 
What:           /sys/module/xen_blkfront/parameters/feature_persistent

Date:           September 2020

KernelVersion:  5.10

Contact:        SeongJae Park <sjpark@amazon.de>

Contact:        SeongJae Park <sj@kernel.org>

Description:

                Whether to enable the persistent grants feature or not.  Note

                that this option only takes effect on newly created frontends.

Documentation/admin-guide/mm/pagemap.rst

+22 −0
Original line number Diff line number Diff line
@@ -196,6 +196,28 @@ you can go through every map in the process, find the PFNs, look those up 
in kpagecount, and tally up the number of pages that are only referenced

once.



Exceptions for Shared Memory

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



Page table entries for shared pages are cleared when the pages are zapped or

swapped out. This makes swapped out pages indistinguishable from never-allocated

ones.



In kernel space, the swap location can still be retrieved from the page cache.

However, values stored only on the normal PTE get lost irretrievably when the

page is swapped out (i.e. SOFT_DIRTY).



In user space, whether the page is present, swapped or none can be deduced with

the help of lseek and/or mincore system calls.



lseek() can differentiate between accessed pages (present or swapped out) and

holes (none/non-allocated) by specifying the SEEK_DATA flag on the file where

the pages are backed. For anonymous shared pages, the file can be found in

``/proc/pid/map_files/``.



mincore() can differentiate between pages in memory (present, including swap

cache) and out of memory (swapped out or none/non-allocated).



Other notes

===========

Documentation/admin-guide/spkguide.txt

+1 −1
Original line number Diff line number Diff line
@@ -543,7 +543,7 @@ As mentioned earlier, Speakup can either be completely compiled into the 
kernel, with the exception of the help module, or it can be compiled as

a series of modules.   When compiled as modules, Speakup will only be

able to speak some of the bootup messages if your system administrator

has configured the system to load the modules at boo time. The modules

has configured the system to load the modules at boot time. The modules

can  be loaded after the file systems have been checked and mounted, or

from an initrd.  There is a third possibility.  Speakup can be compiled

with some components built into the kernel, and others as modules.  As