Commit graph

24 commits

Author SHA1 Message Date
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