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
Christian Hopps
c45ef001ab
doc: document new pytest options and cli commands
...
Signed-off-by: Christian Hopps <chopps@labn.net>
2023-04-22 13:10:52 -04:00
Donald Sharp
a5304577ca
Merge pull request #13300 from louis-6wind/iso_doc
...
doc: fix the print iso macro documentation
2023-04-14 09:05:47 -04:00
Louis Scalbert
4ef4cbea6b
doc: fix the print iso macro documentation
...
fix the print iso macro documentation
Fixes: 7f9ab3b0bb
("lib: Add ISO System & Network format to printfrr")
Signed-off-by: Louis Scalbert <louis.scalbert@6wind.com>
2023-04-13 18:27:34 +02:00
David Lamparter
5903e49c7b
pimd, doc: remove dead import check references
...
ZEBRA_IMPORT_CHECK_UPDATE has been gone for more than a year; remove
some leftover dead references to it.
Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2023-04-13 16:52:57 +02:00
Russ White
f26a87cd24
Merge pull request #12698 from Orange-OpenSource/isisd
...
Isisd/Lib: Add new printfrr format facility for Intermediate System ID
2023-04-11 09:49:01 -04:00
Donald Sharp
24a58196dd
*: Convert event.h to frrevent.h
...
We should probably prevent any type of namespace collision
with something else.
Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2023-03-24 08:32:17 -04:00
Donald Sharp
cd9d053741
*: Convert struct event_master
to struct event_loop
...
Let's find a better name for it.
Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2023-03-24 08:32:17 -04:00
Donald Sharp
2453d15dbf
*: Convert struct thread_master to struct event_master and it's ilk
...
Convert the `struct thread_master` to `struct event_master`
across the code base.
Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2023-03-24 08:32:17 -04:00
Donald Sharp
8c1186d38e
*: Convert thread_execute to event_execute
...
Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2023-03-24 08:32:17 -04:00
Donald Sharp
de2754be3a
*: Convert thread_fetch and thread_call to event_fetch and event_call
...
Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2023-03-24 08:32:17 -04:00
Donald Sharp
332beb64b8
*: Convert thread_cancelXXX to event_cancelXXX
...
Modify the code base so that thread_cancel becomes event_cancel
Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2023-03-24 08:32:17 -04:00
Donald Sharp
907a2395f4
*: Convert thread_add_XXX functions to event_add_XXX
...
Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2023-03-24 08:32:17 -04:00
Donald Sharp
e6685141aa
*: Rename struct thread
to struct event
...
Effectively a massive search and replace of
`struct thread` to `struct event`. Using the
term `thread` gives people the thought that
this event system is a pthread when it is not
Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2023-03-24 08:32:17 -04:00
Donald Sharp
cb37cb336a
*: Rename thread.[ch] to event.[ch]
...
This is a first in a series of commits, whose goal is to rename
the thread system in FRR to an event system. There is a continual
problem where people are confusing `struct thread` with a true
pthread. In reality, our entire thread.c is an event system.
In this commit rename the thread.[ch] files to event.[ch].
Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2023-03-24 08:32:16 -04:00
Pushpasis Sarkar
5b08f6f9ea
doc: Add documentation for MGMT daemon
...
This commit adds user documentation for the new MGMT daemon and
new FRR Management Framework.
Co-authored-by: Yash Ranjan <ranjany@vmware.com>
Co-authored-by: Abhinay Ramesh <rabhinay@vmware.com>
Co-authored-by: Ujwal P <ujwalp@vmware.com>
Signed-off-by: Pushpasis Sarkar <pushpasis@gmail.com>
2023-03-21 22:09:10 -04:00
Olivier Dugeon
7f9ab3b0bb
lib: Add ISO System & Network format to printfrr
...
Like for IP addresses, this patch add a new format for printfrr collection to
print ISO System ID and Network address a.k.a IS-IS system ID & Network.
This new format is added to the library instead of isisd because other daemons
and tools need to print ISO System ID & Network Address.
Signed-off-by: Olivier Dugeon <olivier.dugeon@orange.com>
2023-03-21 15:19:09 +01:00
Quentin Young
5c6b543b64
doc: add release instructions for docker images
...
Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
2023-03-20 17:04:43 -04:00
Donatas Abraitis
8709aab554
doc: Use frrouting/frr-mibs repo downloading SNMP mibs
...
Use repo instead of pastebin.
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2023-03-19 22:56:13 +02:00
Donatas Abraitis
ae7b16b2d4
Merge pull request #12960 from anlancs/doc/some-words-doc
...
doc: Correct some words
2023-03-07 08:25:50 +02:00