openkylin
/
linux
mirror of https://gitee.com/openkylin/linux.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: path-lookup: more markup fixes 

"xxx``at``" makes the `` appear verbatim in the HTML output. I've opted
for changing this into ``*at()`` to harmonise this with the use of * seen
later in the same document (and add the parentheses to clarify that this
is a system/function call).

``path_``* also makes `` appear in the HTML output, but we can fix it by
moving the * into the ``. Also add the parantheses here.

Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com>
Link: https://lore.kernel.org/r/20200727121525.28103-1-vegard.nossum@oracle.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Vegard Nossum 2020-07-27 14:15:24 +02:00 committed by Jonathan Corbet
parent ad551a21ca
commit 87b92d4b86
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Documentation/filesystems/path-lookup.rst
View File

@ -43,15 +43,15 @@ characters, and "components" that are sequences of one or more
non-"``/``" characters. These form two kinds of paths. Those that non-"``/``" characters. These form two kinds of paths. Those that
start with slashes are "absolute" and start from the filesystem root. start with slashes are "absolute" and start from the filesystem root.
The others are "relative" and start from the current directory, or The others are "relative" and start from the current directory, or
from some other location specified by a file descriptor given to a from some other location specified by a file descriptor given to
"``XXXat``" system call such as `openat() <openat_>`_. "``*at()``" system calls such as `openat() <openat_>`_.
.. _execveat: http://man7.org/linux/man-pages/man2/execveat.2.html .. _execveat: http://man7.org/linux/man-pages/man2/execveat.2.html
It is tempting to describe the second kind as starting with a It is tempting to describe the second kind as starting with a
component, but that isn't always accurate: a pathname can lack both component, but that isn't always accurate: a pathname can lack both
slashes and components, it can be empty, in other words. This is slashes and components, it can be empty, in other words. This is
generally forbidden in POSIX, but some of those "xxx``at``" system calls generally forbidden in POSIX, but some of those "``*at()``" system calls
in Linux permit it when the ``AT_EMPTY_PATH`` flag is given. For in Linux permit it when the ``AT_EMPTY_PATH`` flag is given. For
example, if you have an open file descriptor on an executable file you example, if you have an open file descriptor on an executable file you
can execute it by calling `execveat() <execveat_>`_ passing can execute it by calling `execveat() <execveat_>`_ passing
@ -655,8 +655,8 @@ This pattern of "try RCU-walk, if that fails try REF-walk" can be
clearly seen in functions like ``filename_lookup()``, clearly seen in functions like ``filename_lookup()``,
``filename_parentat()``, ``filename_mountpoint()``, ``filename_parentat()``, ``filename_mountpoint()``,
``do_filp_open()``, and ``do_file_open_root()``. These five ``do_filp_open()``, and ``do_file_open_root()``. These five
correspond roughly to the four ``path_``* functions we met earlier, correspond roughly to the four ``path_*()`` functions we met earlier,
each of which calls ``link_path_walk()``. The ``path_*`` functions are each of which calls ``link_path_walk()``. The ``path_*()`` functions are
called using different mode flags until a mode is found which works. called using different mode flags until a mode is found which works.
They are first called with ``LOOKUP_RCU`` set to request "RCU-walk". If They are first called with ``LOOKUP_RCU`` set to request "RCU-walk". If
that fails with the error ``ECHILD`` they are called again with no that fails with the error ``ECHILD`` they are called again with no