]> git.puffer.fish Git - mirror/frr.git/commitdiff
*: update configure.ac, Makefiles for new manpages
authorQuentin Young <qlyoung@cumulusnetworks.com>
Wed, 31 Jan 2018 22:31:17 +0000 (17:31 -0500)
committerQuentin Young <qlyoung@cumulusnetworks.com>
Thu, 1 Feb 2018 16:41:37 +0000 (11:41 -0500)
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
configure.ac
doc/Makefile.am
doc/manpages/.gitignore [new file with mode: 0644]
doc/manpages/Makefile [new file with mode: 0644]

index a3b38559e55fa054d5fd14fc6aa20de3ffd32a7e..0c96546c8e38039fd9d1882905dda338052530ef 100755 (executable)
@@ -1875,23 +1875,6 @@ AC_CONFIG_FILES([Makefile
          snapcraft/snapcraft.yaml
          lib/version.h
          tests/lib/cli/test_cli.refout
-         doc/defines.texi
-         doc/bgpd.8
-         doc/isisd.8
-         doc/ospf6d.8
-         doc/ospfclient.8
-         doc/ospfd.8
-         doc/ldpd.8
-         doc/ripd.8
-         doc/eigrpd.8
-         doc/ripngd.8
-         doc/pimd.8
-         doc/nhrpd.8
-         doc/vtysh.1
-         doc/watchfrr.8
-         doc/zebra.8
-         doc/frr.1
-         doc/frr-args.8
          pkgsrc/bgpd.sh pkgsrc/ospf6d.sh pkgsrc/ospfd.sh
          pkgsrc/ripd.sh pkgsrc/ripngd.sh pkgsrc/zebra.sh
          pkgsrc/eigrpd.sh])
index 7aaa36556f25da4647ba0f0ed1a8552f469d5a74..8c7efed09bccfea320dabe0e4c424bbc9d55f5e4 100644 (file)
 ## Process this file with automake to produce Makefile.in.
 
-# Dia, the version i have at least, doesn't do very good EPS output
-# (some of the text is scaled strangely). So this will work, but 
-# it is probably better to use something like gimp to convert the 
-# dia exported PNG files to EPS manually.
-#
-# Here we use 'convert' from the well known 'ImageMagick' package
-# to do conversion from png to eps/pdf for figures. 
-# PDF form is required for frr.pdf, using PDFTex at least.
-#
-# TeX implementation, which we depend on already anyway.
-#
-# dia -> (dia) -> png -> (convert) -> eps -> (epstopdf) -> pdf
-SUFFIXES = .png .eps .dia .pdf
-DIATOPNG = dia -t png -e
-DIATOEPS = dia -t eps -e
-PNGTOEPS = convert -antialias -contrast -despeckle
-PNGTOPDF = $(PNGTOEPS)
-EPSTOPDF = epstopdf
-
-VNCFIGURES_PNG = 
-VNCFIGURES_DIA = -vnc-mesh -vnc-frr-route-reflector            \
--vnc-commercial-route-reflector -vnc-redundant-route-reflectors        \
--vnc-gw -vnc-gw-rr
-
-# TODO: A target that creates an empty text file for each member of
-# VNCFIGURES_TXT
-VNCFIGURES_TXT = $(VNCFIGURES:%.png=%.txt)
-
-# The figure sources
-figures_names_parts = -normal-processing -rs-processing \
-       _topologies_full _topologies_rs \
-       $(VNCFIGURES_DIA)
-
-figures_sources = $(figures_names_parts:%=fig%.dia)
-figures_png = $(figures_names_parts:%=fig%.png) $(VNCFIGURES_PNG)
-figures_pdf = $(figures_names_parts:%=fig%.pdf) $(VNCFIGURES_PNG:%.png=%.pdf)
-figures_eps = $(figures_names_parts:%=fig%.eps) $(VNCFIGURES_PNG:%.png=%.eps)
-figures_txt = $(figures_names_parts:%=fig%.txt)
-
-# rather twisted logic because we have to build PDFs of the EPS figures for
-# PDFTex and yet build one PDF, frr.pdf, from texi source. Which means we
-# cant rely on a single automatic rule for *.pdf, eg the one automatically
-# provided by automake. If you are an automake wizard, please feel free to
-# compact it somehow.
-
-info_TEXINFOS = frr.texi
-
-# Have to manually specify the frr.pdf rule in order to allow
-# us to have a generic automatic .pdf rule to build the figure sources
-# because it cant just work from the png's directly it seems - contrary
-# to the documentation...
-frr.pdf: $(info_TEXINFOS) $(figures_pdf) $(frr_TEXINFOS) defines.texi
-       $(TEXI2PDF) -o "$@" $< || true
-
-# don't ask me why the info file is in srcdir
-$(srcdir)/frr.info: $(frr_TEXINFOS) defines.texi
-frr.dvi: $(frr_TEXINFOS) defines.texi
-frr.html: $(frr_TEXINFOS) defines.texi
-
-frr_TEXINFOS = \
-       appendix.texi \
-       basic.texi \
-       bgpd.texi \
-       isisd.texi \
-       filter.texi \
-       vnc.texi \
-       babeld.texi \
-       install.texi \
-       ipv6.texi  \
-       kernel.texi \
-       main.texi \
-       nhrpd.texi \
-       eigrpd.texi \
-       ospf6d.texi \
-       ospfd.texi \
-       overview.texi \
-       protocol.texi \
-       ripd.texi \
-       ripngd.texi \
-       routemap.texi \
-       snmp.texi \
-       vtysh.texi \
-       routeserver.texi \
-       $(figures_png) \
-       snmptrap.texi \
-       ospf_fundamentals.texi \
-       isisd.texi $(figures_txt) \
-       rpki.texi \
-       pimd.texi \
-       #END
-
-.png.eps:
-       $(PNGTOEPS) $< "$@"
-
-.png.pdf:
-       $(PNGTOPDF) $< "$@"
-
-.dia.png:
-       $(DIATOPNG) "$@" $<
-
-man_MANS = frr.1 frr-args.8
+# Tell Automake to invoke 'make' in the manpages directory with argument 'man'
+SUBDIRS = manpages
+AM_MAKEFLAGS = man
+
+MANPAGE_BUILDDIR = manpages/_build/man
+
+# Once that is done these will all exist
+man_MANS = $(MANPAGE_BUILDDIR)/frr.1
 
 if PIMD
-man_MANS += pimd.8
+man_MANS += $(MANPAGE_BUILDDIR)/pimd.8
 endif
 
 if BGPD
-man_MANS += bgpd.8
+man_MANS += $(MANPAGE_BUILDDIR)/bgpd.8
 endif
 
 if ISISD
-man_MANS += isisd.8
+man_MANS += $(MANPAGE_BUILDDIR)/isisd.8
 endif
 
 if OSPF6D
-man_MANS += ospf6d.8
+man_MANS += $(MANPAGE_BUILDDIR)/ospf6d.8
 endif
 
 if OSPFCLIENT
-man_MANS += ospfclient.8
+man_MANS += $(MANPAGE_BUILDDIR)/ospfclient.8
 endif
 
 if OSPFD
-man_MANS += ospfd.8
+man_MANS += $(MANPAGE_BUILDDIR)/ospfd.8
 endif
 
 if LDPD
-man_MANS += ldpd.8
+man_MANS += $(MANPAGE_BUILDDIR)/ldpd.8
 endif
 
 if RIPD
-man_MANS += ripd.8
+man_MANS += $(MANPAGE_BUILDDIR)/ripd.8
 endif
 
 if RIPNGD
-man_MANS += ripngd.8
+man_MANS += $(MANPAGE_BUILDDIR)/ripngd.8
 endif
 
 if NHRPD
-man_MANS += nhrpd.8
+man_MANS += $(MANPAGE_BUILDDIR)/nhrpd.8
 endif
 
 if VTYSH
-man_MANS += vtysh.1
+man_MANS += $(MANPAGE_BUILDDIR)/vtysh.1
 endif
 
 if WATCHFRR
-man_MANS += watchfrr.8
+man_MANS += $(MANPAGE_BUILDDIR)/watchfrr.8
 endif
 
 if ZEBRA
-man_MANS += zebra.8
+man_MANS += $(MANPAGE_BUILDDIR)/zebra.8
 endif
 
 if EIGRPD
-man_MANS += eigrpd.8
+man_MANS += $(MANPAGE_BUILDDIR)/eigrpd.8
 endif
 
-EXTRA_DIST = BGP-TypeCode draft-zebra-00.ms draft-zebra-00.txt \
-       \
-       bgpd.8.in \
-       isisd.8.in \
-       ospf6d.8.in \
-       ospfclient.8.in \
-       ospfd.8.in \
-       ldpd.8.in \
-       ripd.8.in \
-       ripngd.8.in \
-       pimd.8.in \
-       nhrpd.8.in \
-       vtysh.1.in \
-       watchfrr.8.in \
-       zebra.8.in \
-       frr.1.in \
-       eigrpd.8.in \
-       \
-       mpls/ChangeLog.opaque.txt mpls/cli_summary.txt \
-       mpls/opaque_lsa.txt mpls/ospfd.conf \
-       $(figures_sources) $(figures_png) $(figures_txt)
-
-draft-zebra-00.txt: draft-zebra-00.ms
-       groff -T ascii -ms $< > $@
-
-# Ensure that all of the figures are copied into the html directory
-html-local: $(HTMLS)
-       if test -d $(HTMLS) ; then \
-               cp -p $(figures_png) $(HTMLS) ; \
-       else \
-               echo "$(HTMLS) is not a directory. Make it so, the rerun make."; \
-       fi
+# handled by subdir target
+man: ;
+
+# include sources for shipped docs
+EXTRA_DIST = manpages/defines.txt \
+       manpages/ldpd.rst \
+       manpages/index.rst \
+       manpages/bgpd.rst \
+       manpages/watchfrr.rst \
+       manpages/ospfclient.rst \
+       manpages/ripd.rst \
+       manpages/zebra.rst \
+       manpages/epilogue.rst \
+       manpages/eigrpd.rst \
+       manpages/isisd.rst \
+       manpages/ospf6d.rst \
+       manpages/common-options.rst \
+       manpages/ospfd.rst \
+       manpages/vtysh.rst \
+       manpages/nhrpd.rst \
+       manpages/pimd.rst \
+       manpages/ripngd.rst \
+       manpages/frr.rst
diff --git a/doc/manpages/.gitignore b/doc/manpages/.gitignore
new file mode 100644 (file)
index 0000000..0505537
--- /dev/null
@@ -0,0 +1,3 @@
+/_templates
+/_build
+!/Makefile
diff --git a/doc/manpages/Makefile b/doc/manpages/Makefile
new file mode 100644 (file)
index 0000000..fa10577
--- /dev/null
@@ -0,0 +1,25 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = FRR
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+       @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile all check install
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+       echo "invoking: $(SPHINXBUILD) -M $@ $(SOURCEDIR) $(BUILDDIR) $(SPHINXOPTS) $(O)"
+       @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+all: ;
+check: ;
+install: ;