summaryrefslogtreecommitdiff
path: root/doc/developer
AgeCommit message (Collapse)Author
2020-10-23doc: add developer docs for tracingQuentin Young
Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2020-10-17doc: Add %pBD print formatter to docDonald Sharp
Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2020-10-08doc: document use of black for python formattingQuentin Young
Also moves "Exceptions" for C code under the C subsection. Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2020-10-07*: reformat python fileswhitespace
We are now using black. Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2020-09-21doc: Update Documentation to note Solaris Unsupported statusDonald Sharp
With the change of Solaris going from Supported -> UnSupported the documentation needed to be updated to reflect the reality on the ground. Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2020-09-19Merge pull request #7097 from mjstapp/fix_ubu20_doc_pip2Donatas Abraitis
doc: clarify python and pip2 for ubuntu 20
2020-09-18tests: use .items instead of .iteritems in topotestsMark Stapp
Avoid py2-only .iteritems() api. Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-09-15Merge pull request #7099 from mjstapp/fix_doc_thread_rwLou Berger
doc: clarify independence of THREAD_READ and _WRITE
2020-09-14doc: clarify independence of THREAD_READ and _WRITEMark Stapp
Make it clearer that the READ and WRITE tasks/events are independent in the lib/thread apis. Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-09-14doc: clarify python and pip2 for ubuntu 20Mark Stapp
Must run the pip2 install script with python2 on ubuntu 20. Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-09-11doc: fix rpm link under libyang helpStephen Worley
Fix the rpm link under libyang help. The link was assuming it was local without the https. Signed-off-by: Stephen Worley <sworley@cumulusnetworks.com>
2020-09-08doc: update libyang blurb for 1.xQuentin Young
Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2020-09-08doc: add notes about hash table invariantsQuentin Young
Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2020-09-08Merge pull request #6376 from opensourcerouting/bump-libyang-req-version-1.xDonald Sharp
build, yang: bump libyang minimum required version to 1.0.184
2020-08-20ospfd: Add Segment Routing Local BlockOlivier Dugeon
RFC 8665 defines a Segment Routing Local Block for Adjacency SID. This patch provides the possibility to modify the SRLB as well as reserved the block range from the Label Manager. - Introduce new CLI 'segment-routing local-block' - Add local block to SRDB structure - Parse / Serialize SRLB in Router Information LSA - Update OSPF-SR topotest - Update documentation Signed-off-by: Olivier Dugeon <olivier.dugeon@orange.com>
2020-08-12lib, zebra: add support for sending ARP requestsJakub Urbańczyk
We can make the Linux kernel send an ARP/NDP request by adding a neighbour with the 'NUD_INCOMPLETE' state and the 'NTF_USE' flag. This commit adds new dataplane operation as well as new zapi message to allow other daemons send ARP/NDP requests. Signed-off-by: Jakub Urbańczyk <xthaid@gmail.com>
2020-08-11Merge pull request #6755 from xThaid/dplane_batchingDonald Sharp
zebra: dataplane batching
2020-08-10doc: add documentation for the dataplane batchingJakub Urbańczyk
Signed-off-by: Jakub Urbańczyk <xthaid@gmail.com>
2020-08-10doc: initial documentation for gRPCRafael Zalamena
Give the FRR users some examples of gRPC usage in scripts to let them start experimenting with the new configuration interface provided by YANG/northbound. Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2020-08-07build, yang: bump libyang minimum required version to 1.0.184Renato Westphal
It's time to say good bye to libyang 0.16.105. The recently released libyang 1.0.184 includes numerous bug fixes and performance improvements that we need. Despite the major version bump from 0.x to 1.x, the libyang API is the same except for a single backward-incompatible change in the user types interface (which we're currently not using). Hence no code changes were necessary to adapt FRR to libyang 1.x. This commit also reintroduces some leafrefs that needed to be removed from our YANG modules due to a bug that was present on libyang 0.16.105. Signed-off-by: Renato Westphal <renato@opensourcerouting.org>
2020-08-06doc: Update instructions for building for OpenWrtPawel Dembicki
Frr was added to official OpenWrt repo. No need to use unofficial sources from Github PR. Signed-off-by: Pawel Dembicki <p.dembicki@wb.com.pl>
2020-07-08Merge pull request #6693 from qlyoung/doc-value-initialization-practicesDonatas Abraitis
Document value initialization practices
2020-07-07doc: remove trailing whitespaceQuentin Young
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2020-07-07doc: note preferences for value initializationQuentin Young
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2020-07-07doc: add note about generous BGP topotest timeoutsMark Stapp
Add note blocks to the topotest and topotest-json dev docs to emphasize the need for generous BGP retry/convergence timers. Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-07-06doc: specify output for json commands w/ no outputQuentin Young
JSON commands should always return valid JSON Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2020-06-24doc: add docker image build instructionsQuentin Young
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2020-06-10Merge pull request #6493 from opensourcerouting/workflow-debianDonald Sharp
doc/workflow: write down debian/* branch semantics
2020-06-02doc: update zebra/zapi docMark Stapp
Add the new OPAQUE zapi messages; a couple of edits. Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-06-01doc/workflow: write down debian/* branch semanticsDavid Lamparter
Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2020-05-28doc: encourage const in the developer docMark Stapp
Add a little text about using 'const' in the dev doc. Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-05-27doc: add dev doc for ubuntu 20.04Mark Stapp
Add a doc for ubuntu 20 LTS; it's mainly the same as the 18 LTS doc, with a couple of extra notes. Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-05-04lib: add const iteration & find to typesafe listsDavid Lamparter
Based on work originally by Mark Stapp <mjs@voltanet.io>. Make it possible to iterate the typesafe lists in a const context, as well as find items from them. Signed-off-by: Mark Stapp <mjs@voltanet.io> [above signoff was for the original version before modification] Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2020-05-04Merge commit '97cfd5d207e46a027809125cfb356fd301af0cf5'David Lamparter
(from PR #6137)
2020-04-27doc: fix typo in archlinux docMark Stapp
Fix a typo to remove a warning when building the dev docs. Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-04-21Merge pull request #6253 from opensourcerouting/fpm-extraQuentin Young
zebra/fpm: fix shutdown and add more documentation
2020-04-21doc: add some Github workflow notesDavid Lamparter
Just writing down what seems to be established procedure. Signed-off-by: David Lamparter <equinox@diac24.net>
2020-04-21doc: document strcpy & sprintf banDavid Lamparter
Signed-off-by: David Lamparter <equinox@diac24.net>
2020-04-20doc: remove mailing list patch submissionDavid Lamparter
Last patch sent in on the mailing list was in July 2018. If someone sends a patch we can still pick it up, but practiced reality is quite clearly PRs on github. Signed-off-by: David Lamparter <equinox@diac24.net>
2020-04-17doc: update FPM documentationRafael Zalamena
Tell users about new FPM implementation and add more documentation about it. Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2020-04-16Merge pull request #6224 from mjstapp/zclient_session_idOlivier Dugeon
lib,zebra: add a session id for zapi sessions
2020-04-16lib,zebra: add a session id for zapi sessionsMark Stapp
Distinguish zapi sessions, for daemons who use more than one, by adding a session id. The tuple of proto + instance is not adequate to support clients who use multiple zapi sessions. Include the id in the client show output if it's present. Add a bit of info about this to the developer doc. Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-04-16Merge pull request #5451 from opensourcerouting/rcu-logSantosh P K
logging subsystem rewrite
2020-04-07doc: logging: clarify per-thread bufferingDavid Lamparter
Log buffer flushing is thread-local. Signed-off-by: David Lamparter <equinox@diac24.net>
2020-04-05doc: Mention that we should use `black` code formatter for topotestsDonatas Abraitis
black - https://github.com/psf/black Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
2020-04-01doc: document JSON conventionsQuentin Young
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2020-04-01doc: new logging subsystemDavid Lamparter
Signed-off-by: David Lamparter <equinox@diac24.net>
2020-03-25*: use the current project name (FRRouting)Lou Berger
Signed-off-by: Lou Berger <lberger@labn.net>
2020-03-20Merge pull request #6046 from Naveenaidu/builddoc-archlinuxDonatas Abraitis
doc: Add build instructions for Arch Linux
2020-03-19docs: document libyang build magic (from Martin) for centos 6Lou Berger
Signed-off-by: Lou Berger <lberger@labn.net>
generated by cgit v1.2.3 (git 2.39.1) at 2025-12-11 14:09:20 +0000