summaryrefslogtreecommitdiff
path: root/doc/developer
AgeCommit message (Collapse)Author
2020-04-21Merge pull request #6253 from opensourcerouting/fpm-extraQuentin Young
zebra/fpm: fix shutdown and add more documentation
2020-04-21doc: add some Github workflow notesDavid Lamparter
Just writing down what seems to be established procedure. Signed-off-by: David Lamparter <equinox@diac24.net>
2020-04-21doc: document strcpy & sprintf banDavid Lamparter
Signed-off-by: David Lamparter <equinox@diac24.net>
2020-04-20doc: remove mailing list patch submissionDavid Lamparter
Last patch sent in on the mailing list was in July 2018. If someone sends a patch we can still pick it up, but practiced reality is quite clearly PRs on github. Signed-off-by: David Lamparter <equinox@diac24.net>
2020-04-17doc: update FPM documentationRafael Zalamena
Tell users about new FPM implementation and add more documentation about it. Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2020-04-16Merge pull request #6224 from mjstapp/zclient_session_idOlivier Dugeon
lib,zebra: add a session id for zapi sessions
2020-04-16lib,zebra: add a session id for zapi sessionsMark Stapp
Distinguish zapi sessions, for daemons who use more than one, by adding a session id. The tuple of proto + instance is not adequate to support clients who use multiple zapi sessions. Include the id in the client show output if it's present. Add a bit of info about this to the developer doc. Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-04-16Merge pull request #5451 from opensourcerouting/rcu-logSantosh P K
logging subsystem rewrite
2020-04-07doc: logging: clarify per-thread bufferingDavid Lamparter
Log buffer flushing is thread-local. Signed-off-by: David Lamparter <equinox@diac24.net>
2020-04-05doc: Mention that we should use `black` code formatter for topotestsDonatas Abraitis
black - https://github.com/psf/black Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
2020-04-01doc: document JSON conventionsQuentin Young
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2020-04-01doc: new logging subsystemDavid Lamparter
Signed-off-by: David Lamparter <equinox@diac24.net>
2020-03-25*: use the current project name (FRRouting)Lou Berger
Signed-off-by: Lou Berger <lberger@labn.net>
2020-03-20Merge pull request #6046 from Naveenaidu/builddoc-archlinuxDonatas Abraitis
doc: Add build instructions for Arch Linux
2020-03-19docs: document libyang build magic (from Martin) for centos 6Lou Berger
Signed-off-by: Lou Berger <lberger@labn.net>
2020-03-19doc: Add build instructions for Arch LinuxNaveen Naidu
Signed-off-by: Naveen Naidu <naveennaidu479@gmail.com>
2020-03-09doc: CLI source references backwardsQuentin Young
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2020-02-19Merge pull request #5826 from mjstapp/fix_cli_pfx_docDonald Sharp
doc: correct ip prefix token mapping table
2020-02-19doc: correct ip prefix token mapping tableMark Stapp
Fix the table that shows the mapping between ip network cli tokens and the data struct that the cli handler will see. Optional network/subnet types appear as a pointer to an all-zeroes struct, not a NULL pointer. Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-02-14doc: Fix borked up syntax for static-linkingDonald Sharp
Fix documentation such that it is displayed as intended. Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2020-02-14doc: Fixup some missing syntaxDonald Sharp
We were missing some syntax indicators for stuff in doc/developer add them in. Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2020-02-14doc: Add some basic how-to for luaDonald Sharp
Add a couple breadcrumbs to get people up and running with lua when they are trying to develop for it. Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2020-01-31zebra: Capabality and stale route handling for GR client.Santosh P K
Handling capability received from client. It may contain GR enable/disable, Stale time changes, RIB update complete for given AFi, ASAFI and instance. It also has changes for stale route handling. Signed-off-by: Santosh P K <sapk@vmware.com>
2020-01-28Merge pull request #5728 from opensourcerouting/move_rpm_to_python3Donatas Abraitis
Move rpm to python3
2020-01-25doc: Update RedHat packaging description to use Python 3Martin Winter
Signed-off-by: Martin Winter <mwinter@opensourcerouting.org>
2020-01-21doc: recommend compiling with sharpd to enable scaling testingLou Berger
Signed-off-by: Lou Berger <lberger@labn.net>
2020-01-16doc: add instructions for static linkingQuentin Young
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2020-01-10doc: Replace wrong paths for centos/fedora source build instructionsDonatas Abraitis
Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
2019-12-27doc: Use proper numbering for `packaging-redhat.rst`Donatas Abraitis
Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
2019-12-27doc: Add a section in `Building FRR` for CentOS 8Donatas Abraitis
Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
2019-12-17doc: Update workflow to include new automated testing RequirementDonald Sharp
Update the workflow.rst file to outline new requirement for features to include automated testing of some sort. Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2019-12-04doc: add doc for easy commit sign-off with `-s`Stephen Worley
Add some doc to let developers know about the `-s` flag with `git commit`. We were seeing some people writing the sign-off manually. Signed-off-by: Stephen Worley <sworley@cumulusnetworks.com>
2019-11-08bgpd: Remove not used bgp_find_nexthop() functionDonatas Abraitis
Seems like a dead code. Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
2019-11-04doc: clean up && index topotest json docsQuentin Young
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-10-31doc: Update documentation to talk about development branchesDonald Sharp
As per weekly meeting this is an attempt to document about how we as a community will work together on development branches. Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2019-10-21doc: strip ws, shell -> consoleQuentin Young
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-10-18doc: update release procedure docsQuentin Young
Add a lot of detail and update some outdated stuff. Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-10-18doc: fix messed up topotests docsQuentin Young
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-10-15Merge pull request #5088 from pogojotz/revert-asm-equiv-in-MTYPEDonald Sharp
lib: Revert usage of asm-code in MTYPE definitions
2019-10-09doc: add style guide for YANGQuentin Young
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-10-08doc: update topotests doc for address sanitizerRafael Zalamena
Use the `--enable-address-sanitizer` option instead of the manual version using environment flags. This also avoids the problem of having to remember to skip clippy with the custom flags: ``` make -C lib CFLAGS="-g -O2" LDFLAGS="-g" clippy ``` The snippet above is not needed with `--enable-address-sanitizer`! Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2019-10-01lib: Fix static variable initializationJuergen Werner
Signed-off-by: Juergen Werner <juergen@opensourcerouting.org>
2019-10-01lib: Revert usage of asm-code in MTYPE definitionsJuergen Werner
The asm-code was interpreted inconsistently for different platforms. In particular for AArch64 this caused UB, if multiple static MTYPEs where defined in one file. All static MTYPE_* could point to the same memory location (namely the first defined MTYPE) OR to their respective (correct) locations depending on the context of their usage. Signed-off-by: Juergen Werner <juergen@opensourcerouting.org>
2019-09-03doc: add frr_{each,with} to coding styleDavid Lamparter
Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2019-09-03doc: add developer docs for frr_with_mutexDavid Lamparter
Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2019-08-08Merge pull request #4497 from opensourcerouting/rcuDonald Sharp
RCU support
2019-08-07Merge pull request #4763 from opensourcerouting/ds-workDonald Sharp
lib: get rid of pqueue_*, use DECLARE_HEAP in thread.c
2019-08-06doc: suggest the installation of the libcap development libraryRenato Westphal
All FRR Linux packages are built using libcap-dev (or libcap-devel) installed in the system. Update the build instructions to suggest FRR developers to do the same. The main motivation for this is that the seteuid() system call is too expensive and overall less secure compared to using the Linux capabilities framework. Signed-off-by: Renato Westphal <renato@opensourcerouting.org>
2019-08-01doc: add a small FAQ for the typesafe datastructsDavid Lamparter
Signed-off-by: David Lamparter <equinox@diac24.net>
2019-07-31lib: RCUDavid Lamparter
Please refer to doc/developer/rcu.rst for documentation. Signed-off-by: David Lamparter <equinox@diac24.net>