linux-kernel - [PATCH] Documentation: clean up warnings for multigrain timestamp docs

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-ID: <20240801105127.25048-1-jlayton@kernel.org>
Date: Thu,  1 Aug 2024 06:51:27 -0400
From: Jeff Layton <jlayton@...nel.org>
To: brauner@...nel.org
Cc: sfr@...b.auug.org.au,
	linux-fsdevel@...r.kernel.org,
	linux-kernel@...r.kernel.org
Subject: [PATCH] Documentation: clean up warnings for multigrain timestamp docs

Stephen Rothwell reported seeing a couple of warnings when building
htmldocs:

/home/jlayton/git/linux/Documentation/filesystems/multigrain-ts.rst:83: WARNING: duplicate label filesystems/multigrain-ts:multigrain timestamps, other instance in /home/jlayton/git/linux/Documentation/filesystems/multigrain-ts.rst
/home/jlayton/git/linux/Documentation/filesystems/multigrain-ts.rst: WARNING: document isn't included in any toctree

Reported-by: Stephen Rothwell <sfr@...b.auug.org.au>
Signed-off-by: Jeff Layton <jlayton@...nel.org>
---
 Documentation/filesystems/index.rst         | 1 +
 Documentation/filesystems/multigrain-ts.rst | 4 ++--
 2 files changed, 3 insertions(+), 2 deletions(-)

Christian,

It may be best to fold this patch into f9cb86069bad (Documentation: add a
new file documenting multigrain timestamps)

diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst
index e8e496d23e1d..44e9e77ffe0d 100644
--- a/Documentation/filesystems/index.rst
+++ b/Documentation/filesystems/index.rst
@@ -29,6 +29,7 @@ algorithms work.
    fiemap
    files
    locks
+   multigrain-ts
    mount_api
    quota
    seq_file
diff --git a/Documentation/filesystems/multigrain-ts.rst b/Documentation/filesystems/multigrain-ts.rst
index f58c14c53b0f..97877ab3d933 100644
--- a/Documentation/filesystems/multigrain-ts.rst
+++ b/Documentation/filesystems/multigrain-ts.rst
@@ -79,8 +79,8 @@ is no such guarantee, and the second file may appear to have been modified
 before, after or at the same time as the first, regardless of which one was
 submitted first.
 
-Multigrain Timestamps
-=====================
+Multigrain Timestamp Implementation
+===================================
 Multigrain timestamps are aimed at ensuring that changes to a single file are
 always recognizable, without violating the ordering guarantees when multiple
 different files are modified. This affects the mtime and the ctime, but the
-- 
2.45.2