diff options
| author | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2020-04-27 23:17:05 +0200 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2020-05-05 09:22:22 -0600 |
| commit | e6d42cb19c0367ae6b0edfc09daceaefded4cbdd (patch) | |
| tree | fa18ca4adfbd1707956f49bef3cd3b05afb79c36 /Documentation | |
| parent | e6f7df74ec1ab956430db2dcdcaf217ae5cf4ae0 (diff) | |
| download | linux-e6d42cb19c0367ae6b0edfc09daceaefded4cbdd.tar.bz2 | |
docs: filesystems: convert files.txt to ReST
- Add a SPDX header;
- Adjust document title;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add it to filesystems/index.rst.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/e31b0f6a7ee466a233dc7f9c73f53f07ebb07f0b.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/filesystems/files.rst (renamed from Documentation/filesystems/files.txt) | 15 | ||||
| -rw-r--r-- | Documentation/filesystems/index.rst | 1 |
2 files changed, 11 insertions, 5 deletions
diff --git a/Documentation/filesystems/files.txt b/Documentation/filesystems/files.rst index 46dfc6b038c3..cbf8e57376bf 100644 --- a/Documentation/filesystems/files.txt +++ b/Documentation/filesystems/files.rst @@ -1,5 +1,8 @@ +.. SPDX-License-Identifier: GPL-2.0 + +=================================== File management in the Linux kernel ------------------------------------ +=================================== This document describes how locking for files (struct file) and file descriptor table (struct files) works. @@ -34,7 +37,7 @@ appear atomic. Here are the locking rules for the fdtable structure - 1. All references to the fdtable must be done through - the files_fdtable() macro : + the files_fdtable() macro:: struct fdtable *fdt; @@ -61,7 +64,8 @@ the fdtable structure - 4. To look up the file structure given an fd, a reader must use either fcheck() or fcheck_files() APIs. These take care of barrier requirements due to lock-free lookup. - An example : + + An example:: struct file *file; @@ -77,7 +81,7 @@ the fdtable structure - of the fd (fget()/fget_light()) are lock-free, it is possible that look-up may race with the last put() operation on the file structure. This is avoided using atomic_long_inc_not_zero() - on ->f_count : + on ->f_count:: rcu_read_lock(); file = fcheck_files(files, fd); @@ -106,7 +110,8 @@ the fdtable structure - holding files->file_lock. If ->file_lock is dropped, then another thread expand the files thereby creating a new fdtable and making the earlier fdtable pointer stale. - For example : + + For example:: spin_lock(&files->file_lock); fd = locate_fd(files, file, start); diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst index 99b450260e4d..597ea3ed415b 100644 --- a/Documentation/filesystems/index.rst +++ b/Documentation/filesystems/index.rst @@ -27,6 +27,7 @@ algorithms work. devpts dnotify fiemap + files automount-support |