Skip to contentSkip to conversation

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

PATCH In review chrysn 2 participants 3 messages Jun 29, 2020 – Feb 19, 2021

Subsystems (2)
lore
Share & tools
lore

chrysn

author
#0 lore raw

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

This aligns the man page with the usage output of the tool.

---

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(-)
Documentation/btrfs-subvolume.asciidoc +1 -1
index d8c414fd..89c3c263 100644
@@ -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.
 +
Signature · 5 lines
2.27.0

-- 
We are dreamers, shapers, singers, and makers.
  -- Elric
author
#1 lore raw

Hello btrfs maintainers,

Quoted 1 line · chrysn

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

Signature · 2 lines
There's always a bigger fish.
  -- Qui-Gon Jinn
#2 lore raw
In reply to chrysn
Quoted 10 lines · chrysn

This aligns the man page with the usage output of the tool.

---

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.