Documentation/automake.mk

   1 DOC_SOURCE = \
   2         Documentation/group-selection-method-property.txt \
   3         Documentation/_static/logo.png \
   4         Documentation/_static/overview.png \
   5         Documentation/conf.py \
   6         Documentation/index.rst \
   7         Documentation/contents.rst \
   8         Documentation/intro/index.rst \
   9         Documentation/intro/what-is-ovs.rst \
  10         Documentation/intro/why-ovs.rst \
  11         Documentation/intro/install/index.rst \
  12         Documentation/intro/install/bash-completion.rst \
  13         Documentation/intro/install/afxdp.rst \
  14         Documentation/intro/install/debian.rst \
  15         Documentation/intro/install/documentation.rst \
  16         Documentation/intro/install/distributions.rst \
  17         Documentation/intro/install/dpdk.rst \
  18         Documentation/intro/install/fedora.rst \
  19         Documentation/intro/install/general.rst \
  20         Documentation/intro/install/netbsd.rst \
  21         Documentation/intro/install/rhel.rst \
  22         Documentation/intro/install/userspace.rst \
  23         Documentation/intro/install/windows.rst \
  24         Documentation/intro/install/xenserver.rst \
  25         Documentation/tutorials/index.rst \
  26         Documentation/tutorials/faucet.rst \
  27         Documentation/tutorials/ovs-advanced.rst \
  28         Documentation/tutorials/ovs-conntrack.rst \
  29         Documentation/tutorials/ipsec.rst \
  30         Documentation/topics/index.rst \
  31         Documentation/topics/bonding.rst \
  32         Documentation/topics/idl-compound-indexes.rst \
  33         Documentation/topics/datapath.rst \
  34         Documentation/topics/design.rst \
  35         Documentation/topics/dpdk/index.rst \
  36         Documentation/topics/dpdk/bridge.rst \
  37         Documentation/topics/dpdk/jumbo-frames.rst \
  38         Documentation/topics/dpdk/memory.rst \
  39         Documentation/topics/dpdk/pdump.rst \
  40         Documentation/topics/dpdk/phy.rst \
  41         Documentation/topics/dpdk/pmd.rst \
  42         Documentation/topics/dpdk/qos.rst \
  43         Documentation/topics/dpdk/ring.rst \
  44         Documentation/topics/dpdk/vdev.rst \
  45         Documentation/topics/dpdk/vhost-user.rst \
  46         Documentation/topics/fuzzing/index.rst \
  47         Documentation/topics/fuzzing/what-is-fuzzing.rst \
  48         Documentation/topics/fuzzing/ovs-fuzzing-infrastructure.rst \
  49         Documentation/topics/fuzzing/ovs-fuzzers.rst \
  50         Documentation/topics/fuzzing/security-analysis-of-ovs-fuzzers.rst \
  51         Documentation/topics/testing.rst \
  52         Documentation/topics/integration.rst \
  53         Documentation/topics/language-bindings.rst \
  54         Documentation/topics/networking-namespaces.rst \
  55         Documentation/topics/openflow.rst \
  56         Documentation/topics/ovs-extensions.rst \
  57         Documentation/topics/ovsdb-replication.rst \
  58         Documentation/topics/porting.rst \
  59         Documentation/topics/tracing.rst \
  60         Documentation/topics/windows.rst \
  61         Documentation/howto/index.rst \
  62         Documentation/howto/dpdk.rst \
  63         Documentation/howto/ipsec.rst \
  64         Documentation/howto/kvm.rst \
  65         Documentation/howto/libvirt.rst \
  66         Documentation/howto/selinux.rst \
  67         Documentation/howto/ssl.rst \
  68         Documentation/howto/lisp.rst \
  69         Documentation/howto/qos.png \
  70         Documentation/howto/qos.rst \
  71         Documentation/howto/sflow.png \
  72         Documentation/howto/sflow.rst \
  73         Documentation/howto/tunneling.png \
  74         Documentation/howto/tunneling.rst \
  75         Documentation/howto/userspace-tunneling.rst \
  76         Documentation/howto/vlan.png \
  77         Documentation/howto/vlan.rst \
  78         Documentation/howto/vtep.rst \
  79         Documentation/ref/index.rst \
  80         Documentation/faq/index.rst \
  81         Documentation/faq/configuration.rst \
  82         Documentation/faq/contributing.rst \
  83         Documentation/faq/design.rst \
  84         Documentation/faq/general.rst \
  85         Documentation/faq/issues.rst \
  86         Documentation/faq/openflow.rst \
  87         Documentation/faq/qos.rst \
  88         Documentation/faq/releases.rst \
  89         Documentation/faq/terminology.rst \
  90         Documentation/faq/vlan.rst \
  91         Documentation/faq/vxlan.rst \
  92         Documentation/internals/index.rst \
  93         Documentation/internals/authors.rst \
  94         Documentation/internals/bugs.rst \
  95         Documentation/internals/charter.rst \
  96         Documentation/internals/committer-emeritus-status.rst \
  97         Documentation/internals/committer-grant-revocation.rst \
  98         Documentation/internals/committer-responsibilities.rst \
  99         Documentation/internals/documentation.rst \
 100         Documentation/internals/mailing-lists.rst \
 101         Documentation/internals/maintainers.rst \
 102         Documentation/internals/patchwork.rst \
 103         Documentation/internals/release-process.rst \
 104         Documentation/internals/security.rst \
 105         Documentation/internals/contributing/index.rst \
 106         Documentation/internals/contributing/backporting-patches.rst \
 107         Documentation/internals/contributing/coding-style.rst \
 108         Documentation/internals/contributing/coding-style-windows.rst \
 109         Documentation/internals/contributing/documentation-style.rst \
 110         Documentation/internals/contributing/libopenvswitch-abi.rst \
 111         Documentation/internals/contributing/submitting-patches.rst \
 112         Documentation/requirements.txt \
 113         $(addprefix Documentation/ref/,$(RST_MANPAGES) $(RST_MANPAGES_NOINST))
 114 FLAKE8_PYFILES += Documentation/conf.py
 115 EXTRA_DIST += $(DOC_SOURCE)
 116
 117 # You can set these variables from the command line.
 118 SPHINXOPTS =
 119 SPHINXSRCDIR = $(srcdir)/Documentation
 120 SPHINXBUILDDIR = $(builddir)/Documentation/_build
 121
 122 # Internal variables.
 123 ALLSPHINXOPTS = -W -n -d $(SPHINXBUILDDIR)/doctrees $(SPHINXOPTS) $(SPHINXSRCDIR)
 124
 125 sphinx_verbose = $(sphinx_verbose_@AM_V@)
 126 sphinx_verbose_ = $(sphinx_verbose_@AM_DEFAULT_V@)
 127 sphinx_verbose_0 = -q
 128
 129 if HAVE_SPHINX
 130 docs-check: $(DOC_SOURCE)
 131         $(AM_V_GEN)$(SPHINXBUILD) $(sphinx_verbose) -b html $(ALLSPHINXOPTS) $(SPHINXBUILDDIR)/html && touch $@
 132         $(AM_V_GEN)$(SPHINXBUILD) $(sphinx_verbose) -b man $(ALLSPHINXOPTS) $(SPHINXBUILDDIR)/man && touch $@
 133 ALL_LOCAL += docs-check
 134 CLEANFILES += docs-check
 135
 136 check-docs:
 137         $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(SPHINXBUILDDIR)/linkcheck
 138
 139 clean-docs:
 140         rm -rf $(SPHINXBUILDDIR)
 141         rm -f docs-check
 142 CLEAN_LOCAL += clean-docs
 143 endif
 144 .PHONY: check-docs
 145 .PHONY: clean-docs
 146 \f
 147 # Installing manpages based on rST.
 148 #
 149 # The docs-check target converts the rST files listed in RST_MANPAGES
 150 # into nroff manpages in Documentation/_build/man.  The easiest way to
 151 # get these installed by "make install" is to write our own helper
 152 # rules.
 153
 154 # rST formatted manpages under Documentation/ref.
 155 RST_MANPAGES = \
 156         ovs-test.8.rst \
 157         ovs-vlan-test.8.rst \
 158         ovsdb-server.7.rst \
 159         ovsdb.5.rst \
 160         ovsdb.7.rst
 161
 162 # rST formatted manpages that we don't want to install because they
 163 # document stuff that only works with a build tree, not with an
 164 # installed OVS.
 165 RST_MANPAGES_NOINST = ovs-sim.1.rst
 166
 167 # The GNU standards say that these variables should control
 168 # installation directories for manpages in each section.  Automake
 169 # will define them for us only if it sees that a manpage in the
 170 # appropriate section is to be installed through its built-in feature.
 171 # Since we're working independently, for best safety, we need to
 172 # define them ourselves.
 173 man1dir = $(mandir)/man1
 174 man2dir = $(mandir)/man2
 175 man3dir = $(mandir)/man3
 176 man4dir = $(mandir)/man4
 177 man5dir = $(mandir)/man5
 178 man6dir = $(mandir)/man6
 179 man7dir = $(mandir)/man7
 180 man8dir = $(mandir)/man8
 181 man9dir = $(mandir)/man9
 182
 183 # Set a shell variable for each manpage directory.
 184 set_mandirs = \
 185         man1dir='$(man1dir)' \
 186         man2dir='$(man2dir)' \
 187         man3dir='$(man3dir)' \
 188         man4dir='$(man4dir)' \
 189         man5dir='$(man5dir)' \
 190         man6dir='$(man6dir)' \
 191         man7dir='$(man7dir)' \
 192         man8dir='$(man8dir)' \
 193         man9dir='$(man9dir)'
 194
 195 # Given an $rst of "ovs-vlan-test.8.rst", sets $stem to
 196 # "ovs-vlan-test", $section to "8", and $mandir to $man8dir.
 197 extract_stem_and_section = \
 198         stem=`echo "$$rst" | sed -n 's/^\(.*\)\.\([0-9]\).rst$$/\1/p'`; \
 199         section=`echo "$$rst" | sed -n 's/^\(.*\)\.\([0-9]\).rst$$/\2/p'`; \
 200         test -n "$$section" || { echo "$$rst: cannot infer manpage section from filename" 2>&1; continue; }; \
 201         eval "mandir=\$$man$${section}dir"; \
 202         test -n "$$mandir" || { echo "unknown directory for manpage section $$section"; continue; }
 203
 204 INSTALL_DATA_LOCAL += install-man-rst
 205 if HAVE_SPHINX
 206 install-man-rst: docs-check
 207         @$(set_mandirs); \
 208         for rst in $(RST_MANPAGES) $(EXTRA_RST_MANPAGES); do \
 209             $(extract_stem_and_section); \
 210             echo " $(MKDIR_P) '$(DESTDIR)'\"$$mandir\""; \
 211             $(MKDIR_P) '$(DESTDIR)'"$$mandir"; \
 212             echo " $(INSTALL_DATA) $(SPHINXBUILDDIR)/man/$$stem.$$section '$(DESTDIR)'\"$$mandir/$$stem.$$section\""; \
 213             $(INSTALL_DATA) $(SPHINXBUILDDIR)/man/$$stem.$$section '$(DESTDIR)'"$$mandir/$$stem.$$section"; \
 214         done
 215 else
 216 install-man-rst:
 217         @:
 218 endif
 219
 220 UNINSTALL_LOCAL += uninstall-man-rst
 221 uninstall-man-rst:
 222         @$(set_mandirs); \
 223         for rst in $(RST_MANPAGES); do \
 224             $(extract_stem_and_section); \
 225             echo "rm -f '$(DESTDIR)'\"$$mandir/$$stem.$$section\""; \
 226             rm -f '$(DESTDIR)'"$$mandir/$$stem.$$section"; \
 227         done