summaryrefslogtreecommitdiff
path: root/doc/developer
AgeCommit message (Collapse)Author
2025-03-09doc: The sbfd documentation was not being includedDonald Sharp
Add the sbfd documentation, such as it is, to the developer documentation so that it can be read by people. Signed-off-by: Donald Sharp <sharpd@nvidia.com> (cherry picked from commit f1c75deb8e6581b0c3eb2129a61c017ca1d9be99)
2025-03-09doc: Developer documentation missing some build instructionsDonald Sharp
The building-frr-for-ubuntu2404 and building-doc were missing from the compilation of developer documents. Signed-off-by: Donald Sharp <sharpd@nvidia.com> (cherry picked from commit 4738cb51d2019e8852887e97e9a0363ec29728a4)
2025-03-09doc: Add typesafe conversion examplesDonald Sharp
Try to give some good examples of various lists being converted over to the typesafe way of doing things. Signed-off-by: Donald Sharp <sharpd@nvidia.com> (cherry picked from commit 39909f9fb9459ce210cb44a10291a053d4fbb272)
2025-02-04Merge pull request #17336 from forrestchu/sbfdRuss White
implement SBFD
2025-01-23doc: add sbfd docwumu.zsl
Signed-off-by: wumu.zsl <wumu.zsl@alibaba-inc.com>
2025-01-21Merge pull request #17793 from LabNConsulting/working/lb/fix-r8-rpmsJafar Al-Gharaibeh
Fix Rocky 8 RPMs, add options to build without rpki and docs (default is to include)
2025-01-18doc: add misplaced doc change for mgmtd developmentChristian Hopps
Signed-off-by: Christian Hopps <chopps@labn.net>
2025-01-14Merge pull request #17846 from Jafaral/fix-latex-warnDonald Sharp
doc: fix LaTex warnings, add documentation to build docs
2025-01-13doc: building html/pdf user and developer documentationJafar Al-Gharaibeh
Signed-off-by: Jafar Al-Gharaibeh <jafar@atcorp.com>
2025-01-12doc: add building for ubuntu 24.04, and refactorChristian Hopps
- All 3 ubutu 2x (20.04, 22.04 and 24.04) have the same instructions so put them in one include file. Signed-off-by: Christian Hopps <chopps@labn.net>
2025-01-08doc: update redhat packaging doc with new options and use of Rocky 8 (Centos ↵Lou Berger
8 is no more) Signed-off-by: Lou Berger <lberger@labn.net>
2025-01-06doc: fix building-for-alpine package pathfamfo
Signed-off-by: famfo <famfo@famfo.xyz>
2024-12-16Merge pull request #17252 from nabahr/mcast-modeRafael Zalamena
Fix PIMD RPF lookup mode and nexthop tracking
2024-12-13doc: Clean up Multicast RIB documentationNathan Bahr
Moved it all to PIM section and updated docs for recent changes. Signed-off-by: Nathan Bahr <nbahr@atcorp.com>
2024-12-12doc: Update the next release datesDonatas Abraitis
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2024-11-26tests: Deprecate TOPOTEST_PULLDonatas Abraitis
We do not maintain docker.com/frrouting anymore and not building custom images for topotests. Use local images for topotests instead. Just use: ``` mak topotests-build make topotests ``` Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2024-10-31tests: Add an ability to specify daemon params with unified configDonatas Abraitis
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2024-10-30Merge pull request #17310 from opensourcerouting/fix/doc_buildJafar Al-Gharaibeh
doc: Create html_context before setting READTHEDOCS
2024-10-30doc: Use RST, not Markdown format for linksDonatas Abraitis
Fixes: d155d62785 ("doc: Require unified config for all new topotests") Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2024-10-30doc: Create html_context before setting READTHEDOCSDonatas Abraitis
Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/frrouting/envs/latest/lib/python3.11/site-packages/sphinx/config.py", line 529, in eval_config_file exec(code, namespace) # NoQA: S102 ^^^^^^^^^^^^^^^^^^^^^ File "/home/docs/checkouts/readthedocs.org/user_builds/frrouting/checkouts/latest/doc/user/conf.py", line 77, in <module> html_context["READTHEDOCS"] = True ^^^^^^^^^^^^ NameError: name 'html_context' is not defined Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2024-10-21doc: Require unified config for all new topotestsDonatas Abraitis
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2024-09-10doc: add some text about git forksMark Stapp
Add some general guidance about creating and using a fork of the FRR repository to the workflow doc. Signed-off-by: Mark Stapp <mjs@cisco.com>
2024-09-10doc: fix several warnings in dev docsMark Stapp
Clean up several sphinx warnings in the dev docs: add bmp to bgp TOC; fix some indenting; escape some asterisks. Signed-off-by: Mark Stapp <mjs@cisco.com>
2024-09-09tests: add asyncio default config param to quiet warningChristian Hopps
Update the topotest doc to the latest pytest* pkg versions known to work together Signed-off-by: Christian Hopps <chopps@labn.net>
2024-08-29doc: Document the git revert flowDonatas Abraitis
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2024-08-28Merge pull request #16679 from donaldsharp/nhrp_test_documentationMark Stapp
doc: Update topotest doc to include iptables is needed
2024-08-28doc: Update topotest doc to include iptables is neededDonald Sharp
The nhrp tests skip tests that do not have iptables installed. As such we have ended up with a situation where the nrhp test is now failing locally for me because I have iptables installed and if the CI system had iptables installed it would have detected the problem as well. Let's document that iptables is needed to do testing. Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2024-08-28lib: Add a helper function to dump Lua stackDonatas Abraitis
Very handy for debugging. In Lua script just use "log.trace(table)": ``` function on_rib_process_dplane_results(ctx) log.trace(ctx.rinfo.zd_ng) end ``` You will get something like: ``` Aug 28 17:04:36 donatas-laptop zebra[3782199]: [GCZ7N-MM9D9] { 1: { type: 2 weight: 1 flags: 5 backup_idx: 0 vrf_id: 0 nh_encap_type: 0 gate: { value: 5.87967e+08 string: "192.168.11.35" } nh_label_type: 0 srte_color: 0 ifindex: 0 backup_num: 0 } 2: { type: 3 weight: 1 flags: 3 backup_idx: 0 vrf_id: 0 nh_encap_type: 0 nh_label_type: 0 srte_color: 0 ifindex: 4 backup_num: 0 } } ``` Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2024-08-22Merge pull request #16619 from ↵Jafar Al-Gharaibeh
qlyoung/fix-rtd-build-sphinx-environment-injection doc: update sphinx configs for RTD changes
2024-08-21doc: update sphinx configs for RTD changesQuentin Young
Read The Docs made some changes that require us to add some configuration in our build config files. Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
2024-08-13Merge pull request #16575 from donaldsharp/doc_address_sanitizer_stuffMark Stapp
doc: Add doc to show sysctl setting for Sanitizers
2024-08-13doc: Add doc to show sysctl setting for SanitizersDonald Sharp
In order to run the XXXX Sanitizers over the code as a developer modern linux distro's require a specific sysctl. Let's document that so that people are aware of it. Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2024-08-11doc: Document on how to run specific daemons with unified config in topotestsDonatas Abraitis
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2024-07-30doc: Add some topotest documentation about how to reproduce failuresDonald Sharp
Add some hints for developers about how to reproduce failure conditions in the test. Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2024-07-23build: fix a few python string escape warningsDavid Lamparter
When using a regex (or anything that uses `\?` escapes) in python, raw strings (`r"content"`) should be used so python doesn't consume the escapes itself. Otherwise we get either broken behavior and/or `SyntaxWarning: invalid escape sequence '\['` Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2024-07-02Merge pull request #16094 from opensourcerouting/pkgs-with-grpcRuss White
Add option to build pkg with grpc support
2024-06-26doc: reformat Sphinx conf.py filesQuentin Young
Style checking is complaining about these, rightly so. Reformat. Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
2024-06-24Merge pull request #16128 from LabNConsulting/aceelindem/ospf-ls-retrans-improveRuss White
ospfd: Improve OSPF neighbor retransmission list granularity and pacing
2024-06-20ospfd: Improve OSPF neighbor retransmission list granularity and precisionAcee Lindem
The current OSPF neighbor retransmission operates on a single per-neighbor periodic timer that sends all LSAs on the list when it expires. Additionally, since it skips the first retransmission of received LSAs so that at least the retransmission interval (resulting in a delay of between the retransmission interval and twice the interval. In environments where the links are lossy on P2MP networks with "delay-reflood" configured (which relies on neighbor retransmission in partial meshs), the implementation is sub-optimal (to say the least). This commit reimplements OSPF neighbor retransmission as follows: 1. A new data structure making use the application managed typesafe.h doubly linked list implements an OSPF LSA list where each node includes a timestamp. 2. The existing neighbor LS retransmission LSDB data structure is augmented with a pointer to the list node on the LSA list to faciliate O(1) removal when the LSA is acknowledged. 3. The neighbor LS retransmission timer is set to the expiration timer of the LSA at the top of the list. 4. When the timer expires, LSAs are retransmitted that within the window of the current time and a small delta (50 milli-secs default). The LSAs that are retransmited are given an updated retransmission time and moved to the end of the LSA list. 5. Configuration is added to set the "retransmission-window" to a value other than 50 milliseconds. 6. Neighbor and interface LSA retransmission counters are added to provide insight into the lossiness of the links. However, these will increment quickly on non-fully meshed P2MP networks with "delay-reflood" configured. 7. Added a topotest to exercise the implementation on a non-fully meshed P2MP network with "delay-reflood" configured. The alternative was to use existing mechanisms to instroduce loss but these seem less determistic in a topotest. Signed-off-by: Acee Lindem <acee@lindem.com>
2024-06-20redhat: Add option to build pkg with grpc supportMartin Winter
Signed-off-by: Martin Winter <mwinter@opensourcerouting.org>
2024-06-20debian: Add option to build pkg with grpc supportMartin Winter
Signed-off-by: Martin Winter <mwinter@opensourcerouting.org>
2024-06-19doc: Document the usage of --enable-undefined-sanitizerDonald Sharp
Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2024-06-07doc: add some text on native message API and notif xpath arrayChristian Hopps
Signed-off-by: Christian Hopps <chopps@labn.net>
2024-05-26doc: add missing required newline in .rst formattingChristian Hopps
Signed-off-by: Christian Hopps <chopps@labn.net>
2024-04-25docs: libs install-prefix since cmake 3.21Vincent JARDIN
use the new recommendation from cmake: --install-prefix <directory> New in version 3.21. Specify the installation directory, used by the CMAKE_INSTALL_PREFIX variable. Must be an absolute path. reminder: the default path is /usr/local instead of /usr Signed-off-by: Vincent Jardin <vjardin@free.fr>
2024-04-25docs: sysrepo install-prefix since cmake 3.21Vincent JARDIN
use the new recommendation from cmake: --install-prefix <directory> New in version 3.21. Specify the installation directory, used by the CMAKE_INSTALL_PREFIX variable. Must be an absolute path. reminder: the default path is /usr/local instead of /usr Signed-off-by: Vincent Jardin <vjardin@free.fr>
2024-04-25docs: libyang install-prefix since cmake 3.21Vincent JARDIN
use the new recommendation from cmake: --install-prefix <directory> New in version 3.21. Specify the installation directory, used by the CMAKE_INSTALL_PREFIX variable. Must be an absolute path. reminder: the default path is /usr/local instead of /usr Signed-off-by: Vincent Jardin <vjardin@free.fr>
2024-04-09doc: add doc about the zebra dataplane api versionMark Stapp
Add a block to the dev doc about the dataplane api version. Signed-off-by: Mark Stapp <mjs@cisco.com>
2024-03-27Merge pull request #15557 from idryzhov/remove-confdJafar Al-Gharaibeh
*: remove confd plugin
2024-03-21grpc: fix grpc for various failuresChristian Hopps
lib: don't define a `fallthrough` in c++ to avoid conflict with protobuf c++ check: add link libs required by some versions of grpc++ or it's dependent linked libs tests: don't fail the test due to known at exit memleaks Signed-off-by: Christian Hopps <chopps@labn.net>