matthieu/frr
1
0
Fork 0
forked from Mirror/frr
Code Pull requests Activity
frr/doc/developer/subdir.am

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

88 lines
2.4 KiB
Plaintext
Raw Normal View History

build: non-recursive doc + parallel sphinx Sphinx actually does work with a parallel build, if the doctree creation is a separate step (which the other builds will then just read unmodified.) This can be done with the "dummy" target. This also adds "-j6" to sphinx-build and adds a "--disable-doc-html" switch on ./configure to turn on/off building HTML docs separately. Also, HTML docs are now installed by "make install" to /usr/share/doc/frr/html. Signed-off-by: David Lamparter <equinox@diac24.net>
2018-08-15 22:59:31 +02:00
#
# doc/developer
#
dev_RSTFILES = \
doc/developer/bgp-typecodes.rst \
doc/developer/bgpd.rst \
doc: update subdir.am Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-08-31 19:15:14 +02:00
doc/developer/building-frr-for-alpine.rst \
doc/developer/building-frr-for-centos6.rst \
doc/developer/building-frr-for-centos7.rst \
doc/developer/building-frr-for-debian8.rst \
doc/developer/building-frr-for-debian9.rst \
doc: mv Fedora 24 docs to cover 24+ Tested these on Fedora 24 and 28, so they should be true for all versions in-between as well as Fedora 29 and all upcoming versions. Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-22 20:03:57 +01:00
doc/developer/building-frr-for-fedora.rst \
doc: add building steps for openSUSE Signed-off-by: Javier Garcia <rampxxxx@gmail.com>
2020-12-03 11:59:01 +01:00
doc/developer/building-frr-for-opensuse.rst \
doc: update subdir.am Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-08-31 19:15:14 +02:00
doc/developer/building-frr-for-freebsd10.rst \
doc/developer/building-frr-for-freebsd11.rst \
doc/developer/building-frr-for-freebsd9.rst \
doc/developer/building-frr-for-netbsd6.rst \
doc/developer/building-frr-for-netbsd7.rst \
doc/developer/building-frr-for-openbsd6.rst \
doc: move rpm build doc to dev docs ------------{ <(O.O)> }------------ Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-21 22:08:52 +01:00
doc/developer/building-frr-for-openwrt.rst \
doc: update subdir.am Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-08-31 19:15:14 +02:00
doc/developer/building-frr-for-ubuntu1404.rst \
doc/developer/building-frr-for-ubuntu1604.rst \
doc/developer/building-frr-for-ubuntu1804.rst \
doc: add dev doc for ubuntu 20.04 Add a doc for ubuntu 20 LTS; it's mainly the same as the 18 LTS doc, with a couple of extra notes. Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-05-27 14:49:36 +02:00
doc/developer/building-frr-for-ubuntu2004.rst \
doc: Add building-libyang.rst to distfiles Signed-off-by: Christian Franke <chris@opensourcerouting.org>
2018-11-01 14:03:09 +01:00
doc/developer/building-libyang.rst \
build: non-recursive doc + parallel sphinx Sphinx actually does work with a parallel build, if the doctree creation is a separate step (which the other builds will then just read unmodified.) This can be done with the "dummy" target. This also adds "-j6" to sphinx-build and adds a "--disable-doc-html" switch on ./configure to turn on/off building HTML docs separately. Also, HTML docs are now installed by "make install" to /usr/share/doc/frr/html. Signed-off-by: David Lamparter <equinox@diac24.net>
2018-08-15 22:59:31 +02:00
doc/developer/building.rst \
doc/developer/cli.rst \
doc/developer/conf.py \
doc: update release procedure docs Add a lot of detail and update some outdated stuff. Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-10-18 20:38:09 +02:00
doc/developer/frr-release-procedure.rst \
doc: initial documentation for gRPC Give the FRR users some examples of gRPC usage in scripts to let them start experimenting with the new configuration interface provided by YANG/northbound. Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2020-08-09 23:04:30 +02:00
doc/developer/grpc.rst \
build: non-recursive doc + parallel sphinx Sphinx actually does work with a parallel build, if the doctree creation is a separate step (which the other builds will then just read unmodified.) This can be done with the "dummy" target. This also adds "-j6" to sphinx-build and adds a "--disable-doc-html" switch on ./configure to turn on/off building HTML docs separately. Also, HTML docs are now installed by "make install" to /usr/share/doc/frr/html. Signed-off-by: David Lamparter <equinox@diac24.net>
2018-08-15 22:59:31 +02:00
doc/developer/hooks.rst \
doc: pull out compile instructions into snippet We're going to use this same snippet across every build doc so let's just pull it into its own include file now. Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-25 21:21:10 +01:00
doc/developer/include-compile.rst \
build: non-recursive doc + parallel sphinx Sphinx actually does work with a parallel build, if the doctree creation is a separate step (which the other builds will then just read unmodified.) This can be done with the "dummy" target. This also adds "-j6" to sphinx-build and adds a "--disable-doc-html" switch on ./configure to turn on/off building HTML docs separately. Also, HTML docs are now installed by "make install" to /usr/share/doc/frr/html. Signed-off-by: David Lamparter <equinox@diac24.net>
2018-08-15 22:59:31 +02:00
doc/developer/index.rst \
doc/developer/library.rst \
doc: add developer docs for type-safe lists Signed-off-by: David Lamparter <equinox@diac24.net>
2018-11-13 16:02:47 +01:00
doc/developer/lists.rst \
doc: add developer docs for frr_with_mutex Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2019-08-06 12:05:09 +02:00
doc/developer/locking.rst \
build: non-recursive doc + parallel sphinx Sphinx actually does work with a parallel build, if the doctree creation is a separate step (which the other builds will then just read unmodified.) This can be done with the "dummy" target. This also adds "-j6" to sphinx-build and adds a "--disable-doc-html" switch on ./configure to turn on/off building HTML docs separately. Also, HTML docs are now installed by "make install" to /usr/share/doc/frr/html. Signed-off-by: David Lamparter <equinox@diac24.net>
2018-08-15 22:59:31 +02:00
doc/developer/logging.rst \
doc: Add some basic how-to for lua Add a couple breadcrumbs to get people up and running with lua when they are trying to develop for it. Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2020-02-12 02:10:26 +01:00
doc/developer/lua.rst \
build: non-recursive doc + parallel sphinx Sphinx actually does work with a parallel build, if the doctree creation is a separate step (which the other builds will then just read unmodified.) This can be done with the "dummy" target. This also adds "-j6" to sphinx-build and adds a "--disable-doc-html" switch on ./configure to turn on/off building HTML docs separately. Also, HTML docs are now installed by "make install" to /usr/share/doc/frr/html. Signed-off-by: David Lamparter <equinox@diac24.net>
2018-08-15 22:59:31 +02:00
doc/developer/memtypes.rst \
doc/developer/modules.rst \
doc/developer/next-hop-tracking.rst \
doc/developer/ospf-api.rst \
doc/developer/ospf-sr.rst \
doc/developer/ospf.rst \
doc/developer: document new Debian packaging Signed-off-by: David Lamparter <equinox@diac24.net>
2018-10-25 22:28:49 +02:00
doc/developer/packaging-debian.rst \
doc: Fix failing `make doc` This build system bug was introduced with 9251d1f596. Signed-off-by: Juergen Werner <pogojotz@gmx.net>
2019-05-03 20:17:08 +02:00
doc/developer/packaging-redhat.rst \
doc: move rpm build doc to dev docs ------------{ <(O.O)> }------------ Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-21 22:08:52 +01:00
doc/developer/packaging.rst \
lib: RCU Please refer to doc/developer/rcu.rst for documentation. Signed-off-by: David Lamparter <equinox@diac24.net>
2017-04-03 00:51:20 +02:00
doc/developer/rcu.rst \
doc: add instructions for static linking Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2020-01-13 17:30:27 +01:00
doc/developer/static-linking.rst \
doc: move topotests docs to developers guide Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-02-05 20:22:38 +01:00
doc/developer/testing.rst \
doc/developer/topotests-snippets.rst \
doc/developer/topotests.rst \
build: non-recursive doc + parallel sphinx Sphinx actually does work with a parallel build, if the doctree creation is a separate step (which the other builds will then just read unmodified.) This can be done with the "dummy" target. This also adds "-j6" to sphinx-build and adds a "--disable-doc-html" switch on ./configure to turn on/off building HTML docs separately. Also, HTML docs are now installed by "make install" to /usr/share/doc/frr/html. Signed-off-by: David Lamparter <equinox@diac24.net>
2018-08-15 22:59:31 +02:00
doc/developer/workflow.rst \
doc/developer/zebra.rst \
# end
EXTRA_DIST += \
$(dev_RSTFILES) \
doc/developer/draft-zebra-00.ms \
doc/developer/ldpd-basic-test-setup.md \
doc: update release procedure docs Add a lot of detail and update some outdated stuff. Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-10-18 20:38:09 +02:00
doc/developer/release-announcement-template.md \
build: non-recursive doc + parallel sphinx Sphinx actually does work with a parallel build, if the doctree creation is a separate step (which the other builds will then just read unmodified.) This can be done with the "dummy" target. This also adds "-j6" to sphinx-build and adds a "--disable-doc-html" switch on ./configure to turn on/off building HTML docs separately. Also, HTML docs are now installed by "make install" to /usr/share/doc/frr/html. Signed-off-by: David Lamparter <equinox@diac24.net>
2018-08-15 22:59:31 +02:00
# end
DEVBUILD = doc/developer/_build
$(DEVBUILD)/.doctrees/environment.pickle: $(dev_RSTFILES)
#
# nothing built automatically for "all" target.
#
#
# standard targets
#
developer-info: $(DEVBUILD)/texinfo/frr.info
developer-html: $(DEVBUILD)/html/.buildinfo
developer-pdf: $(DEVBUILD)/latexpdf
#
# hook-in for clean
#
.PHONY: clean-devdocs
clean-local: clean-devdocs
clean-devdocs:
-rm -rf "$(DEVBUILD)"
Copy permalink