summaryrefslogtreecommitdiffstats
path: root/doc/developer (follow)
Commit message (Collapse)AuthorAgeFilesLines
* doc: replace commands list with header fileanlan_cs2023-10-071-291/+1
| | | | Signed-off-by: anlan_cs <anlan_cs@tom.com>
* doc: adjust protocol command values for zebraanlan_cs2023-10-011-223/+291
| | | | | | | 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>
* Merge pull request #14507 from qlyoung/fix-doc-more-doc-moreDonatas Abraitis2023-09-2911-85/+63
|\ | | | | More developer doc fixes
| * doc: add debian 12 build docs to toctreeQuentin Young2023-09-281-0/+1
| | | | | | | | | | | | Not reachable without this Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
| * doc: remove northbound _sidebar definitionQuentin Young2023-09-282-22/+7
| | | | | | | | | | | | | | | | 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>
| * doc: couple nbapi doc cleanupsQuentin Young2023-09-281-17/+20
| | | | | | | | | | | | | | * Fix block quote & rfc link * Fix note block re: libyang dependencies Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
| * doc: fixup nbapi doc imagesQuentin Young2023-09-288-46/+35
| | | | | | | | | | | | Pulled from web hosting into repo, all figure blocks updated. Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
* | doc: unpin sphinx from 4.0.2Quentin Young2023-09-281-4/+0
|/ | | | | | | | 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>
* Merge pull request #14500 from qlyoung/add-rtd-configDonatas Abraitis2023-09-281-0/+16
|\ | | | | doc: add .readthedocs.yaml configs
| * doc: add .readthedocs.yaml configsQuentin Young2023-09-281-0/+16
| | | | | | | | | | | | | | 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>
* | doc: include checkpatch & cspf docs in toctreeQuentin Young2023-09-284-0/+6
| | | | | | | | | | | | | | 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>
* | doc: fix whitespace, formatting errorsQuentin Young2023-09-285-99/+105
|/ | | | | | | * Fix various whitespace and syntax errors * Fix a couple tiny grammar mistakes Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
* Merge pull request #14222 from opensourcerouting/doc/debian12Jafar Al-Gharaibeh2023-09-282-0/+120
|\ | | | | [DOC] Debian 12
| * doc: Add Debian 12 Build documentationMartin Winter2023-09-262-0/+120
| | | | | | | | | | Signed-off-by: Rodrigo Nardi <rnardi@netdef.org> Signed-off-by: Martin Winter <mwinter@opensourcerouting.org>
* | doc: Use backward order when for release dates hintDonatas Abraitis2023-09-271-9/+7
| | | | | | | | Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
* | doc: Fix release dates in workflowDonatas Abraitis2023-09-271-6/+6
|/ | | | | | | | 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>
* doc: add northbound api arch docsQuentin Young2023-09-2016-0/+8105
| | | | Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
* doc: Reuse $TAG for git checkout when building Docker imagesDonatas Abraitis2023-09-051-3/+3
| | | | Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
* doc: Prohibit usage of `system()` calls in FRRDonald Sharp2023-08-111-0/+7
| | | | | | | | | | | | 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 aa530b627de8d1d8c11e4455f3e97a8c2e045281 as an example of system call usage removed from the system. Signed-off-by: Donald Sharp <sharpd@nvidia.com>
* doc: fix the error pathxzheng2023-07-111-2/+2
| | | | | | fix the error path. Signed-off-by: xzheng <zhengxiang311019@163.com>
* doc: document sqlite3 depend and add to docker buildChristian Hopps2023-07-071-0/+11
| | | | Signed-off-by: Christian Hopps <chopps@labn.net>
* doc: Add Ubuntu 22.04 to list of buildsRodney W. Grimes2023-06-292-3/+6
| | | | | | | Add Ubuntu 22.04 build instructions to list. Sort list into alphabetic order. Signed-off-by: Rodney W. Grimes <rgrimes@FreeBSD.org>
* doc: Fix one syntax error for code blockanlan_cs2023-06-271-1/+1
| | | | | | | 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>
* doc: Fix typo in previous Coverity workflow doc commit.Acee Lindem2023-06-211-2/+2
| | | | Signed-off-by: Acee Lindem <aceelindem@gmail.com>
* Merge pull request #13801 from LabNConsulting/chopps/latest-checkpatchJafar Al-Gharaibeh2023-06-203-7/+1264
|\ | | | | Import latest checkpatch.pl from linux
| * doc: add the linux doc for checkpatch.plChristian Hopps2023-06-203-7/+1264
| | | | | | | | Signed-off-by: Christian Hopps <chopps@labn.net>
* | Merge pull request #13809 from LabNConsulting/chopps/mgmtdocJafar Al-Gharaibeh2023-06-203-0/+224
|\ \ | |/ |/| doc: start of mgmtd developer doc
| * doc: start of mgmtd developer docChristian Hopps2023-06-203-0/+224
| | | | | | | | | | | | | | - 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>
* | doc: Fix one syntax error for code blockanlan_cs2023-06-141-1/+1
|/ | | | | | | 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>
* Merge pull request #13793 from LabNConsulting/aceelindem/coverity-doc-updateDonald Sharp2023-06-141-4/+17
|\ | | | | doc: Update Coverity workflow in developer documentation.
| * doc: Update Coverity workflow in developer documentation.Acee Lindem2023-06-131-4/+17
| | | | | | | | Signed-off-by: Acee Lindem <aceelindem@gmail.com>
* | Merge pull request #13762 from anlancs/doc/pthread-typoDonatas Abraitis2023-06-121-5/+6
|\ \ | | | | | | doc: Adjust pthread description
| * | doc: Adjust pthread descriptionanlan_cs2023-06-121-5/+6
| | | | | | | | | | | | | | | | | | Refer to the latest code, modified the description of pthread. Signed-off-by: anlan_cs <vic.lan@pica8.com>
* | | docker: ubuntu-ci 18.04 -> 22.04, topotest parallel run examplesChristian Hopps2023-06-091-15/+33
| |/ |/| | | | | | | | | | | 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>
* | Merge pull request #13734 from LabNConsulting/chopps/removeunusedJafar Al-Gharaibeh2023-06-091-6/+0
|\ \ | |/ |/| remove mentions of socat
| * doc: update doc removing socat req + remove unused tests codeChristian Hopps2023-06-081-6/+0
| | | | | | | | Signed-off-by: Christian Hopps <chopps@labn.net>
* | doc: Adjust event systemanlan_cs2023-06-081-16/+17
|/ | | | | | Refer to the latest code, modify the description of event system. Signed-off-by: anlan_cs <vic.lan@pica8.com>
* doc: Update reference table for current and upcoming release datesDonatas Abraitis2023-05-311-9/+9
| | | | | | | | 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>
* tests: selecting results by regexp and ragnes, add container supportChristian Hopps2023-05-261-10/+54
| | | | | | | | | | - 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>
* Merge pull request #13586 from ponedo/link-state-doc-fixDonald Sharp2023-05-231-1/+1
|\ | | | | doc: fix typo RFC7572 to RFC7752
| * doc: fix typo RFC7572 to RFC7752ponedo2023-05-231-1/+1
| | | | | | | | Signed-off-by: ponedo <2534164734@qq.com>
* | doc: remove non-existent configure optionIgor Ryzhov2023-05-191-1/+0
| | | | | | | | Signed-off-by: Igor Ryzhov <iryzhov@nfware.com>
* | doc: document optionally required packagesChristian Hopps2023-05-171-2/+12
| | | | | | | | | | | | | | - tshark and valgrind are required but only if you enable those features during test runs. Signed-off-by: Christian Hopps <chopps@labn.net>
* | topotest: add --memleaks topotest optionLou Berger2023-05-111-26/+42
| | | | | | | | Signed-off-by: Lou Berger <lberger@labn.net>
* | doc: update for ubuntu 22.04 and to run topotest with valgrindLou Berger2023-05-112-4/+174
| | | | | | | | Signed-off-by: Lou Berger <lberger@labn.net>
* | doc: python, required by clippy, is no longer a non-essential toolChristian Hopps2023-05-091-1/+2
| | | | | | | | Signed-off-by: Christian Hopps <chopps@labn.net>
* | doc: document --perf and --perf-options, and a bit of cleanupChristian Hopps2023-04-241-2/+23
| | | | | | | | Signed-off-by: Christian Hopps <chopps@labn.net>
* | doc: document new pytest options and cli commandsChristian Hopps2023-04-221-6/+81
| | | | | | | | Signed-off-by: Christian Hopps <chopps@labn.net>
* | Merge pull request #13300 from louis-6wind/iso_docDonald Sharp2023-04-141-1/+1
|\ \ | | | | | | doc: fix the print iso macro documentation
| * | doc: fix the print iso macro documentationLouis Scalbert2023-04-131-1/+1
| | | | | | | | | | | | | | | | | | | | | 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>
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-06 10:36:27 +0100