doc/Makefile.am

   1 ## Process this file with automake to produce Makefile.in.
   2
   3 # Pass down make invocation to each subdirectory.
   4 #
   5 # Each of these directories contains a Sphinx-generated Makefile that has been
   6 # modified to implement all the targets required by Automake, as documented in
   7 # the 'Third-Party Makefiles' section of the Automake docs.
   8 #
   9 # Note the absence of the 'developer' directory here; development docs are
  10 # never built as part of a regular build. They are only built when explicitly
  11 # asked for. See comment further down.
  12
  13 # Sphinx is not designed to be invoked multiple times against the same toctree.
  14 .NOTPARALLEL:
  15
  16 SUBDIRS = manpages user
  17 AM_MAKEFLAGS = DESTDIR=${DESTDIR} infodir=${infodir}
  18
  19 MANPAGE_BUILDDIR = manpages/_build/man
  20
  21 # This is a hack, see comment further down.
  22 man_MANS = $(MANPAGE_BUILDDIR)/frr.1
  23
  24 if PIMD
  25 man_MANS += $(MANPAGE_BUILDDIR)/pimd.8
  26 man_MANS += $(MANPAGE_BUILDDIR)/mtracebis.8
  27 endif
  28
  29 if PBRD
  30 man_MANS += $(MANPAGE_BUILDDIR)/pbrd.8
  31 endif
  32
  33 if BGPD
  34 man_MANS += $(MANPAGE_BUILDDIR)/bgpd.8
  35 endif
  36
  37 if ISISD
  38 man_MANS += $(MANPAGE_BUILDDIR)/isisd.8
  39 endif
  40
  41 if OSPF6D
  42 man_MANS += $(MANPAGE_BUILDDIR)/ospf6d.8
  43 endif
  44
  45 if OSPFCLIENT
  46 man_MANS += $(MANPAGE_BUILDDIR)/ospfclient.8
  47 endif
  48
  49 if OSPFD
  50 man_MANS += $(MANPAGE_BUILDDIR)/ospfd.8
  51 endif
  52
  53 if LDPD
  54 man_MANS += $(MANPAGE_BUILDDIR)/ldpd.8
  55 endif
  56
  57 if RIPD
  58 man_MANS += $(MANPAGE_BUILDDIR)/ripd.8
  59 endif
  60
  61 if RIPNGD
  62 man_MANS += $(MANPAGE_BUILDDIR)/ripngd.8
  63 endif
  64
  65 if NHRPD
  66 man_MANS += $(MANPAGE_BUILDDIR)/nhrpd.8
  67 endif
  68
  69 if VTYSH
  70 man_MANS += $(MANPAGE_BUILDDIR)/vtysh.1
  71 endif
  72
  73 if WATCHFRR
  74 man_MANS += $(MANPAGE_BUILDDIR)/watchfrr.8
  75 endif
  76
  77 if ZEBRA
  78 man_MANS += $(MANPAGE_BUILDDIR)/zebra.8
  79 endif
  80
  81 if EIGRPD
  82 man_MANS += $(MANPAGE_BUILDDIR)/eigrpd.8
  83 endif
  84
  85 if SHARPD
  86 man_MANS += $(MANPAGE_BUILDDIR)/sharpd.8
  87 endif
  88
  89 if STATICD
  90 man_MANS += $(MANPAGE_BUILDDIR)/staticd.8
  91 endif
  92
  93 if BFDD
  94 man_MANS += $(MANPAGE_BUILDDIR)/bfdd.8
  95 endif
  96
  97 # Automake is particular about manpages. It is aware of them and has some
  98 # special facilities for handling them, but it assumes that manpages are always
  99 # given in groff source and so these facilities are limited to simply
 100 # specifying the path to the groff sources in a special variable. There is no
 101 # target for building manpages that can be extended, as there are for pdf,
 102 # html, dvi, etc. Unfortunately this leaves us with hijacking the
 103 # 'install-data' and 'all' targets in the 3rd-party Makefile in manpages/ to
 104 # make sure manpages are always built, and then using the special Automake
 105 # variable defined above in order to take advantage of automatic installation.
 106 #
 107 # However, it is conceivable that someone may want to build just the manpages,
 108 # so here's an explicit target for that.
 109 man:
 110         $(MAKE) -C manpages man
 111
 112 # Automake automatically defines targets for various document formats. All of
 113 # the child 3rd-party Makefiles are aware of all Automake targets and implement
 114 # the ones we are interested in.
 115 #
 116 # The SUBDIRS variable at the top of this Makefile.am causes the following
 117 # implicit Automake targets to only build user documentation, and not developer
 118 # documentation:
 119 # - info
 120 # - html
 121 # - pdf
 122 #
 123 # If you wish to build developer documentation, use these targets:
 124 developer-info:
 125         $(MAKE) -C developer info
 126
 127 developer-pdf:
 128         $(MAKE) -C developer latexpdf
 129
 130 developer-html:
 131         $(MAKE) -C developer html
 132
 133 # If you want to build the developer's docs in other formats, try the
 134 # following:
 135 #
 136 # $ cd developer
 137 # $ make help
 138
 139 # dist tarballs want doc sources
 140 EXTRA_DIST = frr-sphinx.mk \
 141         manpages/bgpd.rst \
 142         manpages/common-options.rst \
 143         manpages/conf.py \
 144         manpages/defines.rst \
 145         manpages/eigrpd.rst \
 146         manpages/epilogue.rst \
 147         manpages/frr.rst \
 148         manpages/index.rst \
 149         manpages/isisd.rst \
 150         manpages/ldpd.rst \
 151         manpages/Makefile.am \
 152         manpages/mtracebis.rst \
 153         manpages/nhrpd.rst \
 154         manpages/ospf6d.rst \
 155         manpages/ospfclient.rst \
 156         manpages/ospfd.rst \
 157         manpages/pimd.rst \
 158         manpages/ripd.rst \
 159         manpages/pbrd.rst \
 160         manpages/ripngd.rst \
 161         manpages/sharpd.rst \
 162         manpages/staticd.rst \
 163         manpages/vtysh.rst \
 164         manpages/watchfrr.rst \
 165         manpages/zebra.rst \
 166         manpages/bfdd.rst \
 167         manpages/bfd-options.rst \
 168         developer/bgpd.rst \
 169         developer/bgp-typecodes.rst \
 170         developer/building-frr-on-alpine.rst \
 171         developer/building-frr-on-centos6.rst \
 172         developer/building-frr-on-centos7.rst \
 173         developer/building-frr-on-debian8.rst \
 174         developer/building-frr-on-debian9.rst \
 175         developer/building-frr-on-fedora24.rst \
 176         developer/building-frr-on-freebsd10.rst \
 177         developer/building-frr-on-freebsd11.rst \
 178         developer/building-frr-on-freebsd9.rst \
 179         developer/building-frr-on-lede-openwrt.rst \
 180         developer/building-frr-on-netbsd6.rst \
 181         developer/building-frr-on-netbsd7.rst \
 182         developer/building-frr-on-omnios.rst \
 183         developer/building-frr-on-openbsd6.rst \
 184         developer/building-frr-on-ubuntu1204.rst \
 185         developer/building-frr-on-ubuntu1404.rst \
 186         developer/building-frr-on-ubuntu1604.rst \
 187         developer/building-frr-on-ubuntu1804.rst \
 188         developer/building.rst \
 189         developer/cli.rst \
 190         developer/conf.py \
 191         developer/draft-zebra-00.ms \
 192         developer/hooks.rst \
 193         developer/index.rst \
 194         developer/ldpd-basic-test-setup.md \
 195         developer/library.rst \
 196         developer/Makefile.in \
 197         developer/maintainer-release-build.rst \
 198         developer/memtypes.rst \
 199         developer/modules.rst \
 200         developer/next-hop-tracking.rst \
 201         developer/ospf-api.rst \
 202         developer/ospf.rst \
 203         developer/ospf-sr.rst \
 204         developer/workflow.rst \
 205         developer/zebra.rst \
 206         user/babeld.rst \
 207         user/ldpd.rst \
 208         user/basic.rst \
 209         user/bgp.rst \
 210         user/bugs.rst \
 211         user/conf.py \
 212         user/eigrpd.rst \
 213         user/filter.rst \
 214         user/glossary.rst \
 215         user/index.rst \
 216         user/installation.rst \
 217         user/ipv6.rst \
 218         user/isisd.rst \
 219         user/kernel.rst \
 220         user/Makefile.am \
 221         user/nhrpd.rst \
 222         user/ospf6d.rst \
 223         user/ospfd.rst \
 224         user/ospf_fundamentals.rst \
 225         user/overview.rst \
 226         user/packet-dumps.rst \
 227         user/pim.rst \
 228         user/ripd.rst \
 229         user/pbr.rst \
 230         user/ripngd.rst \
 231         user/routemap.rst \
 232         user/routeserver.rst \
 233         user/rpki.rst \
 234         user/setup.rst \
 235         user/sharp.rst \
 236         user/snmp.rst \
 237         user/snmptrap.rst \
 238         user/static.rst \
 239         user/Useful_Sysctl_Settings.md \
 240         user/vnc.rst \
 241         user/vtysh.rst \
 242         user/zebra.rst \
 243         user/bfd.rst \
 244         user/flowspec.rst \
 245         mpls/ChangeLog.opaque.txt \
 246         mpls/ospfd.conf \
 247         mpls/cli_summary.txt \
 248         mpls/opaque_lsa.txt \
 249         figures/cligraph.png \
 250         figures/cligraph.svg \
 251         figures/fig-normal-processing.dia \
 252         figures/fig-normal-processing.png \
 253         figures/fig-normal-processing.txt \
 254         figures/fig-rs-processing.dia \
 255         figures/fig-rs-processing.png \
 256         figures/fig-rs-processing.txt \
 257         figures/fig_topologies_full.dia \
 258         figures/fig_topologies_full.png \
 259         figures/fig_topologies_full.txt \
 260         figures/fig_topologies_rs.dia \
 261         figures/fig_topologies_rs.png \
 262         figures/fig_topologies_rs.txt \
 263         figures/fig-vnc-commercial-route-reflector.dia \
 264         figures/fig-vnc-commercial-route-reflector.png \
 265         figures/fig-vnc-commercial-route-reflector.txt \
 266         figures/fig-vnc-frr-route-reflector.dia \
 267         figures/fig-vnc-frr-route-reflector.png \
 268         figures/fig-vnc-frr-route-reflector.txt \
 269         figures/fig-vnc-gw.dia \
 270         figures/fig-vnc-gw.png \
 271         figures/fig-vnc-gw-rr.dia \
 272         figures/fig-vnc-gw-rr.png \
 273         figures/fig-vnc-gw-rr.txt \
 274         figures/fig-vnc-gw.txt \
 275         figures/fig-vnc-mesh.dia \
 276         figures/fig-vnc-mesh.png \
 277         figures/fig-vnc-mesh.txt \
 278         figures/fig-vnc-redundant-route-reflectors.dia \
 279         figures/fig-vnc-redundant-route-reflectors.png \
 280         figures/fig-vnc-redundant-route-reflectors.txt \
 281         figures/frr-icon.svg \
 282         figures/frr-logo-icon.png \
 283         figures/frr-logo-medium.png \
 284         figures/frr-logo.png \
 285         figures/frr-logo-small.png \
 286         figures/git_branches.png \
 287         figures/git_branches.svg \
 288         figures/ospf_api_architecture.png \
 289         figures/ospf_api_msghdr.png \
 290         figures/ospf_api_msgs1.png \
 291         figures/ospf_api_msgs2.png \
 292         extra/frrlexer.py