Commit Graph

449 Commits

Author SHA1 Message Date
Quentin Young
1f35b46a2f
Merge branch 'master' into docuser
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-03-13 12:08:38 -04:00
Arthur Jones
12cd053cd6 docs/install.texi: document --enable-numeric-version
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>
2018-03-12 09:46:05 -07:00
Quentin Young
d47ae3db4c
doc: don't build html by default
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>
2018-03-09 11:12:38 -05:00
Quentin Young
8c60fed743
doc: disable parallel build
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>
2018-03-09 11:11:04 -05:00
Quentin Young
37ba370b9e
doc: change html theme to 'default'
Looks like older versions of Sphinx switched around naming for the default
themes.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-03-07 17:17:36 -05:00
Quentin Young
edc33b2f22
doc: fix make setup
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>
2018-03-07 15:51:48 -05:00
Quentin Young
85dd0c8afa
doc: update .gitignore
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>
2018-03-07 13:59:15 -05:00
Quentin Young
e3e3afffc9
doc: sync ospf-sr docs from master
7666589034

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-03-06 10:50:30 -05:00
Quentin Young
e207a4b589
doc: prevent clean target from building manpages
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>
2018-03-06 10:33:21 -05:00
Quentin Young
e221d227e3
doc: allow env var to ovveride sphinx defaults
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-03-05 11:03:27 -05:00
Martin Winter
24a532dcc2
doc: Update Building instructions for CentOS6
- Added warning for CentOS 6 support to be limited
- Added instructions for installing sphinx27-build manually

Signed-off-by: Martin Winter <mwinter@opensourcerouting.org>
2018-03-02 01:57:43 -05:00
Quentin Young
0f2ac0c5ba
doc: s/environment/make
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>
2018-03-01 11:53:16 -05:00
Quentin Young
a975744835
Merge branch 'master' into docuser
* 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>
2018-03-01 11:10:01 -05:00
Martin Winter
3b7c7293ee
doc: Create infodir before writing to it and prefix with DESTDIR
Signed-off-by: Martin Winter <mwinter@opensourcerouting.org>
2018-03-01 10:09:52 -05:00
Olivier Dugeon
7666589034 ospfd: Add json output for Segment Routing
- 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>
2018-02-27 18:00:02 +01:00
Russ White
aa1a7fc18a
Merge pull request #1798 from donaldsharp/centos_systemd
doc: Update centos7 build to include systemd
2018-02-27 08:33:29 -05:00
Philippe Guibert
822160dbe6 doc: add vrfwnetns keyword for zebra in doc
The option to enable VRF backend is documented.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2018-02-27 11:11:24 +01:00
Donald Sharp
e062e87d7f doc: Update centos7 build to include systemd
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>
2018-02-23 10:06:04 -05:00
Quentin Young
b59555c6bf
doc: change info file name from FRR -> frr
conventions yo

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-22 12:27:12 -05:00
Quentin Young
6165030aa8
doc: fix hardcoded 'make' invocation
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>
2018-02-22 12:10:47 -05:00
Quentin Young
adaf2d624b
doc: fallback to sphinx-1.0-build
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>
2018-02-20 12:29:30 -05:00
Quentin Young
9cb4ba0a3e
debianpkg: fixup bad target names
Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
2018-02-20 09:54:00 -05:00
Mladen Sablic
4d9ad5dcd0 pimd: Multicast traceroute client and router
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>
2018-02-19 23:13:55 +01:00
Quentin Young
72a475e87c
debianpkg: update packaging for new docs
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
2018-02-16 15:44:59 -05:00
Quentin Young
6be1a07b97
Merge branch 'master' into docuser
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-15 15:02:27 -05:00
Quentin Young
3f5050125b doc: put correct pkg for Centos6 2018-02-15 10:43:30 -05:00
Quentin Young
e53d58537c doc: document CLI BNF grammar, add DFA figures
Technical details on CLI implementation.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-13 18:09:58 -05:00
Martin Winter
f53f7ac385
Merge pull request #1683 from donaldsharp/doc_debian
doc: Fix Debian 9 build instructions
2018-02-13 08:39:39 -08:00
Quentin Young
79120ae8d6
doc: add everything to makefile
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-12 13:34:41 -05:00
Quentin Young
241eff1636
doc: include manpage Makefile and conf.py in EXTRA_DIST
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-12 10:35:37 -05:00
Quentin Young
2f8c365e02
doc: change html theme, add svg logo
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-08 11:53:49 -05:00
Quentin Young
6c74945622
doc: use python 2.6 format strings
Centos 6 only has python 2.6 which requires numerical identifiers for
format strings

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-07 19:22:52 -05:00
Quentin Young
4898758807
doc: fix makefiles again
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-07 16:18:52 -05:00
Quentin Young
50cc7127cf
Merge branch 'master' into docuser 2018-02-07 15:48:37 -05:00
Quentin Young
12b7724ff8
doc: fix toctree warning in manpages
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>
2018-02-07 13:36:03 -05:00
Quentin Young
b60f68eaa8
doc: note appropriate sphinx packages in docs
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-07 12:33:31 -05:00
Quentin Young
6180f995f4
doc: replace manpages Makefile
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>
2018-02-07 12:33:13 -05:00
Quentin Young
c91e9b8f74
doc: note dependencies necessary to build docs
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-02 16:59:52 -05:00
Quentin Young
5a32c42459
doc: add logos
Branding!

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-02 16:27:00 -05:00
Quentin Young
061dd548ee
doc: fixup glossary for html build
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-02 15:24:57 -05:00
Quentin Young
9de103f0c9
doc: document documentation
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-02 15:19:04 -05:00
Quentin Young
11ab5329e0
doc: reference style cleanup
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-02 13:45:12 -05:00
Quentin Young
623333072e
doc: add glossary
Glossary of some common terms, fixes non-existing glossary definition
warnings.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-02 13:33:41 -05:00
Quentin Young
9bea107f2d
doc: fixup vnc.rst to only define commands once
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>
2018-02-02 12:52:50 -05:00
Quentin Young
6ee602cd13
doc: fixup more broken xrefs
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-02 12:19:28 -05:00
Quentin Young
9e146a818b
doc: fix more broken refs, restore routeserver.rst
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>
2018-02-01 17:38:05 -05:00
Quentin Young
0efdf0fe50
doc: clean up cross references
Format reference directives and roles to match best practices.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-01 16:33:14 -05:00
Quentin Young
013f9762db
doc: fixup some build warnings
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-01 16:10:11 -05:00
Quentin Young
7bed2c9976
doc: add targets for user & developer pdf + html
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-01 13:23:18 -05:00
Quentin Young
82b7ec1da7
*: update configure.ac, Makefiles for new manpages
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-01 11:41:37 -05:00