diff mbox series

btrfs-progs: doc: snapshot -r and -i can be used together

Message ID 20200629111500.GA65690@hephaistos.amsuess.com (mailing list archive)
State New, archived
Headers show
Series btrfs-progs: doc: snapshot -r and -i can be used together | expand

Commit Message

chrysn June 29, 2020, 11:15 a.m. UTC
This aligns the man page with the usage output of the tool.

Signed-off-by: Christian Amsüss <chrysn@fsfe.org>
---

This confused me a bit when I first read the man page (why could a
read-only snapshot not be assigned to a qgroup), but experimentation and
looking at --help indicate that the mutual exclusivity of those options
in the man page was most likely due to an editing error when the option
was introduced.

 Documentation/btrfs-subvolume.asciidoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

chrysn Nov. 8, 2020, 3:15 a.m. UTC | #1
Hello btrfs maintainers,

On Mon, Jun 29, 2020 at 01:15:01PM +0200, chrysn wrote:
> This aligns the man page with the usage output of the tool.

this small documentation fix (also at [1] for MUAs that don't like
months-long threads) seems to have gotten lost on the list, could you
have a brief look and consider applying it?

Thanks
Christian

[1]: https://www.spinics.net/lists/linux-btrfs/msg102679.html
David Sterba Feb. 19, 2021, 7:16 p.m. UTC | #2
On Mon, Jun 29, 2020 at 01:15:00PM +0200, chrysn wrote:
> This aligns the man page with the usage output of the tool.
> 
> Signed-off-by: Christian Amsüss <chrysn@fsfe.org>
> ---
> 
> This confused me a bit when I first read the man page (why could a
> read-only snapshot not be assigned to a qgroup), but experimentation and
> looking at --help indicate that the mutual exclusivity of those options
> in the man page was most likely due to an editing error when the option
> was introduced.

Sorry for the delay, the fix is now in devel. Thanks.
diff mbox series

Patch

diff --git a/Documentation/btrfs-subvolume.asciidoc b/Documentation/btrfs-subvolume.asciidoc
index d8c414fd..89c3c263 100644
--- a/Documentation/btrfs-subvolume.asciidoc
+++ b/Documentation/btrfs-subvolume.asciidoc
@@ -207,7 +207,7 @@  rootid of the subvolume.
 -u|--uuid::::
 UUID of the subvolume.
 
-*snapshot* [-r|-i <qgroupid>] <source> <dest>|[<dest>/]<name>::
+*snapshot* [-r] [-i <qgroupid>] <source> <dest>|[<dest>/]<name>::
 Create a snapshot of the subvolume <source> with the
 name <name> in the <dest> directory.
 +