mbox series

[0/2] docs: Add some struct file refcounting information

Message ID 20190221190230.17985-1-corbet@lwn.net
Headers show
Series docs: Add some struct file refcounting information | expand

Message

Jonathan Corbet Feb. 21, 2019, 7:02 p.m. UTC 
Al Viro's recent "braindump" on how struct file refcounting works is too
good to lose, so let's capture it in Documentation/.  There are two changes
here:

 - Clean up the filesystem book, move stuff around, and generally try to
   create some order here.  No text changes other than some connecting
   text.

 - Bring in Al's text, with a fair amount of language tweaking and later
   corrections applied.

Hopefully this is just the beginning.

Jonathan Corbet (2):
  docs: Bring some order to filesystem documentation
  docs: Add struct file refcounting and SCM_RIGHTS mess info

 Documentation/filesystems/api-summary.rst | 150 ++++++++
 Documentation/filesystems/index.rst       | 395 ++--------------------
 Documentation/filesystems/journalling.rst | 184 ++++++++++
 Documentation/filesystems/lifecycles.rst  | 357 +++++++++++++++++++
 Documentation/filesystems/path-lookup.rst |  15 +
 Documentation/filesystems/splice.rst      |  22 ++
 6 files changed, 753 insertions(+), 370 deletions(-)
 create mode 100644 Documentation/filesystems/api-summary.rst
 create mode 100644 Documentation/filesystems/journalling.rst
 create mode 100644 Documentation/filesystems/lifecycles.rst
 create mode 100644 Documentation/filesystems/splice.rst

-- 
2.20.1

Comments

Jonathan Corbet Feb. 21, 2019, 7:06 p.m. UTC | #1 
On Thu, 21 Feb 2019 12:02:28 -0700
Jonathan Corbet <corbet@lwn.net> wrote:

> Al Viro's recent "braindump" on how struct file refcounting works is too

> good to lose, so let's capture it in Documentation/.  There are two changes

> here:

> 

>  - Clean up the filesystem book, move stuff around, and generally try to

>    create some order here.  No text changes other than some connecting

>    text.

> 

>  - Bring in Al's text, with a fair amount of language tweaking and later

>    corrections applied.

> 

> Hopefully this is just the beginning.


I meant to add that, should anybody be curious to see the formatted
version of this work, it's at:

  https://static.lwn.net/kerneldoc/filesystems/index.html

jon