Donald Sharp
894cb4f689
bgpd: When using dev build add pointer information to %pBD
...
When building FRR with `--enable-dev-build`. Add a bit of
code to include the pointer value as part of the output.
Helps with tracking down issues and let's us see more data
when using the dev build option.
New output:
2024/03/08 19:48:56 BGP: [V0J1J-W5RHA] 11.0.20.1/32(0x5759ddf8d7c0) for 11.0.20.1/32
Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2024-03-14 09:45:09 +00:00
David Lamparter
02af04f73d
doc: update re. ISO C23 printf changes
...
The new `%w99d` fixed-width modifier still needs work in `frr-format`,
which unfortunately is not as trivial as `%b` was.
Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2024-03-10 15:29:17 +01:00
Donald Sharp
852a74807f
doc, tools: Remove ARRAY_SIZE check
...
checkpatch.pl wants you to use ARRAY_SIZE in a kernel
header file. We don't have access to this kernel header
file for normal compilation. I'm just going to remove it.
Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2024-03-04 11:03:46 -05:00
Donatas Abraitis
8b73f011d5
doc: Update dates in release reference table
...
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2024-02-27 14:54:16 +02:00
Donatas Abraitis
ce334222ae
doc: Add mgmtd
pytest marker into documentation
...
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2024-02-17 11:24:29 +02:00
Christian Hopps
6374970cb8
doc: docker: update with new more strict protobuf requirements
...
Signed-off-by: Christian Hopps <chopps@labn.net>
2024-02-12 06:48:12 -05:00
Vincent JARDIN
14fc0782d4
mgmtd: ripng, libs fully converted
...
While checking the code, we can notice that they are already converted.
Suggested-by: Igor Ryzhov <iryzhov@nfware.com>
Signed-off-by: Vincent Jardin <vjardin@free.fr>
2024-02-09 19:23:01 +01:00
Donald Sharp
f28447e352
Merge pull request #15283 from okda-networks/doc-update
...
doc: sysrepo plugin doc update with test commands
2024-02-06 11:42:02 -05:00
Donald Sharp
c1e2086930
doc: Add some documentation around a new pthread call
...
Not necessarily the correct place for this but there
is no other place and it needs to be called out and I
would rather have some documentation in place. Long
term I would like to add a bunch of frr_pthread documentation
but at this point in time it's not there. We can
re-arrange when that happens.
Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2024-02-05 14:51:55 -05:00
Amjad Daraiseh
70fba89306
doc: sysrepo plugin doc update with tested commands
...
Signed-off-by: Amjad Daraiseh <adaraiseh@okdanetworks.com>
2024-02-02 05:41:04 -05:00
Igor Ryzhov
72949f5f94
Merge pull request #15251 from qlyoung/fix-doc-nbcli-numlist
...
doc: fix misformatted list in nbapi docs
2024-01-31 15:06:25 +02:00
Christian Hopps
cb3242f697
tests: add YANG notification test
...
Signed-off-by: Christian Hopps <chopps@labn.net>
2024-01-30 14:54:47 -05:00
Quentin Young
5b4a3d3af9
doc: update [no] recommendation
...
Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
2024-01-30 12:16:01 -05:00
Quentin Young
f9ed1c9c30
doc: fix misformatted list in nbapi docs
...
Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
2024-01-29 09:28:32 -08:00
Donald Sharp
259e3d4dac
Merge pull request #15243 from opensourcerouting/autoconf-dir-mess
...
*: fix a pile of directory and/or state retention related issues
2024-01-28 14:30:28 -05:00
David Lamparter
444bc5e237
build: update packaging & docs for dir changes
...
`--sysconfdir` and `--localstatedir` now align with general autoconf
practices.
Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2024-01-27 19:01:19 +01:00
Christian Hopps
cdfff3e5b5
doc: cleanup the structure a bit
...
Signed-off-by: Christian Hopps <chopps@labn.net>
2024-01-27 05:03:57 -05:00
Christian Hopps
e2a9eb908f
doc: cleanup auto-converted "list" style mistake
...
Signed-off-by: Christian Hopps <chopps@labn.net>
2024-01-27 05:03:51 -05:00
Christian Hopps
f7594b55c2
doc: updates to mgmtd conversion documentation
...
Signed-off-by: Christian Hopps <chopps@labn.net>
2024-01-26 12:34:23 -05:00
Vincent Jardin
4654995915
doc: typo, fix end of line
...
Signed-off-by: Vincent Jardin <vjardin@free.fr>
2024-01-15 22:51:09 +01:00
Christian Hopps
a9dc7e9cc0
doc: mgmtd: update mgmtd conversion doc to be current.
...
Also change `be_client_xpaths` to `be_client_config_xpaths` referred in the doc
to make much clearer it's use (since there's a separate `be_client_oper_xpaths`.
Signed-off-by: Christian Hopps <chopps@labn.net>
2024-01-13 14:26:55 +00:00
Christian Hopps
20d0d475cb
Merge pull request #14542 from idryzhov/nb-op-cb-split
...
Add more northbound operation types
2024-01-12 06:07:57 -05:00
Donatas Abraitis
0f5a79af96
Merge pull request #15136 from idryzhov/ignore-cbs
...
lib, mgmtd: rename ignore_cbs to ignore_cfg_cbs
2024-01-12 11:56:59 +02:00
Igor Ryzhov
34721972ba
lib, mgmtd: rename ignore_cbs to ignore_cfg_cbs
...
Setting this variable to true makes NB ignore only configuration-related
callbacks. CLI-related callbacks are still loaded and executed, so
rename the variable to make it clearer.
Signed-off-by: Igor Ryzhov <iryzhov@nfware.com>
2024-01-11 23:47:48 +02:00
Igor Ryzhov
3c2598a26f
mgmt, lib: differentiate DELETE and REMOVE operations
...
Currently, there's a single operation type which doesn't return error
if the object doesn't exists. To be compatible with NETCONF/RESTCONF,
we should support differentiate between DELETE (fails when object
doesn't exist) and REMOVE (doesn't fail if the object doesn't exist).
Signed-off-by: Igor Ryzhov <iryzhov@nfware.com>
2024-01-11 15:06:53 +02:00
Donatas Abraitis
79b992890f
doc: Fix documentation warning on the required version of libyang
...
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2024-01-11 09:23:41 +02:00
Donatas Abraitis
d3177d9f08
doc: Change the link to libyang for 2.1.x
...
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2024-01-11 09:22:54 +02:00
Donald Sharp
956b6153fe
Merge pull request #15106 from opensourcerouting/fix/rename_thread_cli
...
vtysh: Add `show event ...` commands
2024-01-08 13:51:36 -05:00
Donatas Abraitis
7e6b4f7990
doc: Rename Thread
to Event
in events example
...
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2024-01-07 14:43:38 +02:00
Donatas Abraitis
8c382a675e
doc: Rename show thread ...
to show event ...
...
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2024-01-07 14:14:56 +02:00
Christian Hopps
db3ac9d4f3
build: require libyang 2.1.128
...
Update building docs to reflect this as well.
Signed-off-by: Christian Hopps <chopps@labn.net>
2024-01-06 06:55:04 -05:00
Christian Hopps
d2661a3841
doc: add diagram of oper-state queries.
...
Signed-off-by: Christian Hopps <chopps@labn.net>
2024-01-04 05:36:14 +00:00
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
Donald Sharp
22c329ed32
Merge pull request #13793 from LabNConsulting/aceelindem/coverity-doc-update
...
doc: Update Coverity workflow in developer documentation.
2023-06-14 06:57:57 -04:00
Acee Lindem
4d2fe4a4de
doc: Update Coverity workflow in developer documentation.
...
Signed-off-by: Acee Lindem <aceelindem@gmail.com>
2023-06-13 16:10:48 -04:00
Donatas Abraitis
3895ea777b
Merge pull request #13762 from anlancs/doc/pthread-typo
...
doc: Adjust pthread description
2023-06-12 11:13:49 +03:00
anlan_cs
eb678efed8
doc: Adjust pthread description
...
Refer to the latest code, modified the description of pthread.
Signed-off-by: anlan_cs <vic.lan@pica8.com>
2023-06-12 13:01:46 +08:00
Christian Hopps
3c43eaa7d4
docker: ubuntu-ci 18.04 -> 22.04, topotest parallel run examples
...
Update the READMEs, and give example of a full parallel topotest run with
result extraction for analyze.py
Signed-off-by: Christian Hopps <chopps@labn.net>
2023-06-09 03:19:20 -04:00
Jafar Al-Gharaibeh
e48e92e76c
Merge pull request #13734 from LabNConsulting/chopps/removeunused
...
remove mentions of socat
2023-06-08 23:46:45 -05:00
Christian Hopps
17054f373e
doc: update doc removing socat req + remove unused tests code
...
Signed-off-by: Christian Hopps <chopps@labn.net>
2023-06-08 11:03:18 -04:00
anlan_cs
82ff709263
doc: Adjust event system
...
Refer to the latest code, modify the description of event system.
Signed-off-by: anlan_cs <vic.lan@pica8.com>
2023-06-08 15:41:34 +08:00
Donatas Abraitis
b28e2c59dc
doc: Update reference table for current and upcoming release dates
...
Keep only 3 release dates, current and two upcoming. On the next release,
just update one, instead of multiple (zero point looking too much in the
future).
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2023-05-31 23:17:27 +03:00
Christian Hopps
054d6bdc48
tests: selecting results by regexp and ragnes, add container support
...
- Allow selecting results using a regexp
- Allow selecting results using commasep range specs
- Add support for getting and saving results from a docker/podman
container.
- update docs
Signed-off-by: Christian Hopps <chopps@labn.net>
2023-05-26 06:32:24 -04:00
Donald Sharp
769b228c76
Merge pull request #13586 from ponedo/link-state-doc-fix
...
doc: fix typo RFC7572 to RFC7752
2023-05-23 10:57:20 -04:00
ponedo
d764ffaf6f
doc: fix typo RFC7572 to RFC7752
...
Signed-off-by: ponedo <2534164734@qq.com>
2023-05-23 22:52:51 +08:00
Igor Ryzhov
74497c34aa
doc: remove non-existent configure option
...
Signed-off-by: Igor Ryzhov <iryzhov@nfware.com>
2023-05-19 19:35:19 +03:00
Christian Hopps
9b18d3d6ac
doc: document optionally required packages
...
- tshark and valgrind are required but only if you enable those
features during test runs.
Signed-off-by: Christian Hopps <chopps@labn.net>
2023-05-17 13:52:41 -04:00
Lou Berger
d4977708f0
topotest: add --memleaks topotest option
...
Signed-off-by: Lou Berger <lberger@labn.net>
2023-05-11 07:46:19 -04:00
Lou Berger
39869a3597
doc: update for ubuntu 22.04 and to run topotest with valgrind
...
Signed-off-by: Lou Berger <lberger@labn.net>
2023-05-11 07:13:20 -04:00
Christian Hopps
2ac74f0dbe
doc: python, required by clippy, is no longer a non-essential tool
...
Signed-off-by: Christian Hopps <chopps@labn.net>
2023-05-09 20:25:54 +00:00
Christian Hopps
a3e8e1aacb
doc: document --perf and --perf-options, and a bit of cleanup
...
Signed-off-by: Christian Hopps <chopps@labn.net>
2023-04-23 21:56:38 -04:00