Commit Graph

620 Commits

Author SHA1 Message Date
Lou Berger
ec446a4673
Merge pull request #2449 from donaldsharp/lib_delayed_read
Lib delayed read
2018-06-22 13:13:05 -04:00
Russ White
418a4330c6
Merge pull request #2415 from qlyoung/pbr-table-range
PBR table range configuration + misc cleanups
2018-06-20 07:55:56 -04:00
Mladen Sablic
f93128c139 doc: added parameters to two PIM commands
ip igmp join and mtrace have parameters which were missing from
the command spec.

Signed-off-by: Mladen Sablic <mladen.sablic@gmail.com>
2018-06-20 11:48:15 +02:00
Donald Sharp
3cf3e018a9 doc: Add --log-level documentation
Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-06-19 09:06:37 -04:00
Donald Sharp
ed74ddf403 doc: Add some documentation for cli logging
Add some basic documentation for the new cli added to all daemons.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-06-19 08:43:59 -04:00
Quentin Young
b682099337 doc: update workflow.rst
* Rewrap lines to 80 characters
* Update some portions to reflect current practices
* Clean up some formatting (indent, markup, etc)
* Reorganize sections on patch submission
* Remove link to nonexistent github wiki page

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-06-15 18:38:38 +00:00
MasterofJOKers
3f4f5b0437 doc: Correct wiki URL in workflow-documentation
The organization on github is called "FRRouting".

Signed-off-by: MasterofJOKers <joker@someserver.de>
2018-06-14 09:33:32 +02:00
Quentin Young
2e7c93acec doc: document pbr table range & a couple others
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-06-12 20:27:38 +00:00
Jafar Al-Gharaibeh
ef3428731e
Merge pull request #2379 from qlyoung/docuser
Improve introductory user docs
2018-06-12 11:04:26 -05:00
Jafar Al-Gharaibeh
e6731bccbe
Merge pull request #2384 from qlyoung/docs-bgp-update
doc: massive cleanup of bgp.rst
2018-06-12 10:57:36 -05:00
Quentin Young
aa9eafa4fc doc: cleanup community list docs more
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-06-08 09:39:27 +00:00
Quentin Young
8421b1401d doc: move find command docs to better spot
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-06-08 07:55:55 +00:00
Quentin Young
bab676248b doc: remove :caption: from toctree
Older versions of Sphinx don't support toctree captions, so we can't use
them yet unfortunately.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-06-08 07:54:25 +00:00
Quentin Young
aa996117d2 doc: update EXTRA_DIST
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-06-08 07:54:25 +00:00
Quentin Young
2da6ccc392 doc: clean up introductory user docs
* Update the list of protocol daemons from 5 to the current 13
* Rewrap and clean up formatting for lots of miscellaneous code blocks
* Improve English in various spots
* Update architecture description and diagram
* Remove duplicate information on reporting bugs

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-06-08 07:54:25 +00:00
Quentin Young
db910447b8 doc: reorganize into multiple toctrees
Use multiple toctrees to reorganize the user docs into logical sections.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-06-08 07:54:25 +00:00
Quentin Young
8fcedbd2d4 doc: massive cleanup of bgp.rst
This doc needed (and still needs) a lot of love.

* Reorganize doc into logical sections
* Clean up lots of grammatical mistakes and misspellings
* Clean up lots of bad formatting
* Remove non-existent configuration options and commands
* Mark deprecated configuration options as deprecated
* Fix all cross-references to follow a standard format
* Fix capitalization on section and subsection titles
* Fix section and subsection level underlines

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-06-07 22:35:52 +00:00
Quentin Young
4c54343ffb doc: add docs on | actions, find command
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-06-06 19:51:34 +00:00
Quentin Young
a86dc99646
Merge pull request #2376 from mjstapp/doc_link
doc: fix broken link to 'code formatting' section
2018-06-05 17:30:07 -04:00
Mark Stapp
c964e51136 doc: fix broken link to 'code formatting' section
Mismatch in rst source was producing a dead link in the html output

Signed-off-by: Mark Stapp <mjs@voltanet.io>
2018-06-05 15:32:07 -04:00
Lou Berger
ba89f1597a
Merge pull request #2367 from qlyoung/docuser
doc: document 'show cli graph'
2018-06-05 12:09:41 -04:00
Lou Berger
480e99c6c1
Merge pull request #2351 from donaldsharp/bgp_deprecation
Bgp deprecation
2018-06-05 12:05:39 -04:00
Lou Berger
6a296ecb8b
Merge pull request #2344 from pguibert6WIND/bgp_vrf_usecase
doc: add BGP VRF use case
2018-06-05 12:02:45 -04:00
Donald Sharp
0bc39980a9
Merge pull request #2366 from msablic/pim_doc
doc: expanded PIM doc. w/ missing commands
2018-06-05 07:41:31 -04:00
Mladen Sablic
14916095ee doc: expanded PIM doc. w/ missing commands
PIM documantation was missing commands relevant to PIM protocol
that were documented in COMMANDS file of pimd directory.

Signed-off-by: Mladen Sablic <mladen.sablic@gmail.com>
2018-06-05 10:10:50 +02:00
Quentin Young
8957c78a9e doc: document 'show cli graph'
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-06-04 20:20:31 +00:00
Renato Westphal
401c174473 doc: list RFCs supported by ldpd in overview.rst
This is only a minor step in the direction of actually writing
documentation for ldpd...

Signed-off-by: Renato Westphal <renato@opensourcerouting.org>
2018-06-02 22:36:10 -03:00
Donald Sharp
ad0b64d18d bgpd: Note deprecation in documentation
Note that these commands:

bgp config-type cisco
no bgp multiple-instance

are now deprecated and will be removed in a future version of FRR.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-06-01 15:15:30 -04:00
Quentin Young
65757481f0
Merge pull request #2329 from pguibert6WIND/issue_2275_proposal
doc: inform the diff between config from zebra and outside
2018-06-01 12:39:20 -04:00
Philippe Guibert
d66a93dd93 doc: replace 'intact' keyword with something more clear
Keeping the config intact might be misunderstood. I say that even if VRF
netns is automatically discovered, it is possible for administrator to
save the netns information in the config file, to bring more clarity (
hence the config commands available).

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2018-06-01 13:18:35 +02:00
Philippe Guibert
4d25da4f1e doc: inform the diff between config from zebra and outside
To avoid some confusions, it is precised in the documentation that
the configuration not done from zebra will not be injected in the
configuration context. As consequence, the config file will not be
impacted by underlying network context. But also, this will not be
possible for *Zebra* to attempt to modify outside networking objects.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2018-06-01 13:18:31 +02:00
Martin Winter
ef319aa3d7
Merge pull request #2324 from qlyoung/docuser
doc: cleanup sharp.rst
2018-06-01 03:01:09 +02:00
Philippe Guibert
a35947d06b doc: add BGP VRF use case
This commit brings some information about BGP VRF case with peering
using multiple VRF instances.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2018-05-30 15:15:25 +02:00
Quentin Young
20b35e468d doc: cleanup sharp.rst
The user doc index was not displaying correctly because of some syntax
errors in sharp.rst

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-29 21:08:03 +00:00
Quentin Young
44ee1b20c0 *: remove update-autotools
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-24 22:45:49 +00:00
Rafael Zalamena
2312209c8f
Merge pull request #2254 from qlyoung/fixup-vtysh-comments
misc cleanup for comments + docs
2018-05-23 14:00:15 -03:00
Quentin Young
ac40b262ef doc: remove duplicated packages from dep list
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-23 15:35:41 +00:00
Quentin Young
79871dbfcf doc: make frr a system group
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-22 21:46:08 +00:00
Quentin Young
07c40b22af doc: add install-info build dependency
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-22 21:46:02 +00:00
Quentin Young
d60d744157 doc: remove recommendation against integrated conf
Missed this in code review

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-22 21:14:00 +00:00
Quentin Young
f448f9145f doc: clean up 18.04 build doc
Some excess underlines, 4-space indents and typos cleaned up.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-22 21:14:00 +00: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
Renato Westphal
b16c827adf
Merge pull request #2262 from donaldsharp/v6_replace_semantics
V6 replace semantics
2018-05-22 09:05:06 -03:00
Rafael Zalamena
a44ed5bd8c
Merge pull request #2260 from qlyoung/fix-docs-distclean
doc: fix distclean
2018-05-19 22:30:18 -03:00
Donald Sharp
4354d381a6 doc: Add --v6-rr-semantics option to zebra doc
Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-05-18 15:46:56 -04:00
Quentin Young
037089f83b doc: add missing file to Makefile.am
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-18 19:44:58 +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
4ae3a2de37
Merge pull request #2252 from donaldsharp/instance_rm_match
Instance routemap match
2018-05-18 02:41:23 -04:00
Donald Sharp
af21c68244 doc: Add some doc for source-instance
Add the documentation for match source-instance.
I also noticed that 'match source-protocol' was missing
add that in too.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-05-17 11:05:08 -04:00
Quentin Young
3a7177f0fe doc: remove notes about ipv6 packages
Kernel 2.2 was released in 1999, I'm pretty sure everybody has it by
now. Plus these links don't even exist anymore.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-16 20:24:19 +00:00