Skip to content

Commit 87b92d4

Browse files
vegardJonathan Corbet
authored andcommitted
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 <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
1 parent ad551a2 commit 87b92d4

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

Documentation/filesystems/path-lookup.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,15 +43,15 @@ characters, and "components" that are sequences of one or more
4343
non-"``/``" characters. These form two kinds of paths. Those that
4444
start with slashes are "absolute" and start from the filesystem root.
4545
The others are "relative" and start from the current directory, or
46-
from some other location specified by a file descriptor given to a
47-
"``XXXat``" system call such as `openat() <openat_>`_.
46+
from some other location specified by a file descriptor given to
47+
"``*at()``" system calls such as `openat() <openat_>`_.
4848

4949
.. _execveat: http://man7.org/linux/man-pages/man2/execveat.2.html
5050

5151
It is tempting to describe the second kind as starting with a
5252
component, but that isn't always accurate: a pathname can lack both
5353
slashes and components, it can be empty, in other words. This is
54-
generally forbidden in POSIX, but some of those "xxx``at``" system calls
54+
generally forbidden in POSIX, but some of those "``*at()``" system calls
5555
in Linux permit it when the ``AT_EMPTY_PATH`` flag is given. For
5656
example, if you have an open file descriptor on an executable file you
5757
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
655655
clearly seen in functions like ``filename_lookup()``,
656656
``filename_parentat()``, ``filename_mountpoint()``,
657657
``do_filp_open()``, and ``do_file_open_root()``. These five
658-
correspond roughly to the four ``path_``* functions we met earlier,
659-
each of which calls ``link_path_walk()``. The ``path_*`` functions are
658+
correspond roughly to the four ``path_*()`` functions we met earlier,
659+
each of which calls ``link_path_walk()``. The ``path_*()`` functions are
660660
called using different mode flags until a mode is found which works.
661661
They are first called with ``LOOKUP_RCU`` set to request "RCU-walk". If
662662
that fails with the error ``ECHILD`` they are called again with no

0 commit comments

Comments
 (0)