btrfs-progs: remove btrfs-show-super manual page and point to inspect-internal
[platform/upstream/btrfs-progs.git] / Documentation / Makefile.in
1 # Guard against environment variables
2 MAN8_TXT =
3
4 # Top level commands
5 MAN8_TXT += btrfs.asciidoc
6 MAN8_TXT += btrfs-convert.asciidoc
7 MAN8_TXT += btrfs-find-root.asciidoc
8 MAN8_TXT += btrfs-image.asciidoc
9 MAN8_TXT += btrfs-map-logical.asciidoc
10 MAN8_TXT += btrfs-select-super.asciidoc
11 MAN8_TXT += btrfstune.asciidoc
12 MAN8_TXT += fsck.btrfs.asciidoc
13 MAN8_TXT += mkfs.btrfs.asciidoc
14
15 # Sub commands for btrfs
16 MAN8_TXT += btrfs-subvolume.asciidoc
17 MAN8_TXT += btrfs-filesystem.asciidoc
18 MAN8_TXT += btrfs-balance.asciidoc
19 MAN8_TXT += btrfs-device.asciidoc
20 MAN8_TXT += btrfs-scrub.asciidoc
21 MAN8_TXT += btrfs-check.asciidoc
22 MAN8_TXT += btrfs-rescue.asciidoc
23 MAN8_TXT += btrfs-inspect-internal.asciidoc
24 MAN8_TXT += btrfs-send.asciidoc
25 MAN8_TXT += btrfs-receive.asciidoc
26 MAN8_TXT += btrfs-quota.asciidoc
27 MAN8_TXT += btrfs-qgroup.asciidoc
28 MAN8_TXT += btrfs-replace.asciidoc
29 MAN8_TXT += btrfs-restore.asciidoc
30 MAN8_TXT += btrfs-property.asciidoc
31
32 # Category 5 manual page
33 MAN5_TXT += btrfs-man5.asciidoc
34
35 MAN_TXT = $(MAN8_TXT) $(MAN5_TXT)
36 MAN_XML = $(patsubst %.asciidoc,%.xml,$(MAN_TXT))
37 MAN_HTML = $(patsubst %.asciidoc,%.html,$(MAN_TXT))
38
39 DOC_MAN5 = $(patsubst %.asciidoc,%.5,$(MAN5_TXT))
40 GZ_MAN5 = $(patsubst %.asciidoc,%.5.gz,$(MAN5_TXT))
41
42 DOC_MAN8 = $(patsubst %.asciidoc,%.8,$(MAN8_TXT))
43 GZ_MAN8 = $(patsubst %.asciidoc,%.8.gz,$(MAN8_TXT))
44
45 mandir ?= $(prefix)/share/man
46 man8dir = $(mandir)/man8
47 man5dir = $(mandir)/man5
48
49 ASCIIDOC = @ASCIIDOC@
50 ASCIIDOC_EXTRA =
51 MANPAGE_XSL = manpage-normal.xsl
52 XMLTO = @XMLTO@
53 XMLTO_EXTRA =
54 XMLTO_EXTRA = -m manpage-bold-literal.xsl
55 GZIPCMD = @GZIP@
56 INSTALL = @INSTALL@
57 RM = @RM@
58 RMDIR = @RMDIR@
59 LN_S = @LN_S@
60 MV = @MV@
61 SED = @SED@
62 BTRFS_VERSION = $(shell $(SED) -n 's/.*PACKAGE_VERSION "\(.*\)"/\1/p'\
63                   ../config.h)
64
65 ifneq ($(findstring $(MAKEFLAGS),s),s)
66 ifndef V
67         QUIET_RM        = @
68         QUIET_ASCIIDOC  = @echo "    [ASCII]  $@";
69         QUIET_XMLTO     = @echo "    [XMLTO]  $@";
70         QUIET_GZIP      = @echo "    [GZ]     $@";
71         QUIET_STDERR    = 2> /dev/null
72         QUIET_SUBDIR0   = +@subdir=
73         QUIET_SUBDIR1   = ;$(NO_SUBDIR) echo '   ' SUBDIR $$subdir; \
74                           $(MAKE) $(PRINT_DIR) -C $$subdir
75         export V
76 endif
77 endif
78
79 all: man
80 man: man5 man8
81 man5: $(GZ_MAN5)
82 man8: $(GZ_MAN8)
83 html: $(MAN_HTML)
84
85 install: install-man
86
87 install-man: man
88         $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
89         $(INSTALL) -d -m 755 $(DESTDIR)$(man8dir)
90         $(INSTALL) -m 644 $(GZ_MAN5) $(DESTDIR)$(man5dir)
91         # the source file name of btrfs.5 clashes with section 8 page, but we
92         # want to keep the code generic
93         $(MV) $(DESTDIR)$(man5dir)/btrfs-man5.5.gz $(DESTDIR)$(man5dir)/btrfs.5.gz
94         $(INSTALL) -m 644 $(GZ_MAN8) $(DESTDIR)$(man8dir)
95         $(LN_S) -f btrfs-check.8.gz $(DESTDIR)$(man8dir)/btrfsck.8.gz
96         $(LN_S) -f btrfs-rescue.8.gz $(DESTDIR)$(man8dir)/btrfs-zero-log.8.gz
97         $(LN_S) -f btrfs-inspect-internal.8.gz $(DESTDIR)$(man8dir)/btrfs-debug-tree.8.gz
98         $(LN_S) -f btrfs-inspect-internal.8.gz $(DESTDIR)$(man8dir)/btrfs-show-super.8.gz
99
100 uninstall:
101         cd $(DESTDIR)$(man8dir); rm -f btrfs-check.8.gz $(GZ_MAN8)
102         $(RMDIR) -p --ignore-fail-on-non-empty $(DESTDIR)$(man8dir)
103
104 clean:
105         $(QUIET_RM)$(RM) -f *.xml *.xml+ *.5 *.5.gz *.8 *.8.gz *.html
106
107 %.5.gz : %.5
108         $(QUIET_GZIP)$(GZIPCMD) -n -c $< > $@
109
110 %.8.gz : %.8
111         $(QUIET_GZIP)$(GZIPCMD) -n -c $< > $@
112
113 %.5 : %.xml
114         $(QUIET_XMLTO)$(RM) -f $@ && \
115         $(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
116
117 %.8 : %.xml
118         $(QUIET_XMLTO)$(RM) -f $@ && \
119         $(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
120
121 %.xml : %.asciidoc asciidoc.conf
122         $(QUIET_ASCIIDOC)$(RM) -f $@+ $@ && \
123         $(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \
124                 $(ASCIIDOC_EXTRA) -abtrfs_version=$(BTRFS_VERSION) \
125                 -o $@+ $< && \
126         $(MV) $@+ $@
127
128 %.html : %.asciidoc asciidoc.conf
129         $(QUIET_ASCIIDOC)$(RM) -f $@+ $@ && \
130         $(ASCIIDOC) -b html -d article -f asciidoc.conf \
131                 $(ASCIIDOC_EXTRA) -abtrfs_version=$(BTRFS_VERSION) \
132                 -o $@+ $< && \
133         $(MV) $@+ $@