Skip to contentSkip to conversation

btrfs-progs: add mount options to btrfs-mount.5

PATCH Superseded Eric Sandeen 3 participants 10 messages Jun 11, 2014 – Jun 19, 2014

Subsystems (2)
Documentation Btrfs file system
lore
Share & tools
lore

Eric Sandeen

author
#0 lore raw

PATCH 1/1 btrfs-progs: add mount options to btrfs-mount.5

This is a straight cut and paste from the util-linux mount manpage into btrfs-mount.5

It's pretty much impossible for util-linux to keep up with every filesystem out there, and Karel has more than once expressed a wish that mount options move into fs-specific manpages.

So, here we go.

The way btrfs asciidoc is generated, there's not a trivial way to have both btrfs(5) and btrfs(8) so I named it btrfs-mount(5) for now. A bit ick and I'm open to suggestions.

Signed-off-by Eric Sandeen <[email protected]>

---

Documentation/Makefile +21 -3
index 03a5cd5..95ecbf6 100644
@@ -31,13 +31,21 @@ MAN8_TXT += btrfs-replace.txt
 MAN8_TXT += btrfs-restore.txt
 MAN8_TXT += btrfs-property.txt
 
-MAN_TXT = $(MAN8_TXT)
+# Mount manpage
+MAN5_TXT += btrfs-mount.txt
+
+MAN_TXT = $(MAN8_TXT) $(MAN5_TXT)
 MAN_XML = $(patsubst %.txt,%.xml,$(MAN_TXT))
+
+DOC_MAN5 = $(patsubst %.txt,%.5,$(MAN5_TXT))
+GZ_MAN5 = $(patsubst %.txt,%.5.gz,$(MAN5_TXT))
+
 DOC_MAN8 = $(patsubst %.txt,%.8,$(MAN8_TXT))
 GZ_MAN8 = $(patsubst %.txt,%.8.gz,$(MAN8_TXT))
 
 mandir ?= $(prefix)/share/man
 man8dir = $(mandir)/man8
+man5dir = $(mandir)/man5
 
 ASCIIDOC = asciidoc
 ASCIIDOC_EXTRA =

@@ -67,25 +75,35 @@ endif
 endif
 
 all: man
-man: man8
+man: man5 man8
+man5: $(GZ_MAN5)
 man8: $(GZ_MAN8)
 
 install: install-man
 
 install-man: man
 	$(INSTALL) -d -m 755 $(DESTDIR)$(man8dir)
+	$(INSTALL) -m 644 $(GZ_MAN5) $(DESTDIR)$(man5dir)
 	$(INSTALL) -m 644 $(GZ_MAN8) $(DESTDIR)$(man8dir)
 	$(LNS) btrfs-check.8.gz $(DESTDIR)$(man8dir)
 
 clean:
-	$(QUIET_RM)$(RM) *.xml *.xml+ *.8 *.8.gz
+	$(QUIET_RM)$(RM) *.xml *.xml+ *.5 *.5.gz *.8 *.8.gz
+
+%.5.gz : %.5
+	$(QUIET_GZIP)$(GZIP) -n -c $< > $@
 
 %.8.gz : %.8
 	$(QUIET_GZIP)$(GZIP) -n -c $< > $@
 
+%.5 : %.xml 
+	$(QUIET_XMLTO)$(RM) $@ && \
+	$(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
+
 %.8 : %.xml 
 	$(QUIET_XMLTO)$(RM) $@ && \
 	$(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
+
 %.xml : %.txt asciidoc.conf
 	$(QUIET_ASCIIDOC)$(RM) [email protected][12] $@ && \
 	sed -e "s/\(<[^>]\+>\)/'\1'/g" < $< > [email protected] && \
Documentation/btrfs-mount.txt new file +186 -0

186 lines not on this page · raw message

author
#1 lore raw

PATCH v2 1/1 btrfs-progs: add mount options to btrfs-mount.5

This is a straight cut and paste from the util-linux mount manpage into btrfs-mount.5

It's pretty much impossible for util-linux to keep up with every filesystem out there, and Karel has more than once expressed a wish that mount options move into fs-specific manpages.

So, here we go.

The way btrfs asciidoc is generated, there's not a trivial way to have both btrfs(5) and btrfs(8) so I named it btrfs-mount(5) for now. A bit ick and I'm open to suggestions.

Signed-off-by Eric Sandeen <[email protected]>

---

V2: whoops, have to $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir) too...

Documentation/Makefile +22 -3
index 03a5cd5..be95fda 100644
@@ -31,13 +31,21 @@ MAN8_TXT += btrfs-replace.txt
 MAN8_TXT += btrfs-restore.txt
 MAN8_TXT += btrfs-property.txt
 
-MAN_TXT = $(MAN8_TXT)
+# Mount manpage
+MAN5_TXT += btrfs-mount.txt
+
+MAN_TXT = $(MAN8_TXT) $(MAN5_TXT)
 MAN_XML = $(patsubst %.txt,%.xml,$(MAN_TXT))
+
+DOC_MAN5 = $(patsubst %.txt,%.5,$(MAN5_TXT))
+GZ_MAN5 = $(patsubst %.txt,%.5.gz,$(MAN5_TXT))
+
 DOC_MAN8 = $(patsubst %.txt,%.8,$(MAN8_TXT))
 GZ_MAN8 = $(patsubst %.txt,%.8.gz,$(MAN8_TXT))
 
 mandir ?= $(prefix)/share/man
 man8dir = $(mandir)/man8
+man5dir = $(mandir)/man5
 
 ASCIIDOC = asciidoc
 ASCIIDOC_EXTRA =

@@ -67,25 +75,36 @@ endif
 endif
 
 all: man
-man: man8
+man: man5 man8
+man5: $(GZ_MAN5)
 man8: $(GZ_MAN8)
 
 install: install-man
 
 install-man: man
+	$(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
 	$(INSTALL) -d -m 755 $(DESTDIR)$(man8dir)
+	$(INSTALL) -m 644 $(GZ_MAN5) $(DESTDIR)$(man5dir)
 	$(INSTALL) -m 644 $(GZ_MAN8) $(DESTDIR)$(man8dir)
 	$(LNS) btrfs-check.8.gz $(DESTDIR)$(man8dir)
 
 clean:
-	$(QUIET_RM)$(RM) *.xml *.xml+ *.8 *.8.gz
+	$(QUIET_RM)$(RM) *.xml *.xml+ *.5 *.5.gz *.8 *.8.gz
+
+%.5.gz : %.5
+	$(QUIET_GZIP)$(GZIP) -n -c $< > $@
 
 %.8.gz : %.8
 	$(QUIET_GZIP)$(GZIP) -n -c $< > $@
 
+%.5 : %.xml 
+	$(QUIET_XMLTO)$(RM) $@ && \
+	$(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
+
 %.8 : %.xml 
 	$(QUIET_XMLTO)$(RM) $@ && \
 	$(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
+
 %.xml : %.txt asciidoc.conf
 	$(QUIET_ASCIIDOC)$(RM) [email protected][12] $@ && \
 	sed -e "s/\(<[^>]\+>\)/'\1'/g" < $< > [email protected] && \
Documentation/btrfs-mount.txt new file +186 -0

186 lines not on this page · raw message

#2 lore raw
Quoted 8 lines · Eric Sandeen

This is a straight cut and paste from the util-linux mount manpage into btrfs-mount.5

It's pretty much impossible for util-linux to keep up with every filesystem out there, and Karel has more than once expressed a wish that mount options move into fs-specific manpages.

Quoted 5 lines

So, here we go.

The way btrfs asciidoc is generated, there's not a trivial way to have both btrfs(5) and btrfs(8) so I named it btrfs-mount(5) for now. A bit ick and I'm open to suggestions.

So what if the mount options are generated from btrfs-mount.txt but installed under btrfs.5.gz name? If there are more section 5 manpages we can make it more generic but for now hardcoding btrfs-mount.* -> btrfs.5. sounds ok to me.

author
#3 lore raw
Quoted 11 lines · David Sterba
Quoted 10 lines · Eric Sandeen

This is a straight cut and paste from the util-linux mount manpage into btrfs-mount.5

It's pretty much impossible for util-linux to keep up with every filesystem out there, and Karel has more than once expressed a wish that mount options move into fs-specific manpages.

So, here we go.

Quoted 8 lines
Quoted 3 lines

The way btrfs asciidoc is generated, there's not a trivial way to have both btrfs(5) and btrfs(8) so I named it btrfs-mount(5) for now. A bit ick and I'm open to suggestions.

So what if the mount options are generated from btrfs-mount.txt but installed under btrfs.5.gz name? If there are more section 5 manpages we can make it more generic but for now hardcoding btrfs-mount.* -> btrfs.5. sounds ok to me.

Yeah, that seemed like kind of nasty hard-coding, but I suppose it works for now. I wanted to make it more generic, I didn't have a better idea..

-Eric

#4 lore raw
Quoted 7 lines · Eric Sandeen
Quoted 4 lines

So what if the mount options are generated from btrfs-mount.txt but installed under btrfs.5.gz name? If there are more section 5 manpages we can make it more generic but for now hardcoding btrfs-mount.* -> btrfs.5. sounds ok to me.

Yeah, that seemed like kind of nasty hard-coding, but I suppose it works for now. I wanted to make it more generic, I didn't have a better idea..

Added:

Documentation/Makefile +3 -0
@@ -85,6 +85,9 @@ install-man: man
        $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
        $(INSTALL) -d -m 755 $(DESTDIR)$(man8dir)
        $(INSTALL) -m 644 $(GZ_MAN5) $(DESTDIR)$(man5dir)
+       # the source file name of btrfs.5 clashes with section 8 page, but we
+       # want to keep the code generic
+       mv $(DESTDIR)$(man5dir)/btrfs-mount.5.gz $(DESTDIR)$(man5dir)/btrfs.5.gz
        $(INSTALL) -m 644 $(GZ_MAN8) $(DESTDIR)$(man8dir)
        $(LNS) btrfs-check.8.gz $(DESTDIR)$(man8dir)/btrfsck.8.gz

So the MAN5 code is generic, the exception is only at the installation time.

author
#5 lore raw
Quoted 23 lines · David Sterba
Quoted 7 lines · Eric Sandeen
Quoted 4 lines

So what if the mount options are generated from btrfs-mount.txt but installed under btrfs.5.gz name? If there are more section 5 manpages we can make it more generic but for now hardcoding btrfs-mount.* -> btrfs.5. sounds ok to me.

Yeah, that seemed like kind of nasty hard-coding, but I suppose it works for now. I wanted to make it more generic, I didn't have a better idea..

Added:

Documentation/Makefile +3 -0
@@ -85,6 +85,9 @@ install-man: man
        $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
        $(INSTALL) -d -m 755 $(DESTDIR)$(man8dir)
        $(INSTALL) -m 644 $(GZ_MAN5) $(DESTDIR)$(man5dir)
+       # the source file name of btrfs.5 clashes with section 8 page, but we
+       # want to keep the code generic
+       mv $(DESTDIR)$(man5dir)/btrfs-mount.5.gz $(DESTDIR)$(man5dir)/btrfs.5.gz
        $(INSTALL) -m 644 $(GZ_MAN8) $(DESTDIR)$(man8dir)
        $(LNS) btrfs-check.8.gz $(DESTDIR)$(man8dir)/btrfsck.8.gz
Quoted 2 lines

So the MAN5 code is generic, the exception is only at the installation time.

Looks good to me, thanks.

-Eric

#6 lore raw
In reply to David Sterba
Quoted 23 lines · David Sterba
Quoted 7 lines · Eric Sandeen
Quoted 4 lines

So what if the mount options are generated from btrfs-mount.txt but installed under btrfs.5.gz name? If there are more section 5 manpages we can make it more generic but for now hardcoding btrfs-mount.* -> btrfs.5. sounds ok to me.

Yeah, that seemed like kind of nasty hard-coding, but I suppose it works for now. I wanted to make it more generic, I didn't have a better idea..

Added:

Documentation/Makefile +3 -0
@@ -85,6 +85,9 @@ install-man: man
        $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
        $(INSTALL) -d -m 755 $(DESTDIR)$(man8dir)
        $(INSTALL) -m 644 $(GZ_MAN5) $(DESTDIR)$(man5dir)
+       # the source file name of btrfs.5 clashes with section 8 page, but we
+       # want to keep the code generic
+       mv $(DESTDIR)$(man5dir)/btrfs-mount.5.gz $(DESTDIR)$(man5dir)/btrfs.5.gz
        $(INSTALL) -m 644 $(GZ_MAN8) $(DESTDIR)$(man8dir)
        $(LNS) btrfs-check.8.gz $(DESTDIR)$(man8dir)/btrfsck.8.gz
Quoted 5 lines

So the MAN5 code is generic, the exception is only at the installation time. --
To unsubscribe from this list: send the line "unsubscribe linux-btrfs" in the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html

Hi David,

I think you forgot to apply the patch that adds Documentation/btrfs-mount.5.txt before you tagged integration-20140618, man5 (and consequently Documentation) can't be made without it, causing a failed build.

make: *** No rule to make target 'btrfs-mount.5.gz', needed by 'man5'. Stop.

Any chance of a quick fix and a -2 tag?

Cheers,

WorMzy

#7 lore raw
Quoted 4 lines · WorMzy Tykashi

I think you forgot to apply the patch that adds Documentation/btrfs-mount.5.txt before you tagged integration-20140618, man5 (and consequently Documentation) can't be made without it, causing a failed build.

You're right, sorry. The file was not added after a conflict with git-am and I did not check afterwards. Local build test passed. Updated integration pushed, though it's a bit reduced. The 'next' sub-branch rebase had some suspicious glitch, I need to look closer tomorrow.

#8 lore raw
Quoted 11 lines · David Sterba
Quoted 4 lines · WorMzy Tykashi

I think you forgot to apply the patch that adds Documentation/btrfs-mount.5.txt before you tagged integration-20140618, man5 (and consequently Documentation) can't be made without it, causing a failed build.

You're right, sorry. The file was not added after a conflict with git-am and I did not check afterwards. Local build test passed. Updated integration pushed, though it's a bit reduced. The 'next' sub-branch rebase had some suspicious glitch, I need to look closer tomorrow.

Thanks for the fast update. :)

Good luck battling that glitch!

Cheers,

WorMzy

#9 lore raw
Quoted 7 lines · WorMzy Tykashi
Quoted 5 lines

You're right, sorry. The file was not added after a conflict with git-am and I did not check afterwards. Local build test passed. Updated integration pushed, though it's a bit reduced. The 'next' sub-branch rebase had some suspicious glitch, I need to look closer tomorrow.

Thanks for the fast update. :)

The next branch merged via format-patch/git-am instead of rebase and did not hit any conflicts. Branch readded and integration pushed with today's tag, without other patches.