[PATCH] Documentation/filesystems: fix title underline lengths in path-lookup.rst

[PATCH] Documentation/filesystems: fix title underline lengths in path-lookup.rst

[Randy Dunlap]

From: Randy Dunlap <rdunlap@infradead.org>

Fix Sphinx warnings in path-lookup.rst:

Documentation/filesystems/path-lookup.rst:347: WARNING: Title underline too short.
Documentation/filesystems/path-lookup.rst:358: WARNING: Title underline too short.
Documentation/filesystems/path-lookup.rst:369: WARNING: Title underline too short.
Documentation/filesystems/path-lookup.rst:375: WARNING: Title underline too short.
Documentation/filesystems/path-lookup.rst:384: WARNING: Title underline too short.
Documentation/filesystems/path-lookup.rst:513: WARNING: Title underline too short.
Documentation/filesystems/path-lookup.rst:532: WARNING: Title underline too short.
Documentation/filesystems/path-lookup.rst:545: WARNING: Title underline too short.
Documentation/filesystems/path-lookup.rst:701: WARNING: Title underline too short.
Documentation/filesystems/path-lookup.rst:730: WARNING: Title underline too short.
Documentation/filesystems/path-lookup.rst:777: WARNING: Title underline too short.
Documentation/filesystems/path-lookup.rst:799: WARNING: Title underline too short.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Neil, You didn't get these warnings when you built the docs?

 Documentation/filesystems/path-lookup.rst |   24 ++++++++++----------
 1 file changed, 12 insertions(+), 12 deletions(-)

--- lnx-50-rc1.orig/Documentation/filesystems/path-lookup.rst
+++ lnx-50-rc1/Documentation/filesystems/path-lookup.rst
@@ -344,7 +344,7 @@ In particular it is held while scanning
 table, and the mount point hash table.
 
 Bringing it together with ``struct nameidata``
---------------------------------------------
+----------------------------------------------
 
 .. _First edition Unix: http://minnie.tuhs.org/cgi-bin/utree.pl?file=V1/u2.s
 
@@ -355,7 +355,7 @@ converts a "name" to an "inode".  ``stru
 other fields):
 
 ``struct path path``
-~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~
 
 A ``path`` contains a ``struct vfsmount`` (which is
 embedded in a ``struct mount``) and a ``struct dentry``.  Together these
@@ -366,13 +366,13 @@ step.  A reference through ``d_lockref``
 held.
 
 ``struct qstr last``
-~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~
 
 This is a string together with a length (i.e. _not_ ``nul`` terminated)
 that is the "next" component in the pathname.
 
 ``int last_type``
-~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~
 
 This is one of ``LAST_NORM``, ``LAST_ROOT``, ``LAST_DOT``, ``LAST_DOTDOT``, or
 ``LAST_BIND``.  The ``last`` field is only valid if the type is
@@ -381,7 +381,7 @@ components of the symlink have been proc
 fairly self-explanatory.
 
 ``struct path root``
-~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~
 
 This is used to hold a reference to the effective root of the
 filesystem.  Often that reference won't be needed, so this field is
@@ -510,7 +510,7 @@ potentially interesting things about the
 to three different flags that might be set in ``dentry->d_flags``:
 
 ``DCACHE_MANAGE_TRANSIT``
-~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~
 
 If this flag has been set, then the filesystem has requested that the
 ``d_manage()`` dentry operation be called before handling any possible
@@ -529,7 +529,7 @@ filesystem, which will then give it a sp
 ``d_manage()`` by returning ``-EISDIR``.
 
 ``DCACHE_MOUNTED``
-~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~
 
 This flag is set on every dentry that is mounted on.  As Linux
 supports multiple filesystem namespaces, it is possible that the
@@ -542,7 +542,7 @@ If this flag is set, and ``d_manage()``
 and a new ``dentry`` (both with counted references).
 
 ``DCACHE_NEED_AUTOMOUNT``
-~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~
 
 If ``d_manage()`` allowed us to get this far, and ``lookup_mnt()`` didn't
 find a mount point, then this flag causes the ``d_automount()`` dentry
@@ -698,7 +698,7 @@ With that little refresher on seqlocks o
 the bigger picture of how RCU-walk uses seqlocks.
 
 ``mount_lock`` and ``nd->m_seq``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 We already met the ``mount_lock`` seqlock when REF-walk used it to
 ensure that crossing a mount point is performed safely.  RCU-walk uses
@@ -727,7 +727,7 @@ results would have been the same.  This
 at least for vfsmount structures.
 
 ``dentry->d_seq`` and ``nd->seq``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 In place of taking a count or lock on ``d_reflock``, RCU-walk samples
 the per-dentry ``d_seq`` seqlock, and stores the sequence number in the
@@ -774,7 +774,7 @@ getting a counted reference to the new d
 the old dentry which we saw in REF-walk.
 
 No ``inode->i_rwsem`` or even ``rename_lock``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 A semaphore is a fairly heavyweight lock that can only be taken when it is
 permissible to sleep.  As ``rcu_read_lock()`` forbids sleeping,
@@ -796,7 +796,7 @@ locking.  This neatly handles all cases,
 rename_lock would bring no significant value.
 
 ``unlazy walk()`` and ``complete_walk()``
--------------------------------------
+-----------------------------------------
 
 That "dropping down to REF-walk" typically involves a call to
 ``unlazy_walk()``, so named because "RCU-walk" is also sometimes

Re: [PATCH] Documentation/filesystems: fix title underline lengths in path-lookup.rst

[NeilBrown]

[-- Attachment #1: Type: text/plain, Size: 1583 bytes --]

On Sun, Jan 06 2019, Randy Dunlap wrote:

> From: Randy Dunlap <rdunlap@infradead.org>
>
> Fix Sphinx warnings in path-lookup.rst:
>
> Documentation/filesystems/path-lookup.rst:347: WARNING: Title underline too short.
> Documentation/filesystems/path-lookup.rst:358: WARNING: Title underline too short.
> Documentation/filesystems/path-lookup.rst:369: WARNING: Title underline too short.
> Documentation/filesystems/path-lookup.rst:375: WARNING: Title underline too short.
> Documentation/filesystems/path-lookup.rst:384: WARNING: Title underline too short.
> Documentation/filesystems/path-lookup.rst:513: WARNING: Title underline too short.
> Documentation/filesystems/path-lookup.rst:532: WARNING: Title underline too short.
> Documentation/filesystems/path-lookup.rst:545: WARNING: Title underline too short.
> Documentation/filesystems/path-lookup.rst:701: WARNING: Title underline too short.
> Documentation/filesystems/path-lookup.rst:730: WARNING: Title underline too short.
> Documentation/filesystems/path-lookup.rst:777: WARNING: Title underline too short.
> Documentation/filesystems/path-lookup.rst:799: WARNING: Title underline too short.
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
> Neil, You didn't get these warnings when you built the docs?

I probably did, but I didn't notice them.
I just ran "make htmldocs" and there are pages and pages of warnings.
When I look closely they do include these ones.  At the time I was more
focused on getting the output to look right.

Thanks for fixing them.
 Acked-by: NeilBrown <neilb@suse.com>

NeilBrown


[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

Re: [PATCH] Documentation/filesystems: fix title underline lengths in path-lookup.rst

[Jonathan Corbet]

On Mon, 07 Jan 2019 15:05:37 +1100
NeilBrown <neilb@suse.com> wrote:

> I probably did, but I didn't notice them.
> I just ran "make htmldocs" and there are pages and pages of warnings.
> When I look closely they do include these ones.  At the time I was more
> focused on getting the output to look right.

The warning situation is really out of hand, and has been for a long
time.  For a while I was trying to whack them (and Randy has done some),
but it needs a more focused effort.  Someday...

Meanwhile, I've applied this one, thanks.

jon