Skip to content

Commit 286b7e2

Browse files
vegardJonathan Corbet
authored andcommitted
docs: path-lookup: markup fixes for emphasis
Underscores were being used for emphasis, but these are rendered verbatim in HTML output. reStructuredText uses asterisks for emphasis. I *think* I caught all of them. Signed-off-by: Vegard Nossum <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
1 parent 87b92d4 commit 286b7e2

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

Documentation/filesystems/path-lookup.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ happened to be looking at a dentry that was moved in this way,
229229
it might end up continuing the search down the wrong chain,
230230
and so miss out on part of the correct chain.
231231

232-
The name-lookup process (``d_lookup()``) does _not_ try to prevent this
232+
The name-lookup process (``d_lookup()``) does *not* try to prevent this
233233
from happening, but only to detect when it happens.
234234
``rename_lock`` is a seqlock that is updated whenever any dentry is
235235
renamed. If ``d_lookup`` finds that a rename happened while it
@@ -398,7 +398,7 @@ held.
398398
``struct qstr last``
399399
~~~~~~~~~~~~~~~~~~~~
400400

401-
This is a string together with a length (i.e. _not_ ``nul`` terminated)
401+
This is a string together with a length (i.e. *not* ``nul`` terminated)
402402
that is the "next" component in the pathname.
403403

404404
``int last_type``
@@ -720,7 +720,7 @@ against a dentry. The length and name pointer are copied into local
720720
variables, then ``read_seqcount_retry()`` is called to confirm the two
721721
are consistent, and only then is ``->d_compare()`` called. When
722722
standard filename comparison is used, ``dentry_cmp()`` is called
723-
instead. Notably it does _not_ use ``read_seqcount_retry()``, but
723+
instead. Notably it does *not* use ``read_seqcount_retry()``, but
724724
instead has a large comment explaining why the consistency guarantee
725725
isn't necessary. A subsequent ``read_seqcount_retry()`` will be
726726
sufficient to catch any problem that could occur at this point.
@@ -928,7 +928,7 @@ if anything goes wrong it is much safer to just abort and try a more
928928
sedate approach.
929929

930930
The emphasis here is "try quickly and check". It should probably be
931-
"try quickly _and carefully,_ then check". The fact that checking is
931+
"try quickly *and carefully*, then check". The fact that checking is
932932
needed is a reminder that the system is dynamic and only a limited
933933
number of things are safe at all. The most likely cause of errors in
934934
this whole process is assuming something is safe when in reality it

0 commit comments

Comments
 (0)