summaryrefslogtreecommitdiffstats
path: root/doc/developer (follow)
Commit message (Collapse)AuthorAgeFilesLines
* doc: Update workflow.rst for release managementDonald Sharp2022-02-091-4/+7
| | | | | | Some release management updates Signed-off-by: Donald Sharp <sharpd@nvidia.com>
* doc: the dev tag should come after the new version commit stepJafar Al-Gharaibeh2022-02-081-2/+2
| | | | Signed-off-by: Jafar Al-Gharaibeh <jafar@atcorp.com>
* Merge pull request #10417 from Orange-OpenSource/TERuss White2022-02-081-0/+196
|\ | | | | Add Constraints Shortest Path First algorithm
| * lib: Add CSPF Path Computation algorithmOlivier Dugeon2022-02-021-0/+196
| | | | | | | | | | | | | | | | | | | | | | | | | | | | As helper function of Segment Routing Flex Algo or RSVP-TE add Constrained Shortest Path First algorithm able to compute path with constraints. Supported constraints are as follow: - Standard IGP metric - TE IGP metric - Delay metric - Bandwidth for given Class of Service for bandwidth reservation (RSVP-TE) Usage of CSPF algorithms is detailed in the doc/developer/cspf.rst file Signed-off-by: Olivier Dugeon <olivier.dugeon@orange.com>
* | doc: Add a commands snippet to workflow about what to do in the 1st phaseDonatas Abraitis2022-02-051-12/+43
|/ | | | | | What we should do when creating stabilization branch from the master. Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
* doc: cleanup submitting patches and enhancementsIgor Ryzhov2022-01-171-12/+2
| | | | | | Remove some remains from the times when patches were accepted via email. Signed-off-by: Igor Ryzhov <iryzhov@nfware.com>
* lib: add `%pTH` / `%pTHD` for printing thread infoDavid Lamparter2022-01-141-0/+22
| | | | | | Refer to docs in doc/developer for details. Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
* lib: add time formatting printfrr extsDavid Lamparter2022-01-141-0/+116
| | | | | | Refer to docs in doc/developer for details. Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
* lib: add `s` option to `pI4`/`pI6`/`pIA` printfrrDavid Lamparter2022-01-141-0/+6
| | | | | | | | Adding an `s` after these printfrr specifiers replaces 0.0.0.0 / :: in the output with a star (`*`). This is primarily intended for use with multicast, e.g. to print `(*,G)`. Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
* pimd: move `%pSG4` to `%pPSG4`David Lamparter2022-01-121-2/+2
| | | | | | | Since this is only used in very few places, moving it out of the way is reasonable. (`%pSG` will be pim_sgaddr) Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
* doc: Adding the Design document for PIM IPv6Mobashshera Rasool2022-01-102-0/+0
| | | | | | | | | Added the High Level design for implementing MLD and PIMv6. Added a PPT as well in case someone wants to translate it to some other language. Signed-off-by: Mobashshera Rasool <mrasool@vmware.com>
* bgpd: Deprecate DPA, ADVERTISER and RCID_PATH path attributesDonatas Abraitis2022-01-061-3/+0
| | | | | | rfc6938 Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
* docs: clarify topotest requirementsMark Stapp2022-01-051-6/+7
| | | | | | The developer docs weren't clear about some pre-reqs. Signed-off-by: Mark Stapp <mstapp@nvidia.com>
* tools: add a script to generate draft release changelogJafar Al-Gharaibeh2021-12-061-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This utility script helps in generated formatted and consistent change log including: 1- group logs per daemon 2- standarize daemon names (lowercase, end with d) 3- capitalize all log lines 4- no merge commits caveat: comments are assumed to be in the form daemon-name : message Sample Output: ``` sharpd Follow the practice on cli design for json output Install route supports nexthop-seg6 (step3) Install_routes_helper support zapi_route flags (step1) snapcraft Add missing dependency Add pathd to frr snap daemons Change base to ubuntu 18.04 and libyang 2.0.7 staticd Convert typedef to enum Fix distance processing Fix late initialization of blackhole type Output config using nb callbacks instead of operational data ``` Signed-off-by: Jafar Al-Gharaibeh <jafar@atcorp.com>
* Merge pull request #10008 from qlyoung/update-process-docsJafar Al-Gharaibeh2021-11-241-69/+115
|\ | | | | doc: update release process
| * doc: fix wrong reference to release filenameQuentin Young2021-11-101-1/+1
| | | | | | | | Signed-off-by: Quentin Young <qlyoung@nvidia.com>
| * doc: many process fixes / reordersQuentin Young2021-11-091-33/+61
| | | | | | | | | | | | | | | | | | | | | | * Separate process into stages; stage 1 is preparation, stage 2 is staging, stage 3 is publishing * Reorder some steps * Remove some steps * Elaborate on some steps * Add some steps Signed-off-by: Quentin Young <qlyoung@nvidia.com>
| * doc: change instructions for running release testsQuentin Young2021-11-091-5/+7
| | | | | | | | Signed-off-by: Quentin Young <qlyoung@nvidia.com>
| * doc: update docs details in release procedureQuentin Young2021-11-091-2/+8
| | | | | | | | Signed-off-by: Quentin Young <qlyoung@nvidia.com>
| * doc: use sphinx auto-numbering in release docsQuentin Young2021-11-091-61/+62
| | | | | | | | Signed-off-by: Quentin Young <qlyoung@nvidia.com>
| * doc: update release processQuentin Young2021-11-081-15/+24
| | | | | | | | | | | | | | | | Clarify process for editing changelog and updating the configure.ac project version, as well as procedure for doing sanity testing prior to creating the release tag. Signed-off-by: Quentin Young <qlyoung@nvidia.com>
* | doc: update & clarify language in process arch docQuentin Young2021-11-121-22/+26
| | | | | | | | | | | | | | | | | | There was a historical blurb at the top of the process architecture document that in several instances caused some confusion regarding whether or not FRR supports multithreading. Remove this paragraph and replace it with a summary of the page contents. Signed-off-by: Quentin Young <qlyoung@nvidia.com>
* | doc: stick `libunwind` into build docsDavid Lamparter2021-11-1013-10/+38
|/ | | | | | | | It's strictly optional, but… the backtraces are really much better. Specifically, `libunwind` is notably more capable in figuring out function names compared to glibc/libexecinfo `backtrace_symbols()`. Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
* doc/developer: add _member and _anywhereDavid Lamparter2021-10-191-0/+27
| | | | | | New members in the typesafe.h API club. Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
* doc/developer: fix duplicate const prototypesDavid Lamparter2021-10-141-4/+4
| | | | | | The const ones have const in the name. Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
* doc/developer: use :c:macro: where appropriateDavid Lamparter2021-10-142-10/+14
| | | | | | | Sphinx tries to parse :c:function: as function prototype, which doesn't quite work with macros. Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
* doc/developer: fix warnings in topotests docDavid Lamparter2021-10-142-6/+6
| | | | | | | | Sphinx warns about a few nits here, just fix. (Note :option:`-E` can't be used without a "option:: -E" definition, it's intended as a cross reference.) Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
* doc/developer: fix C struct referencesDavid Lamparter2021-10-144-17/+18
| | | | | | Sphinx wants `c:struct:: foo` rather than `c:type:: struct foo`. Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
* Merge pull request #9684 from opensourcerouting/printfrr-false-positiveDonald Sharp2021-10-141-0/+49
|\ | | | | *: `frr-format` with unmodified GCC
| * *: `frr-format` with unmodified GCCDavid Lamparter2021-09-281-0/+49
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Since there's very few locations where the `frr-format` actually prints false positive warnings, consensus seems to be to just work around the false positives even if the code is correct. In fact, there is only one pattern of false positives currently, in `bfdd/dplane.c` which does `vty_out("%"PRIu64, (uint64_t)be64toh(...))`. The workaround/fix for this is a replacement `be64toh` whose type is always `uint64_t` regardless of what OS we're on, making the cast unnecessary. Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
* | doc/developer: document dev tag on masterDavid Lamparter2021-10-061-0/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | We have `frr-X.Y-dev` tags on master after pulling stable branches, otherwise the `gitversion` tooling / `--with-pkg-git-version` gets _very_ confused (it'll print something like: ``` FRRouting 8.2-dev-g210a75e65dad (areia). Copyright 1996-2005 Kunihiro Ishiguro, et al. This is a git build of frr-8.1-rc1-8-g210a75e65dad ``` (Note the conflicting version numbers.) Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
* | doc: add sudo environment setup info for topotestsChristian Hopps2021-09-271-23/+59
|/ | | | Signed-off-by: Christian Hopps <chopps@labn.net>
* Merge pull request #9659 from idryzhov/dev-doc-fixQuentin Young2021-09-241-0/+1
|\ | | | | doc: fix code block in grpc docs
| * doc: fix code block in grpc docsIgor Ryzhov2021-09-231-0/+1
| | | | | | | | | | | | | | The code block after the :: is not displayed correctly without an empty line in between. Signed-off-by: Igor Ryzhov <iryzhov@nfware.com>
* | doc/workflow: prefer typesafe containersDavid Lamparter2021-09-221-0/+33
|/ | | | | | | | | | | | | | | | | The typesafe containers have been around for quite a while now and haven't gone up in a blaze of flames, so let's add a "strong recommendation" to use them for new code and refactors. For the nhrpd custom lists I'm already working to remove them; meanwhile the old skiplists are primarily used in RFAPI (4 users outside of that), so those could be next. What remains are the old `list_*` and `hash_*`, which have >300 and >100 users respectively, making them a much harder problem to tackle. And the new hash implementation doesn't have the same level of debug/introspection yet (it's on my TODO.) Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
* Merge pull request #9596 from LabNConsulting/ziemba/printfrr-nexthopDonald Sharp2021-09-161-0/+4
|\ | | | | printfrr %pNHcg, %pNHci
| * lib,doc,tests: printfrr %pNHcg, %pNHciG. Paul Ziemba2021-09-141-0/+4
| | | | | | | | Signed-off-by: G. Paul Ziemba <paulz@labn.net>
* | Merge pull request #9558 from LabNConsulting/ziemba/doc-cli-new-nodeDonald Sharp2021-09-131-0/+166
|\ \ | | | | | | doc/developer: how to add a CLI node
| * | doc/developer: adding a CLI node: mention frr-reload.py and VTY_PUSH_XPATHG. Paul Ziemba2021-09-071-3/+41
| | | | | | | | | | | | Signed-off-by: G. Paul Ziemba <paulz@labn.net>
| * | doc/developer: how to add a CLI nodeG. Paul Ziemba2021-09-031-0/+128
| |/ | | | | | | Signed-off-by: G. Paul Ziemba <paulz@labn.net>
* | Merge pull request #9573 from LabNConsulting/chopps/update-templateDonald Sharp2021-09-101-20/+22
|\ \ | | | | | | tests: update the test template and doc
| * | tests: update the test template and docChristian Hopps2021-09-081-20/+22
| | | | | | | | | | | | | | | | | | | | | - Update the template and documentation to use newer pytest fixutres for setup and teardown, as well as skipping tests when the suite fails. Signed-off-by: Christian Hopps <chopps@labn.net>
* | | Merge pull request #9497 from opensourcerouting/cli-better-noQuentin Young2021-09-091-0/+5
|\ \ \ | |/ / |/| |
| * | lib: add `![...]` syntax for easy "no" formsDavid Lamparter2021-08-261-0/+5
| |/ | | | | | | | | | | | | | | | | | | This allows defining a CLI command like this: `[no] some setting ![VALUE]` with VALUE being optional for the "no" form, but required for the positive form. It's just a `[...]` where the empty branch can only be taken for commands starting with `no`. Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
* | Merge pull request #9566 from LabNConsulting/chopps/easy-fancy-json-setupDonald Sharp2021-09-081-81/+62
|\ \ | | | | | | tests: new improved simple JSON template w/ doc update
| * | tests: new improved simple JSON template w/ doc updateChristian Hopps2021-09-051-81/+62
| | | | | | | | | | | | | | | | | | | | | | | | | | | Utilizes new pytest fixtures to completely factor out setup and teardown functionality. Supply the JSON config and write your tests. "The best topotest template yet!" Signed-off-by: Christian Hopps <chopps@labn.net>
* | | doc: don't use abbreviateHiroki Shirokura2021-09-071-2/+2
| | | | | | | | | | | | Signed-off-by: Hiroki Shirokura <slank.dev@gmail.com>
* | | topotests: to create pid file of topotest routerHiroki Shirokura2021-09-071-0/+26
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Create a pid file for the router created by topotest. By executing nsenter directly against this pid, developers can execute commands directly from outside the unet shell. This allows the developer to use script, tab completion, etc., and improves efficiency. Signed-off-by: Hiroki Shirokura <slank.dev@gmail.com>
* | | Merge pull request #9563 from opensourcerouting/build-strict-prototypesDonald Sharp2021-09-061-0/+14
|\ \ \ | |/ / |/| | build: `-Wstrict-prototypes` (+ BSD `sed`)
| * | doc/developer: add warning pointersDavid Lamparter2021-09-021-0/+14
| |/ | | | | | | | | | | | | These two warnings are easy to get confused by, note down some pointers on what they actually mean. Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-12 08:25:59 +0100