Commit graph

48 commits

Author SHA1 Message Date
Quentin Young 89a702415f doc: fix duplicate -S option in bgpd manpage
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-12-18 15:13:57 -05:00
Donald Sharp 11a9a23664 doc: Add cli options for bgp to documentation
Document the bgp cli options.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2019-10-16 07:42:45 -04:00
Quentin Young 5ebcbd1578 doc: remove trailing whitespace in vrrp manpage
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-05-17 00:27:08 +00:00
Quentin Young 4edac1f75f doc: add vrrpd(8)
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-05-17 00:27:08 +00:00
Quentin Young 5354eea9e2 doc: add --apiserver to ospfd manpage
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-04-22 20:22:59 +00:00
Quentin Young 749461a631 doc: exclude bfd-options.rst from toctree
This is an include file, needs to be explicitly excluded to suppress
Sphinx warnings.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-26 20:53:58 +00:00
Quentin Young f53928bf42
doc: include fabricd in see-also programs
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-12 16:42:04 -04:00
David Lamparter bd2893d57f doc: update for new daemons settings
watchfrr_enable is ignored, watchfrr_options is unneeded and the
valgrind options have been replaced with daemon_wrap/all_wrap.

Signed-off-by: David Lamparter <equinox@diac24.net>
2019-02-19 21:38:23 +01:00
Lou Berger 75082dafb5
Merge pull request #3235 from opensourcerouting/buildfoo-20181024
build: potpourri
2018-10-27 14:14:35 -04:00
David Lamparter 0437e10517 *: spelchek
Signed-off-by: David Lamparter <equinox@diac24.net>
2018-10-25 20:10:57 +02:00
David Lamparter 67cf020d17 build: make clean and dist consistent
We weren't cleaning up some files (a whole lot of python foobar) and had
some files in the dist tarball that don't quite belong there.

Signed-off-by: David Lamparter <equinox@diac24.net>
2018-10-24 18:35:15 +02:00
paco f533be73f6
bgpd, doc, ldpd, lib, tests, zebra: LM fixes
Corrections so that the BGP daemon can work with the label manager properly
through a label-manager proxy. Details:

- Correction so the BGP daemon behind a proxy label manager gets the range
  correctly (-I added to the BGP daemon, to set the daemon instance id)
- For the BGP case, added an asynchronous label manager connect command so
  the labels get recycled in case of a BGP daemon reconnection. With this,
  BGPd and LDPd would behave similarly.

Signed-off-by: F. Aragon <paco@voltanet.io>
2018-09-18 17:39:16 +02:00
David Lamparter f4f2f2ccac build: fix not building docs w/o sphinx
Can't build manpages without sphinx-build, oops...

Signed-off-by: David Lamparter <equinox@diac24.net>
2018-09-09 20:01:08 +02:00
David Lamparter 74dc19a2f5 build: move vtysh & manpage listings to subdir.am
Since we're now building through one large Makefile, we can easily put
things with their daemons and crossreference nicely.

Signed-off-by: David Lamparter <equinox@diac24.net>
2018-09-08 21:30:19 +02:00
Christian Franke f3c7b99d05 doc: add documentation for fabricd
Signed-off-by: Christian Franke <chris@opensourcerouting.org>
2018-09-05 11:41:47 +02:00
Christian Franke 7c0cbd0e88 fabricd: add new daemon as build of isisd
fabricd is built using the sources of isisd. To allow differentiation
in the code, -DFABRICD=1 is added to its preprocessor flags.

Signed-off-by: Christian Franke <chris@opensourcerouting.org>
2018-09-05 11:38:12 +02:00
David Lamparter 9e53b31551 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-30 08:06:44 +02:00
Donald Sharp 164ab8625e
Merge pull request #2874 from opensourcerouting/fix-doc-bfdd-index
doc: address multiple warnings related to bfdd's docs
2018-08-20 19:39:27 -04:00
Christian Franke 3b12dd8204 doc: bfdd manpage should be included in the manpage index
Signed-off-by: Christian Franke <chris@opensourcerouting.org>
2018-08-20 22:44:56 +02:00
Donald Sharp 1491ad1ec4 doc, debianpkg: Cleanup tcp-zebra configure options
Since we removed --enable-tcp-zebra cleanup the last
remaining vestiges of that code from the system.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-08-20 13:17:34 -04:00
Rafael Zalamena c44032c1ff bfdd: add documentation
Add BFD daemon documentation:
* commands;
* man page;
* manual / description;

Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2018-08-08 18:25:04 -03:00
Donald Sharp 614aa5c166 doc: Add some documentation for staticd
Remove the ip route specific sections from zebra documenation and
create a specific one for the new staticd.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-07-29 12:43:21 -04:00
Quentin Young da7e1a9212 doc: move -r option docs to zebra only
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-22 17:55:20 +00:00
Quentin Young 9eb51ce361 doc: fix distclean
Apparently Automake has some undocumented logic somewhere that makes it
so any Makefile generated from an Automake Makefile.am is removed from
its secret list of things to delete that it deletes when performing a
recursive distclean before actually performing the recursive distclean
and since the secret list is automatically generated from the list of
things that Autoconf should generate in configure.ac we can't remove the
Makefile from that list or it will break Automake's list of things to
automatically generate that it generates from Autoconf's list of things
to automatically generate.

Thus, to prevent Automake from deleting Makefiles and then immediately
trying to use the Makefiles it just deleted to delete said Makefiles, we
must remove ourselves from the secret list, which is accomplished by
changing the file extension to '.am' instead of '.in'.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-18 19:35:24 +00:00
Russ White 6b50b12ac7
Merge pull request #2162 from qlyoung/fix-vpath-build
doc: support VPATH builds
2018-05-12 06:23:03 -04:00
Jafar Al-Gharaibeh 3dc755e492
Merge pull request #2195 from qlyoung/docuser
doc: update doc titles
2018-05-10 10:24:06 -05:00
Quentin Young f0d96d1d32 doc: update doc titles
Should be a bit easier to Google this way.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-09 10:44:08 -04:00
Quentin Young 524ada7f23 doc: support VPATH builds
Documentation was not fully using Automake / Autoconf and therefore needs
modifications to support black magic VPATH builds.

* Convert Makefile's to Autoconf-controlled Makefile.in's
* Tweak loading of pygments lexer to handle runtime paths
* Update .gitignore's as necessary

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-02 17:15:31 -04:00
Donald Sharp a3488351b4 doc: Add some documentation for the sharp daemon
Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-04-30 15:40:54 -04:00
Mladen Sablic 71e55fb257 pimd: adding querying of state to mtrace
Adding to mtracebis querying with group address. Same change
to vtysh mtrace command. Support for querying (S,G) and (*,G)
state in mtrace router code. Further improvments to mtrace router
code with closer complience to IETF draft. More references in
comments to the draft. Man page has been updated accordingly.

Signed-off-by: Mladen Sablic <mladen.sablic@gmail.com>
2018-04-24 18:47:50 +02:00
Rafael Zalamena a6528075a8
Merge pull request #2039 from qlyoung/docuser
doc: more cleanup, config syntax highlighting
2018-04-12 18:02:22 -03:00
Quentin Young aef62d258b
doc: gracefully handle missing config.status
The docs extract various configuration values from config.status and
substitute them into placeholders throughout the docs. Add the ability
to build the docs with some reasonable defaults set instead of failing
when config.status doesn't exist.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-04-10 15:26:56 -04:00
Quentin Young 6568993b1b doc: bit of cleanup for pbr docs
* Indent is 3 spaces
* Use CLI cross-references
* Wrap to 80 columns
* Adjust section capitalization

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-04-06 13:22:43 -04:00
Donald Sharp a6c93cb20f doc: Add documentation for PBRD
Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-04-06 13:22:43 -04:00
Quentin Young a3ff031191
doc: warn users about vtysh / telnet security
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-04-03 13:53:04 -04:00
Lou Berger 5aa5df3995 manpages: vtysh.rst add description of -u/--user flags
Signed-off-by: Lou Berger <lberger@labn.net>
2018-03-28 10:56:06 -04:00
Donald Sharp 11bb005145 doc: Clean up vtysh man page
The vtysh man page was referencing eigrp.  Looked like a
cut-n-paste error?

Added some missing cli for the vtysh program, that users
might want to see.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-03-15 12:28:52 -04: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 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 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
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 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 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 82b7ec1da7
*: update configure.ac, Makefiles for new manpages
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-01 11:41:37 -05:00
Quentin Young a1e276e1d3
doc: overhaul manpages
* Remove groff manpages
* Rewrite manpages in RST
* Clean up and standardize manpage content

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-31 17:27:02 -05:00
Quentin Young 3eb7a2f08b
doc: reorganize
* Move all developer related docs into developer/
* Move all figures into their own directory
* Move manpages to own directory

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-30 16:14:24 -05:00