Christian Hopps
c00002d0d0
build: protobuf is required so update building docs
...
- recommend using libyang 2.1.128 but accept 2.0.0 for now.
- update ubuntu building doc to add GRPC section
- update ubuntu reference docker builds to match grpc doc change
Signed-off-by: Christian Hopps <chopps@labn.net>
2023-12-31 13:51:21 +00:00
Igor Ryzhov
4907ce966b
doc: add graphiz dependency for dev docs
...
There's a graph in cli.rst that needs graphviz to be built.
Signed-off-by: Igor Ryzhov <iryzhov@nfware.com>
2023-12-22 16:08:43 +02:00
Donald Sharp
db4bdf7a3a
Merge pull request #15023 from opensourcerouting/fix/drop_redundant_vrf_name
...
bgpd: Drop redundant VRF name printing for `show bgp summary`
2023-12-14 20:26:52 -05:00
Donatas Abraitis
f68154184c
doc: Update examples of show bgp summary
...
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2023-12-14 15:14:40 +02:00
Louis Scalbert
3dc8b2c1f5
doc: update for exabgp 4
...
Update the documentation to require exabgp 4
Signed-off-by: Louis Scalbert <louis.scalbert@6wind.com>
2023-12-14 11:39:24 +01:00
Christian Hopps
477b56106b
tests: add support for running things under rr
.
...
Signed-off-by: Christian Hopps <chopps@labn.net>
2023-12-01 11:44:22 -05:00
Donatas Abraitis
36547f400e
Merge pull request #9012 from dlqs/lua-poly
...
Refactor decoder for Lua hook system
2023-11-29 15:14:46 +02:00
Konstantin Vasin
da694b2e93
docker: fix typos in docs for ubuntu20-ci and ubuntu22-ci
...
Signed-off-by: Konstantin Vasin <126960927+k-v1@users.noreply.github.com>
2023-11-26 19:21:49 +03:00
David Schweizer
75efbc3f55
doc: Add build instructions for FreeBSD 14
...
Signed-off-by: David Schweizer <dschweizer@opensourcerouting.org>
2023-11-23 15:38:45 +01:00
Donald Lee
5042b8e6be
doc: Remove mention of const noop decoder
...
Now handled by _lua_noop
Signed-off-by: Donald Lee <dlqs@gmx.com>
2023-11-20 20:45:02 -05:00
Quentin Young
9d963dc3f1
doc: fix docs path to requirements.txt
...
Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
2023-11-17 12:11:09 -05:00
Quentin Young
5b7563c7e9
doc: restore frr docs theme
...
Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
2023-11-16 18:44:28 -05:00
Russ White
8aae3ea5d2
Merge pull request #11800 from mxyns/bmp-locribmon
...
bgpd: BMP Loc-Rib Monitoring (RFC9069) Implementation
2023-11-14 08:27:45 -05:00
Christian Hopps
c27b054efe
tests: add ability to show all types of valgrind memleaks
...
Signed-off-by: Christian Hopps <chopps@labn.net>
2023-11-07 15:29:37 -05:00
Donatas Abraitis
b0317265b1
doc: Add a quick example on how to use release_notes.py
...
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2023-11-04 16:32:01 +02:00
Maxence Younsi
9607070acd
bgpd: bmp unset v6 flag + address PR#14188 comments
...
use CHECK_FLAG
fix comment spaces
change zlog_debug to zlog_warn
safeguard on updated_route
added doc/developer/bmp.rst to subdir.am
other qol changes
Signed-off-by: Maxence Younsi <mx.yns@outlook.fr>
2023-11-04 12:17:48 +01:00
mxyns
66d564a60b
bgpd: loc-rib uptime moved to bgp_path_info_extra and set in header
...
moved loc-rib uptime field "bgp_rib_uptime" to struct bgp_path_info_extra for memory concerns
moved logic into bgp_route_update's callback bmp_route_update
written timestamp in per peer header
Signed-off-by: Maxence Younsi <mx.yns@outlook.fr>
2023-11-04 12:17:48 +01:00
Donald Sharp
30a51411a2
Merge pull request #14700 from mjstapp/fix_devdoc_bits
...
docs: clean up some developer doc warnings
2023-10-31 12:01:53 -04:00
Mark Stapp
bb6d4cea60
docs: clean up some developer doc warnings
...
A few fixups to clean up some dev doc warnings, in the
northbound files especially.
Signed-off-by: Mark Stapp <mjs@labn.net>
2023-10-31 09:57:13 -04:00
Christian Hopps
62af972148
tests: add gdb integration with valgrind
...
Allows you to run daemons under valgrind integrated with gdb. When daemons are
run with the ``--gdb-daemons/--gdb-routers`` options they will be wired up to
valgrind using vgdb (valgrind tool) so gdb will stop when valgrind errors are
encountered.
Signed-off-by: Christian Hopps <chopps@labn.net>
2023-10-30 07:12:27 -04:00
Christian Hopps
a921202a85
tests: add --gdb-use-emacs option
...
When specified `--gdb-use-emacs` will launch the daemon with gdb inside a
running emacs server using `emacsclient --eval` commands.
Signed-off-by: Christian Hopps <chopps@labn.net>
2023-10-23 05:11:32 -04:00
anlan_cs
56f141e64b
doc: replace commands list with header file
...
Signed-off-by: anlan_cs <anlan_cs@tom.com>
2023-10-07 10:06:59 +08:00
anlan_cs
c195607873
doc: adjust protocol command values for zebra
...
Adjust protocol command values for zebra based on latest code.
Also, expand the field width to fit the length.
Signed-off-by: anlan_cs <anlan_cs@tom.com>
2023-10-01 15:51:42 +08:00
Donatas Abraitis
3518fe70cb
Merge pull request #14507 from qlyoung/fix-doc-more-doc-more
...
More developer doc fixes
2023-09-29 08:41:41 +03:00
Quentin Young
09e0cab1e0
doc: add debian 12 build docs to toctree
...
Not reachable without this
Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
2023-09-28 12:04:05 -04:00
Quentin Young
b06c593756
doc: remove northbound _sidebar definition
...
This ain't a wiki
But retain the ordering set up in the _sidebar in the RST index
Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
2023-09-28 12:04:05 -04:00
Quentin Young
d98bba1be2
doc: couple nbapi doc cleanups
...
* Fix block quote & rfc link
* Fix note block re: libyang dependencies
Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
2023-09-28 11:53:11 -04:00
Quentin Young
011d411c61
doc: fixup nbapi doc images
...
Pulled from web hosting into repo, all figure blocks updated.
Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
2023-09-28 11:53:07 -04:00
Quentin Young
dd858b8a76
doc: unpin sphinx from 4.0.2
...
requirements.txt was pinning sphinx at a very old version. This version
doesn't work in recent versions of Python; the new RTD configuration
made RTD respect our requirements file, breaking the build.
Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
2023-09-28 10:51:10 -04:00
Donatas Abraitis
6a9fe6fac3
Merge pull request #14500 from qlyoung/add-rtd-config
...
doc: add .readthedocs.yaml configs
2023-09-28 12:36:29 +03:00
Quentin Young
f71f078023
doc: add .readthedocs.yaml configs
...
As of Sep 25 2023, RTD projects require config files to build. This
patch is necessary for docs to continue to build.
Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
2023-09-27 20:16:16 -04:00
Quentin Young
e45651fbd0
doc: include checkpatch & cspf docs in toctree
...
The documentation pages on checkpatch and CSPF were not reachable
because they were not included in any toctree. Include them in the tree!
Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
2023-09-27 19:55:35 -04:00
Quentin Young
d2292c6bfe
doc: fix whitespace, formatting errors
...
* Fix various whitespace and syntax errors
* Fix a couple tiny grammar mistakes
Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
2023-09-27 19:55:35 -04:00
Jafar Al-Gharaibeh
52cc7f1006
Merge pull request #14222 from opensourcerouting/doc/debian12
...
[DOC] Debian 12
2023-09-27 17:46:40 -05:00
Donatas Abraitis
fb5f11ae67
doc: Use backward order when for release dates hint
...
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2023-09-27 16:49:56 +03:00
Donatas Abraitis
21d718aa6c
doc: Fix release dates in workflow
...
Align to the release rules:
Releases are scheduled in a 4-month cycle on the first Tuesday each March/July/November.
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2023-09-27 16:45:01 +03:00
Martin Winter
e1996b3f4a
doc: Add Debian 12 Build documentation
...
Signed-off-by: Rodrigo Nardi <rnardi@netdef.org>
Signed-off-by: Martin Winter <mwinter@opensourcerouting.org>
2023-09-26 17:44:11 +02:00
Quentin Young
19c5667dfc
doc: add northbound api arch docs
...
Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
2023-09-19 21:36:04 -04:00
Donatas Abraitis
b32fd280fe
doc: Reuse $TAG for git checkout when building Docker images
...
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2023-09-05 08:54:27 +03:00
Donald Sharp
cdf6c5e587
doc: Prohibit usage of system()
calls in FRR
...
See the documentation update, but system() calls and
it's ilk block the processing of SIGINT and they are
not properly handled as a result leading to shutdown
issues where one or more daemons never stop.
See aa530b627d
as an example
of system call usage removed from the system.
Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2023-08-11 13:28:54 -04:00
xzheng
c46a231a8d
doc: fix the error path
...
fix the error path.
Signed-off-by: xzheng <zhengxiang311019@163.com>
2023-07-11 09:45:35 +08:00
Christian Hopps
055f4997b4
doc: document sqlite3 depend and add to docker build
...
Signed-off-by: Christian Hopps <chopps@labn.net>
2023-07-06 18:08:15 -04:00
Rodney W. Grimes
a41eee6927
doc: Add Ubuntu 22.04 to list of builds
...
Add Ubuntu 22.04 build instructions to list.
Sort list into alphabetic order.
Signed-off-by: Rodney W. Grimes <rgrimes@FreeBSD.org>
2023-06-29 09:46:27 +00:00
anlan_cs
4e8737b269
doc: Fix one syntax error for code block
...
The code block doesn't work due to special thing in front of it.
So, just make it work.
Signed-off-by: anlan_cs <vic.lan@pica8.com>
2023-06-27 13:51:40 +08:00
Acee Lindem
f8831ce197
doc: Fix typo in previous Coverity workflow doc commit.
...
Signed-off-by: Acee Lindem <aceelindem@gmail.com>
2023-06-21 07:11:10 -04:00
Jafar Al-Gharaibeh
2be9ce6cd8
Merge pull request #13801 from LabNConsulting/chopps/latest-checkpatch
...
Import latest checkpatch.pl from linux
2023-06-20 10:41:01 -05:00
Jafar Al-Gharaibeh
3917d78f4c
Merge pull request #13809 from LabNConsulting/chopps/mgmtdoc
...
doc: start of mgmtd developer doc
2023-06-20 09:04:55 -05:00
Christian Hopps
786a1e95bc
doc: add the linux doc for checkpatch.pl
...
Signed-off-by: Christian Hopps <chopps@labn.net>
2023-06-20 01:05:30 -04:00
Christian Hopps
a552543640
doc: start of mgmtd developer doc
...
- docs on how to convert daemon to mgmtd and some diagrams
- and a fix for code-block in cspf.rst
Signed-off-by: Christian Hopps <chopps@labn.net>
2023-06-19 18:13:37 -04:00
anlan_cs
ee7457a1c0
doc: Fix one syntax error for code block
...
The code block doesn't work because blank line is missing.
So, just make it work.
Signed-off-by: anlan_cs <vic.lan@pica8.com>
2023-06-14 22:23:15 +08:00