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 <dsterba@suse.com>
This commit is contained in:
David Sterba 2022-06-13 15:24:21 +02:00
parent 4bfdd4eafd
commit ab8dbea0dd
4 changed files with 8 additions and 7 deletions

View File

@ -43,7 +43,7 @@ btrfs-progs-5.17 (2022-04-26)
profiles profiles
* preparatory work for extent tree v2, global roots * preparatory work for extent tree v2, global roots
* experimental feature (unstable interface, not built by default, * 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 * btrfstune: option --csum to switch checksum algorithm
* other: * other:
* cleanups, refactoring * cleanups, refactoring
@ -1190,6 +1190,7 @@ btrfs-progs-4.4 (2016-01-18)
* usage=min..max -- enhanced to take range * usage=min..max -- enhanced to take range
* stripes=min..max -- new, filter by stripes for raid0/10/5/6 * stripes=min..max -- new, filter by stripes for raid0/10/5/6
* limit=min..max -- enhanced to take range * limit=min..max -- enhanced to take range
Note: due to backward compatibility, the range maximum for 'usage' is not 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 . inclusive as for the others, to keep the same behaviour as usage=N .

View File

@ -28,7 +28,7 @@ Quotation in subcommands:
- argument name in option description: caps in angle brackets <NAME> - argument name in option description: caps in angle brackets <NAME>
- reference in help text: caps NAME - reference in help text: caps NAME
also possible: caps italics *NAME* - also possible: caps italics *NAME*
- command short description: - command short description:
- command name: bold **command** - command name: bold **command**

View File

@ -40,17 +40,16 @@ Official repositories
The sources of the userspace utilities can be obtained from these 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 * git://git.kernel.org/pub/scm/linux/kernel/git/kdave/btrfs-progs.git (
access http://git.kernel.org/?p=linux/kernel/git/kdave/btrfs-progs.git;a=summary)
<http://git.kernel.org/?p=linux/kernel/git/kdave/btrfs-progs.git;a=summary>`_)
-- release repository, not for development -- release repository, not for development
The **master** branch contains the latest released version and is never rebased. The **master** branch contains the latest released version and is never rebased.
Development git repositories: Development git repositories:
* git://github.com/kdave/btrfs-progs.git (`web access <https://github.com/kdave/btrfs-progs>`_) * git://github.com/kdave/btrfs-progs.git (https://github.com/kdave/btrfs-progs)
* git://gitlab.com/kdave/btrfs-progs.git (`web access <https://gitlab.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 For build dependencies and installation instructions please see
https://github.com/kdave/btrfs-progs/blob/master/INSTALL https://github.com/kdave/btrfs-progs/blob/master/INSTALL

View File

@ -53,3 +53,4 @@ Welcome to BTRFS documentation!
trouble-index trouble-index
Experimental Experimental
btrfs-ioctl btrfs-ioctl
DocConventions