btrfs-progs: docs: Fix newlines for man btrfstune
diff mbox

Message ID 20170416172002.19261-1-hans.van.kranenburg@mendix.com
State New
Headers show

Commit Message

Hans van Kranenburg April 16, 2017, 5:20 p.m. UTC
A bunch of newlines were missing, which resulted in only -S and -r to
show as option after xmlto is used to convert the documentation to a man
page.

The rest of the options would end up being appended to the explanation
of -r.

Signed-off-by: Hans van Kranenburg <hans.van.kranenburg@mendix.com>
---

By the way, I have no idea why -r was showing up in the first place, because
it also had no newline before it.

I'm no asciidoc expert, but with consistent newlines, at least for me the
resulting man page does contain all options nicely listed.

 Documentation/btrfstune.asciidoc | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

David Sterba April 19, 2017, 3:43 p.m. UTC | #1
On Sun, Apr 16, 2017 at 07:20:02PM +0200, Hans van Kranenburg wrote:
> A bunch of newlines were missing, which resulted in only -S and -r to
> show as option after xmlto is used to convert the documentation to a man
> page.
> 
> The rest of the options would end up being appended to the explanation
> of -r.
> 
> Signed-off-by: Hans van Kranenburg <hans.van.kranenburg@mendix.com>

Applied, thanks.

> ---
> 
> By the way, I have no idea why -r was showing up in the first place, because
> it also had no newline before it.
> 
> I'm no asciidoc expert, but with consistent newlines, at least for me the
> resulting man page does contain all options nicely listed.

IIRC if the :: section is one paragraph, then the newline does not need
to be there, while if there are more glued together with a +, then the
newline before next :: must be added.
--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Patch
diff mbox

diff --git a/Documentation/btrfstune.asciidoc b/Documentation/btrfstune.asciidoc
index 04295ee3..bf4f495a 100644
--- a/Documentation/btrfstune.asciidoc
+++ b/Documentation/btrfstune.asciidoc
@@ -29,11 +29,13 @@  OPTIONS
 Enable seeding on a given device. Value 1 will enable seeding, 0 will disable it. +
 A seeding filesystem is forced to be mounted read-only. A new device can be added
 to the filesystem and will capture all writes keeping the seeding device intact.
+
 -r::
 (since kernel: 3.7)
 +
 Enable extended inode refs (hardlink limit per file in a directory is 65536),
 enabled by mkfs feature 'extref'.
+
 -x::
 (since kernel: 3.10)
 +
@@ -43,17 +45,21 @@  enabled by mkfs feature 'skinny-metadata'.
 All newly created extents will use the new representation. To completely switch
 the entire filesystem, run a full balance of the metadata. Please refer to
 `btrfs-balance`(8).
+
 -n::
 (since kernel: 3.14)
 +
 Enable no-holes feature (more efficient representation of file holes), enabled
 by mkfs feature 'no-holes'.
+
 -f::
 Allow dangerous changes, e.g. clear the seeding flag or change fsid. Make sure
 that you are aware of the dangers.
+
 -u::
 Change fsid to a randomly generated UUID or continue previous fsid change
 operation in case it was interrupted.
+
 -U <UUID>::
 Change fsid to 'UUID'.
 +