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

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

[Jeff Layton]

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@canb.auug.org.au>
Signed-off-by: Jeff Layton <jlayton@kernel.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

Re: [PATCH] Documentation: clean up warnings for multigrain timestamp docs

[Christian Brauner]

On Thu, 01 Aug 2024 06:51:27 -0400, Jeff Layton wrote:
> 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
> 
> 
> [...]

Applied to the mgtime branch of the vfs/vfs.git tree.
Patches in the mgtime branch should appear in linux-next soon.

Please report any outstanding bugs that were missed during review in a
new review to the original patch series allowing us to drop it.

It's encouraged to provide Acked-bys and Reviewed-bys even though the
patch has now been applied. If possible patch trailers will be updated.

Note that commit hashes shown below are subject to change due to rebase,
trailer updates or similar. If in doubt, please check the listed branch.

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/vfs/vfs.git
branch: mgtime

[1/1] Documentation: clean up warnings for multigrain timestamp docs
      https://git.kernel.org/vfs/vfs/c/d48cd6da24a9

Re: [PATCH] Documentation: clean up warnings for multigrain timestamp docs

[Christian Brauner]

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

Done, thanks!