Document the configure option to strip non-numeric characters from
the version string.
Testing done:
Build alpine packages in docker, run texinfo on the doc apk package.
Issue: https://github.com/FRRouting/frr/issues/1859
Signed-off-by: Arthur Jones <arthur.jones@riverbed.com>
Since docs are rebuilt on every make invocation, don't bother building html by
default to save a bit of time.
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
Sphinx is not designed to be run in parallel and exhibits filesystem race
conditions if it is. Disable parallel build.
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
Iron out all of the glitches with recursive Automake, 3rd-party
autogenerated Sphinx makefiles, building and installing 3 different
document formats under different targets, and handling clean.
* Implement all Automake-required targets for 3rd-party Makefiles
* Setup subdirectories for 3rd-party Makefiles
* Override implicit Automake document targets
* Clean up explicit targets for developer docs
* Move Sphinx-generated Makefile to an include file
* Update targets for debian packaging
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
Remove the various manpages & info related ignore rules so that git
clean can pick them up and delete them.
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
Unconditional automake subdirectory flag = 'man' causes manpages to
always be built regardless of target, which is undesirable for `clean`.
Remove unconditional flag and override automake targets that need to
build manpages instead.
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
- Added warning for CentOS 6 support to be limited
- Added instructions for installing sphinx27-build manually
Signed-off-by: Martin Winter <mwinter@opensourcerouting.org>
Error message for missing sphinx-build wasn't clear enough when
explaining how to change the path to the sphinx-build binary as it said
'environment variable' instead of 'make variable'
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
* New manpage: mtracebis.rst
* Makefile.am includes mtracebis.rst
* configure.ac lines removed
* Debian packaging files updated
* Fixed up manpage |seealso-programs| in the process
* Centos7 build package list updated to include systemd-devel
* New paragraph on netns vrf support in zebra manpage
Conflicts:
configure.ac
debianpkg/backports/ubuntu14.04/debian/frr.install
debianpkg/frr.install
doc/Makefile.am
doc/developer/Building_FRR_on_CentOS7.rst
doc/zebra.8.in
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
- To ease checking the Segment Routing conformity in topotest,
add json output to 'show ip ospf database segment-routing' CLI.
- Update ospfd user guide accordingly
- Update OSPF-SR documentation with supported features and interoperability
Signed-off-by: Olivier Dugeon <olivier.dugeon@orange.com>
Update the centos7 build instructions to include
data on how to build w/ systemd. This is especially
useful because we tell the user to install the frr.service
file and the frr.service file expects systemd integration
Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
BSD systems need gmake to build FRR, hence why we use $(MAKE) instead of
directly invoking make. It looks like Sphinx generated makefiles
understand this, but contain a bug where the target for info files
hardcodes make instead of using $(MAKE). Fix this.
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
Some platforms (actually just Centos6, again, of course) call
"sphinx-build" as "sphinx-1.0-build", and so to work around this
apparently useless name, fall back to sphinx-1.0-build when we can't
find sphinx-build before displaying an error message. I am not doing in
this the configure script because the sphinx makefiles are not Automake
files and the less Automake in tree the better.
Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
This commit is the implementation of weak multicast traceroute.
It consists of IGMP module dealing with mtrace type IGMP messages
and client program mtrace/mtracebis for initiating mtrace queries.
Signed-off-by: Mladen Sablic <mladen.sablic@gmail.com>
Incidentally this was all broken before anyway.
* Correctly ship all documents in frr-doc
* Ship manpages for all daemons in frr
* Update rules to build docs via Sphinx
* Use packaging install files correctly
Forgot to add a couple includes to the exclude list. Also move
defines.txt to defines.rst since I know how to properly ignore things
now.
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
Newer sphinx-build generated makefiles use an as-of-yet undocumented CLI
option that is not present in older versions.
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
Replaced stub definitions of CLI with references to their full
definitions so that Sphinx can properly cross reference them.
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
At some point the routeserver docs got lost, converted those from texi
and put them back. Also fixed some broken cli xrefs.
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>