proxmox-mirrors/mirror_frr
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_frr synced 2025-05-03 09:28:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
33,789 Commits 4 Branches 191 Tags 125 MiB
615097b6b0
Commit Graph

614 Commits

Author SHA1 Message Date
Mark Stapp
be1a03f7d9 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>
(cherry picked from commit bb6d4cea60)
 2023-10-31 16:03:26 +00: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
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