From ab8dbea0dd02db5512ac11aa0c66879c8d4eb314 Mon Sep 17 00:00:00 2001 From: David Sterba Date: Mon, 13 Jun 2022 15:24:21 +0200 Subject: [PATCH] btrfs-progs: docs: fix spinx build warnings Fix the following warnings: [SPHINX] man ../CHANGES:37: ERROR: Unexpected indentation. ../CHANGES:1183: WARNING: Block quote ends without a blank line; unexpected unindent. ./Documentation/DocConventions.rst:31: ERROR: Unexpected indentation. ./Documentation/Source-repositories.rst:2: WARNING: Duplicate explicit target name: "web access". ./Documentation/DocConventions.rst: WARNING: document isn't included in any toctree The free format of CHANGES sometimes does not align with RST so fix it so it's visually similar in both formats. Remove RST references to 'web access', URLs are parsed and rendered clickable and we don't have full reference list yet. Doc conventions have been updated to RST but not finalized so put it to TODO section. Signed-off-by: David Sterba --- CHANGES | 3 ++- Documentation/DocConventions.rst | 2 +- Documentation/Source-repositories.rst | 9 ++++----- Documentation/index.rst | 1 + 4 files changed, 8 insertions(+), 7 deletions(-) diff --git a/CHANGES b/CHANGES index 8258e7d6..015f36e1 100644 --- a/CHANGES +++ b/CHANGES @@ -43,7 +43,7 @@ btrfs-progs-5.17 (2022-04-26) profiles * preparatory work for extent tree v2, global roots * experimental feature (unstable interface, not built by default, - do not use for production): + do not use for production) * btrfstune: option --csum to switch checksum algorithm * other: * cleanups, refactoring @@ -1190,6 +1190,7 @@ btrfs-progs-4.4 (2016-01-18) * usage=min..max -- enhanced to take range * stripes=min..max -- new, filter by stripes for raid0/10/5/6 * limit=min..max -- enhanced to take range + Note: due to backward compatibility, the range maximum for 'usage' is not inclusive as for the others, to keep the same behaviour as usage=N . diff --git a/Documentation/DocConventions.rst b/Documentation/DocConventions.rst index a9a87012..a3996afd 100644 --- a/Documentation/DocConventions.rst +++ b/Documentation/DocConventions.rst @@ -28,7 +28,7 @@ Quotation in subcommands: - argument name in option description: caps in angle brackets - reference in help text: caps NAME - also possible: caps italics *NAME* + - also possible: caps italics *NAME* - command short description: - command name: bold **command** diff --git a/Documentation/Source-repositories.rst b/Documentation/Source-repositories.rst index cfed2e4c..25499480 100644 --- a/Documentation/Source-repositories.rst +++ b/Documentation/Source-repositories.rst @@ -40,17 +40,16 @@ Official repositories The sources of the userspace utilities can be obtained from these repositories: -* git://git.kernel.org/pub/scm/linux/kernel/git/kdave/btrfs-progs.git (`gitweb - access - `_) +* git://git.kernel.org/pub/scm/linux/kernel/git/kdave/btrfs-progs.git ( + http://git.kernel.org/?p=linux/kernel/git/kdave/btrfs-progs.git;a=summary) -- release repository, not for development The **master** branch contains the latest released version and is never rebased. Development git repositories: -* git://github.com/kdave/btrfs-progs.git (`web access `_) -* git://gitlab.com/kdave/btrfs-progs.git (`web access `_) +* git://github.com/kdave/btrfs-progs.git (https://github.com/kdave/btrfs-progs) +* git://gitlab.com/kdave/btrfs-progs.git (https://gitlab.com/kdave/btrfs-progs) For build dependencies and installation instructions please see https://github.com/kdave/btrfs-progs/blob/master/INSTALL diff --git a/Documentation/index.rst b/Documentation/index.rst index ca812b1b..844a2368 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -53,3 +53,4 @@ Welcome to BTRFS documentation! trouble-index Experimental btrfs-ioctl + DocConventions