btrfs-progs: doc: link btrfsck to btrfs-check
[platform/upstream/btrfs-progs.git] / Documentation / Makefile
1 # Guard against environment variables
2 MAN8_TXT =
3
4 # Top level commands
5 MAN8_TXT += btrfs.txt
6 MAN8_TXT += btrfs-convert.txt
7 MAN8_TXT += btrfs-debug-tree.txt
8 MAN8_TXT += btrfs-find-root.txt
9 MAN8_TXT += btrfs-image.txt
10 MAN8_TXT += btrfs-map-logical.txt
11 MAN8_TXT += btrfs-show-super.txt
12 MAN8_TXT += btrfstune.txt
13 MAN8_TXT += btrfs-zero-log.txt
14 MAN8_TXT += fsck.btrfs.txt
15 MAN8_TXT += mkfs.btrfs.txt
16
17 # Sub commands for btrfs
18 MAN8_TXT += btrfs-subvolume.txt
19 MAN8_TXT += btrfs-filesystem.txt
20 MAN8_TXT += btrfs-balance.txt
21 MAN8_TXT += btrfs-device.txt
22 MAN8_TXT += btrfs-scrub.txt
23 MAN8_TXT += btrfs-check.txt
24 MAN8_TXT += btrfs-rescue.txt
25 MAN8_TXT += btrfs-inspect-internal.txt
26 MAN8_TXT += btrfs-send.txt
27 MAN8_TXT += btrfs-receive.txt
28 MAN8_TXT += btrfs-quota.txt
29 MAN8_TXT += btrfs-qgroup.txt
30 MAN8_TXT += btrfs-replace.txt
31 MAN8_TXT += btrfs-restore.txt
32 MAN8_TXT += btrfs-property.txt
33
34 MAN_TXT = $(MAN8_TXT)
35 MAN_XML = $(patsubst %.txt,%.xml,$(MAN_TXT))
36 DOC_MAN8 = $(patsubst %.txt,%.8,$(MAN8_TXT))
37 GZ_MAN8 = $(patsubst %.txt,%.8.gz,$(MAN8_TXT))
38
39 mandir ?= $(prefix)/share/man
40 man8dir = $(mandir)/man8
41
42 ASCIIDOC = asciidoc
43 ASCIIDOC_EXTRA =
44 MANPAGE_XSL = manpage-normal.xsl
45 XMLTO = xmlto
46 XMLTO_EXTRA =
47 XMLTO_EXTRA = -m manpage-bold-literal.xsl
48 GZIP = gzip
49 INSTALL ?= install
50 RM ?= rm -f
51 LNS ?= ln -sf
52 BTRFS_VERSION = $(shell sed -n 's/.*BTRFS_BUILD_VERSION "Btrfs \(.*\)"/\1/p'\
53                   ../version.h)
54
55 ifneq ($(findstring $(MAKEFLAGS),s),s)
56 ifndef V
57         QUIET_ASCIIDOC  = @echo '   ' ASCIIDOC $@;
58         QUIET_XMLTO     = @echo '   ' XMLTO $@;
59         QUIET_GZIP      = @echo '   ' GZIP $@;
60         QUIET_STDERR    = 2> /dev/null
61         QUIET_SUBDIR0   = +@subdir=
62         QUIET_SUBDIR1   = ;$(NO_SUBDIR) echo '   ' SUBDIR $$subdir; \
63                           $(MAKE) $(PRINT_DIR) -C $$subdir
64         export V
65 endif
66 endif
67
68 all: man
69 man: man8
70 man8: $(GZ_MAN8)
71
72 install: install-man
73
74 install-man: man
75         $(INSTALL) -d -m 755 $(DESTDIR)$(man8dir)
76         $(INSTALL) -m 644 $(GZ_MAN8) $(DESTDIR)$(man8dir)
77         $(LNS) btrfs-check.8.gz $(DESTDIR)$(man8dir)
78
79 clean:
80         $(RM) *.xml *.xml+ *.8 *.8.gz
81
82 %.8.gz : %.8
83         $(QUIET_GZIP)$(GZIP) -n -c $< > $@
84
85 %.8 : %.xml 
86         $(QUIET_XMLTO)$(RM) $@ && \
87         $(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
88
89 %.xml : %.txt asciidoc.conf
90         $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
91         $(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \
92                 $(ASCIIDOC_EXTRA) -abtrfs_version=$(BTRFS_VERSION) \
93                 -o $@+ $< && \
94         mv $@+ $@