summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2018-08-25Merge pull request #2910 from opensourcerouting/doc-summerclean-20180825Donald Sharp
protocol vs. OS docs + SMUX leftovers
2018-08-25doc/user: drop SMUX reference, rework introDavid Lamparter
Signed-off-by: David Lamparter <equinox@diac24.net>
2018-08-25doc/user: add protocols vs. platform tableDavid Lamparter
A nicely-formatted colorful table of all our daemons and target OS'. Based off & intended to replace / extend https://github.com/FRRouting/frr/wiki/Features-and-Kernel-Support Signed-off-by: David Lamparter <equinox@diac24.net>
2018-08-24Merge pull request #2685 from ↵Quentin Young
netravnen/feature/bgpd/documen-use-of-additional-bgp-well-known-communities Document bgp well-known communities in PR2684
2018-08-24doc: Add documentation for IANA well-known communitiesChristoffer
Coded as part of #2684 and most code written while participating at BornHack@2018. bgp.rst: Explain what the communities does and a summarized edition of the communities purpose. Signed-off-by: Christoffer <netravnen@gmail.com>
2018-08-24Merge pull request #2891 from opensourcerouting/logging-docsQuentin Young
doc/developer: logging guide
2018-08-24doc, lib, zebra: Remove deprecated encode and decode functionalityDonald Sharp
The ZEBRA_IPV4_ROUTE_[ADD|DELETE] and ZEBRA_IPV6_ROUTE_[ADD|DELETE] functionality has been deprecated for a year now, let's remove this code from the system. Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-08-23lib: Remove smux option for snmpDonald Sharp
The smux.c code has not been able to compile for 2+ years and no-one has noticed. Additionally net-snmp has marked smux integration as deprecated for quite some time as well. Since no-one has noticed and it's been broken and smux integration is deprecated let's just remove this from the code base. From looking at the code, it sure looks like SNMP could use a decent cleanup. Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-08-22doc/developer: logging guideDavid Lamparter
This roughly outlines when to use which logging function. It's certainly something to have to point people to, so they get things nice and right - and so we get at least somewhat consistent behaviour for the user. Signed-off-by: David Lamparter <equinox@diac24.net>
2018-08-20Merge pull request #2874 from opensourcerouting/fix-doc-bfdd-indexDonald Sharp
doc: address multiple warnings related to bfdd's docs
2018-08-20bfdd: fix documentation warningsRafael Zalamena
* Extend dashes on 'OSPF BFD Configuration' title; * Add JSON output code indentation; Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2018-08-20doc: bfdd manpage should be included in the manpage indexChristian Franke
Signed-off-by: Christian Franke <chris@opensourcerouting.org>
2018-08-20doc, debianpkg: Cleanup tcp-zebra configure optionsDonald Sharp
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-16Merge pull request #2856 from opensourcerouting/bfd-workDonald Sharp
bfdd: bug fixes and improvements
2018-08-16Merge pull request #2448 from qlyoung/error-reference-cardsDavid Lamparter
Error Reference Cards
2018-08-15bfdd: improve docsRafael Zalamena
Improvements: * Show command line as code, to avoid confusion about single dash (`-`) and double dash; * Tell the user where the BGP BFD commands can be found; * Document OSPF/OSPF6/PIM BFD commands; * Document JSON commands; * Tell about session counters; Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2018-08-15Merge pull request #2843 from LabNConsulting/working/lb/doc-soloDonald Sharp
bgpd: document how to avoid reflecting advertised information back to originator
2018-08-14user: document neighbor ... solo configLou Berger
Signed-off-by: Lou Berger <lberger@labn.net>
2018-08-14doc: Add missing flowspec.rst to distribution tar fileMartin Winter
Signed-off-by: Martin Winter <mwinter@opensourcerouting.org>
2018-08-14Merge pull request #2805 from opensourcerouting/malloc-sizeQuentin Young
lib: track total memory per MTYPE if possible
2018-08-14Merge branch 'master' into bfd-finalDonald Sharp
2018-08-11doc: Add missing flowspec.rst to distribution tar fileMartin Winter
Signed-off-by: Martin Winter <mwinter@opensourcerouting.org>
2018-08-09doc: add "show memory" user documentationDavid Lamparter
Signed-off-by: David Lamparter <equinox@diac24.net>
2018-08-08bfdd: add documentationRafael Zalamena
Add BFD daemon documentation: * commands; * man page; * manual / description; Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2018-08-08Merge pull request #2794 from netravnen/feature/docs/set-originDavid Lamparter
doc: set origin
2018-08-08Merge pull request #2122 from donaldsharp/zebra_nhsMartin Winter
Create Staticd
2018-08-07doc/user/routemap.rstChristoffer
2018-07-30doc: remove unknown option role from rpki.rstQuentin Young
Options must be documented before they can be cross-referenced, and the scope for configure options is not present in rpki.rst. Remove the option role tag from the `-M` option to remove the build warning. Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-07-30doc: unindent index block content in rpki.rstQuentin Young
Index directives cannot contain content. Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-07-29doc: Add some documentation for staticdDonald Sharp
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-27zebra: fix missing table identifier passed for ip route vrf commandsPhilippe Guibert
The parameter was missing in that vty command. Then it is being added. Also some documentation is refreshed. Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2018-07-26Merge pull request #2729 from qlyoung/doc-misc-bgp-fixesRuss White
doc: misc bgp.rst fixes
2018-07-25Merge pull request #2681 from qlyoung/doc-cleanup-rpkiJafar Al-Gharaibeh
doc: cleanup rpki.rst
2018-07-25doc: misc bgp.rst fixesQuentin Young
* Clean up command stubs * Document `disable-connected-check` * Add markup * Clarify section on autonomous systems * Rewrap line to 80 characters * Fix typos * Fix grammar Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-07-24doc: move rpki reference to correct spotQuentin Young
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-07-24Merge pull request #2640 from pguibert6WIND/doc_ldpQuentin Young
doc: add Ldp user documentation
2018-07-23Merge pull request #2652 from LabNConsulting/working/master/confdate_cleanupDonald Sharp
Simplify deprecation check
2018-07-19doc: add cmd line param section to modules.rstEmanuele Di Pascale
Signed-off-by: Emanuele Di Pascale <emanuele@voltanet.io>
2018-07-18doc: cleanup rpki.rstQuentin Young
Previous commit on this file introduced formatting issues. Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-07-17doc: Update rpki.rst for how-to enable rpki moduleChristoffer
It has not been properly documented yet how to enable the RPKI module with BGP when having installed FRR with RPKI support. This PR seeks to add a section to the user documentation about this. So users will not have to resolve to searching the internet and looking through the FROG mailing list threads for answers.
2018-07-17Merge pull request #2625 from pguibert6WIND/ipv4_ipv6_bgp_showQuentin Young
doc: add more information about show ip bgp and show bgp
2018-07-11Merge pull request #2469 from ajones-rvbd/ajones-issue-2442Quentin Young
unit tests: support code coverage instrumentation and reports
2018-07-10Merge pull request #2651 from qlyoung/doc-cleanup-release-processMartin Winter
doc: cleanup maintainer release document
2018-07-10Merge pull request #2627 from rtrlib/revalidationRuss White
bgpd: rpki revalidation
2018-07-10doc: update doc to no longer requires use of VERSION_TYPE_DEVLou Berger
Signed-off-by: Lou Berger <lberger@labn.net>
2018-07-10Merge pull request #2553 from opensourcerouting/release_procQuentin Young
doc: Add document for Release Build by maintainer
2018-07-10doc: cleanup maintainer release documentQuentin Young
* Sphinx numbered lists use 1. not 1) * Indents are three spaces * Blocks under lists should be indented along with the rest of the list content * Sphinx converts :: to : when used as a code block marker * Apply some preformatted markup to things that should be preformatted * Remove trailing whitespace Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-07-10doc: add Ldp user documentationPhilippe Guibert
This commit gathers some basic information on how to configure and setup Ldp, as well as depict some main principles for that protocol. Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2018-07-10doc: add more information about show ip bgp and show bgpPhilippe Guibert
Add some information to inform the user that one can either display ipv4 or ipv6 routing table, with the above commands. Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2018-07-10doc: Add document for Release Build by maintainerMartin Winter
Signed-off-by: Martin Winter <mwinter@opensourcerouting.org>