mirror of
https://github.com/kdave/btrfs-progs
synced 2025-02-16 17:56:51 +00:00
btrfs-progs: docs: remove asciidoc build support
Remove asciidoc makefile support and config files. Signed-off-by: David Sterba <dsterba@suse.com>
This commit is contained in:
David Sterba
parent
541f92193a
commit
fb3fa2493c
@ -1,6 +1,5 @@
|
||||
ifeq (@DOC_TOOL@,sphinx)
|
||||
|
||||
# Source files for manual pages are listed in conf.py in variable man_pages
|
||||
# To convert: btrfs-ioctl.asciidoc
|
||||
|
||||
# You can set these variables from the command line, and also from the
|
||||
# environment for the first two.
|
||||
@ -64,140 +63,3 @@ clean:
|
||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||
%:
|
||||
$(QUIET_SPHINX)$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
||||
else
|
||||
|
||||
# Guard against environment variables
|
||||
MAN8_TXT =
|
||||
|
||||
# Top level commands
|
||||
MAN8_TXT += btrfs.asciidoc
|
||||
MAN8_TXT += btrfs-convert.asciidoc
|
||||
MAN8_TXT += btrfs-find-root.asciidoc
|
||||
MAN8_TXT += btrfs-image.asciidoc
|
||||
MAN8_TXT += btrfs-map-logical.asciidoc
|
||||
MAN8_TXT += btrfs-select-super.asciidoc
|
||||
MAN8_TXT += btrfstune.asciidoc
|
||||
MAN8_TXT += fsck.btrfs.asciidoc
|
||||
MAN8_TXT += mkfs.btrfs.asciidoc
|
||||
|
||||
# Sub commands for btrfs
|
||||
MAN8_TXT += btrfs-subvolume.asciidoc
|
||||
MAN8_TXT += btrfs-filesystem.asciidoc
|
||||
MAN8_TXT += btrfs-balance.asciidoc
|
||||
MAN8_TXT += btrfs-device.asciidoc
|
||||
MAN8_TXT += btrfs-scrub.asciidoc
|
||||
MAN8_TXT += btrfs-check.asciidoc
|
||||
MAN8_TXT += btrfs-rescue.asciidoc
|
||||
MAN8_TXT += btrfs-inspect-internal.asciidoc
|
||||
MAN8_TXT += btrfs-send.asciidoc
|
||||
MAN8_TXT += btrfs-receive.asciidoc
|
||||
MAN8_TXT += btrfs-quota.asciidoc
|
||||
MAN8_TXT += btrfs-qgroup.asciidoc
|
||||
MAN8_TXT += btrfs-replace.asciidoc
|
||||
MAN8_TXT += btrfs-restore.asciidoc
|
||||
MAN8_TXT += btrfs-property.asciidoc
|
||||
|
||||
# Category 5 manual page
|
||||
MAN5_TXT += btrfs-man5.asciidoc
|
||||
|
||||
MAN3_TXT += btrfs-ioctl.asciidoc
|
||||
|
||||
MAN_TXT = $(MAN3_TXT) $(MAN8_TXT) $(MAN5_TXT)
|
||||
MAN_XML = $(patsubst %.asciidoc,%.xml,$(MAN_TXT))
|
||||
MAN_HTML = $(patsubst %.asciidoc,%.html,$(MAN_TXT))
|
||||
MAN3 = $(patsubst %.asciidoc,%.3,$(MAN3_TXT))
|
||||
MAN5 = $(patsubst %.asciidoc,%.5,$(MAN5_TXT))
|
||||
MAN8 = $(patsubst %.asciidoc,%.8,$(MAN8_TXT))
|
||||
|
||||
mandir ?= $(prefix)/share/man
|
||||
man3dir = $(mandir)/man3
|
||||
man5dir = $(mandir)/man5
|
||||
man8dir = $(mandir)/man8
|
||||
|
||||
XMLTO = @XMLTO@
|
||||
XMLTO_EXTRA = -m manpage-bold-literal.xsl
|
||||
|
||||
ifeq (@DOC_TOOL@,asciidoc)
|
||||
ASCIIDOC = @ASCIIDOC@
|
||||
ASCIIDOC_ARGS = -abtrfs_version=$(BTRFS_VERSION) -f asciidoc.conf
|
||||
ASCIIDOC_HTML = html
|
||||
ASCIIDOC_DOCBOOK = docbook
|
||||
ASCIIDOC_DEPS = asciidoc.conf
|
||||
endif
|
||||
ifeq (@DOC_TOOL@,asciidoctor)
|
||||
ASCIIDOC = @ASCIIDOCTOR@
|
||||
ASCIIDOC_ARGS = -abtrfs_version=$(BTRFS_VERSION)
|
||||
ASCIIDOC_HTML = xhtml5
|
||||
ASCIIDOC_DOCBOOK = docbook5
|
||||
XMLTO_EXTRA += --skip-validation
|
||||
ASCIIDOC_DEPS =
|
||||
endif
|
||||
|
||||
MANPAGE_XSL = manpage-normal.xsl
|
||||
INSTALL = @INSTALL@
|
||||
RM = @RM@
|
||||
RMDIR = @RMDIR@
|
||||
LN_S = @LN_S@
|
||||
MV = @MV@
|
||||
SED = @SED@
|
||||
BTRFS_VERSION = $(shell $(SED) -n 's/.*PACKAGE_VERSION "\(.*\)"/\1/p'\
|
||||
../config.h)
|
||||
|
||||
ifneq ($(findstring $(MAKEFLAGS),s),s)
|
||||
ifndef V
|
||||
QUIET_RM = @
|
||||
QUIET_ASCIIDOC = @echo " [ASCII] $@";
|
||||
QUIET_XMLTO = @echo " [XMLTO] $@";
|
||||
endif
|
||||
endif
|
||||
|
||||
all: man
|
||||
man: man3 man5 man8
|
||||
man3: $(MAN3)
|
||||
man5: $(MAN5)
|
||||
man8: $(MAN8)
|
||||
html: $(MAN_HTML)
|
||||
|
||||
install: install-man
|
||||
|
||||
install-man: man
|
||||
$(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
|
||||
$(INSTALL) -d -m 755 $(DESTDIR)$(man8dir)
|
||||
$(INSTALL) -m 644 $(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-man5.5 $(DESTDIR)$(man5dir)/btrfs.5
|
||||
$(INSTALL) -m 644 $(MAN8) $(DESTDIR)$(man8dir)
|
||||
$(INSTALL) -m 644 btrfsck.8 $(DESTDIR)$(man8dir)
|
||||
|
||||
uninstall:
|
||||
cd $(DESTDIR)$(man8dir); rm -f btrfs-check.8 $(MAN8)
|
||||
$(RMDIR) -p --ignore-fail-on-non-empty $(DESTDIR)$(man8dir)
|
||||
|
||||
clean:
|
||||
$(QUIET_RM)$(RM) -f $(MAN_XML) *.xml+ $(MAN3) $(MAN5) $(MAN8) $(MAN_HTML)
|
||||
|
||||
%.3 : %.xml
|
||||
$(QUIET_XMLTO)$(RM) -f $@ && \
|
||||
$(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
|
||||
|
||||
%.5 : %.xml
|
||||
$(QUIET_XMLTO)$(RM) -f $@ && \
|
||||
$(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
|
||||
|
||||
%.8 : %.xml
|
||||
$(QUIET_XMLTO)$(RM) -f $@ && \
|
||||
$(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
|
||||
|
||||
%.xml : %.asciidoc $(ASCIIDOC_DEPS)
|
||||
$(QUIET_ASCIIDOC)$(RM) -f $@+ $@ && \
|
||||
$(ASCIIDOC) $(ASCIIDOC_ARGS) -b $(ASCIIDOC_DOCBOOK) -d manpage -o $@+ $< && \
|
||||
$(MV) $@+ $@
|
||||
|
||||
%.html : %.asciidoc $(ASCIIDOC_DEPS)
|
||||
$(QUIET_ASCIIDOC)$(RM) -f $@+ $@ && \
|
||||
$(ASCIIDOC) $(ASCIIDOC_ARGS) -b $(ASCIIDOC_HTML) -d article -o $@+ $< && \
|
||||
$(MV) $@+ $@
|
||||
|
||||
endif
|
||||
|
||||
@ -1,59 +0,0 @@
|
||||
## linkbtrfs: macro
|
||||
#
|
||||
# Usage: linkbtrfs:command[manpage-section]
|
||||
#
|
||||
# Note, {0} is the manpage section, while {target} is the command.
|
||||
#
|
||||
# Show Btrfslink as: <command>(<section>); if section is defined, else just show
|
||||
# the command.
|
||||
|
||||
[macros]
|
||||
(?su)[\\]?(?P<name>linkbtrfs):(?P<target>\S*?)\[(?P<attrlist>.*?)\]=
|
||||
|
||||
[tags]
|
||||
bracket-emphasis={1?[{1}]}<emphasis><|></emphasis>
|
||||
|
||||
[quotes]
|
||||
<|>=#bracket-emphasis
|
||||
|
||||
[attributes]
|
||||
asterisk=*
|
||||
plus=+
|
||||
caret=^
|
||||
startsb=[
|
||||
endsb=]
|
||||
backslash=\
|
||||
tilde=~
|
||||
apostrophe='
|
||||
backtick=`
|
||||
litdd=--
|
||||
|
||||
ifdef::doctype-manpage[]
|
||||
|
||||
[quotes]
|
||||
^=#exponent
|
||||
|
||||
[tags]
|
||||
exponent={1?[{1}]}^|
|
||||
|
||||
endif::doctype-manpage[]
|
||||
|
||||
ifdef::doctype-manpage[]
|
||||
ifdef::backend-docbook[]
|
||||
[header]
|
||||
template::[header-declarations]
|
||||
<refentry>
|
||||
<refmeta>
|
||||
<refentrytitle>{mantitle}</refentrytitle>
|
||||
<manvolnum>{manvolnum}</manvolnum>
|
||||
<refmiscinfo class="source">Btrfs</refmiscinfo>
|
||||
<refmiscinfo class="version">{btrfs_version}</refmiscinfo>
|
||||
<refmiscinfo class="manual">Btrfs Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>{manname}</refname>
|
||||
<refpurpose>{manpurpose}</refpurpose>
|
||||
</refnamediv>
|
||||
endif::backend-docbook[]
|
||||
endif::doctype-manpage[]
|
||||
|
||||
@ -1,35 +0,0 @@
|
||||
<!-- manpage-base.xsl:
|
||||
special formatting for manpages rendered from asciidoc+docbook -->
|
||||
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
|
||||
version="1.0">
|
||||
|
||||
<!-- these params silence some output from xmlto -->
|
||||
<xsl:param name="man.output.quietly" select="1"/>
|
||||
<xsl:param name="refentry.meta.get.quietly" select="1"/>
|
||||
|
||||
<!-- convert asciidoc callouts to man page format;
|
||||
git.docbook.backslash and git.docbook.dot params
|
||||
must be supplied by another XSL file or other means -->
|
||||
<xsl:template match="co">
|
||||
<xsl:value-of select="concat(
|
||||
$git.docbook.backslash,'fB(',
|
||||
substring-after(@id,'-'),')',
|
||||
$git.docbook.backslash,'fR')"/>
|
||||
</xsl:template>
|
||||
<xsl:template match="calloutlist">
|
||||
<xsl:value-of select="$git.docbook.dot"/>
|
||||
<xsl:text>sp </xsl:text>
|
||||
<xsl:apply-templates/>
|
||||
<xsl:text> </xsl:text>
|
||||
</xsl:template>
|
||||
<xsl:template match="callout">
|
||||
<xsl:value-of select="concat(
|
||||
$git.docbook.backslash,'fB',
|
||||
substring-after(@arearefs,'-'),
|
||||
'. ',$git.docbook.backslash,'fR')"/>
|
||||
<xsl:apply-templates/>
|
||||
<xsl:value-of select="$git.docbook.dot"/>
|
||||
<xsl:text>br </xsl:text>
|
||||
</xsl:template>
|
||||
|
||||
</xsl:stylesheet>
|
||||
@ -1,17 +0,0 @@
|
||||
<!-- manpage-bold-literal.xsl:
|
||||
special formatting for manpages rendered from asciidoc+docbook -->
|
||||
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
|
||||
version="1.0">
|
||||
|
||||
<!-- render literal text as bold (instead of plain or monospace);
|
||||
this makes literal text easier to distinguish in manpages
|
||||
viewed on a tty -->
|
||||
<xsl:template match="literal">
|
||||
<xsl:value-of select="$git.docbook.backslash"/>
|
||||
<xsl:text>fB</xsl:text>
|
||||
<xsl:apply-templates/>
|
||||
<xsl:value-of select="$git.docbook.backslash"/>
|
||||
<xsl:text>fR</xsl:text>
|
||||
</xsl:template>
|
||||
|
||||
</xsl:stylesheet>
|
||||
@ -1,13 +0,0 @@
|
||||
<!-- manpage-normal.xsl:
|
||||
special settings for manpages rendered from asciidoc+docbook
|
||||
handles anything we want to keep away from docbook-xsl 1.72.0 -->
|
||||
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
|
||||
version="1.0">
|
||||
|
||||
<xsl:import href="manpage-base.xsl"/>
|
||||
|
||||
<!-- these are the normal values for the roff control characters -->
|
||||
<xsl:param name="git.docbook.backslash">\</xsl:param>
|
||||
<xsl:param name="git.docbook.dot" >.</xsl:param>
|
||||
|
||||
</xsl:stylesheet>
|
||||
Loading…
Reference in New Issue
Block a user