Commit Graph

281 Commits

Author SHA1 Message Date
Mark Stapp
97cfd5d207 doc: fix typo in archlinux doc
Fix a typo to remove a warning when building the dev
docs.

Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-04-27 08:47:34 -04:00
Donatas Abraitis
9dd78258ff doc: Mention that we should use black code formatter for topotests
black - https://github.com/psf/black

Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
2020-04-05 20:16:01 +03:00
Quentin Young
e9f2bc2427 doc: document JSON conventions
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2020-04-01 12:37:43 -04:00
Lou Berger
8678d6387c *: use the current project name (FRRouting)
Signed-off-by: Lou Berger <lberger@labn.net>
2020-03-25 17:38:56 -04:00
Donatas Abraitis
9a6f9ba174
Merge pull request #6046 from Naveenaidu/builddoc-archlinux
doc: Add build instructions for Arch Linux
2020-03-20 19:11:33 +02:00
Lou Berger
56ddff042a docs: document libyang build magic (from Martin) for centos 6
Signed-off-by: Lou Berger <lberger@labn.net>
2020-03-19 19:51:20 -04:00
Naveen Naidu
248d2d878a doc: Add build instructions for Arch Linux
Signed-off-by: Naveen Naidu <naveennaidu479@gmail.com>
2020-03-19 19:26:58 +05:30
Quentin Young
455699760f doc: CLI source references backwards
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2020-03-09 15:27:25 -04:00
Donald Sharp
67c5e28cb9
Merge pull request #5826 from mjstapp/fix_cli_pfx_doc
doc: correct ip prefix token mapping table
2020-02-19 15:08:08 -05:00
Mark Stapp
05c6b1e4b0 doc: correct ip prefix token mapping table
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-19 09:08:22 -05:00
Donald Sharp
6f29169e06 doc: Fix borked up syntax for static-linking
Fix documentation such that it is displayed as intended.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2020-02-14 14:18:38 -05:00
Donald Sharp
bf9735b240 doc: Fixup some missing syntax
We were missing some syntax indicators for stuff in doc/developer
add them in.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2020-02-14 14:17:52 -05:00
Donald Sharp
93a142e4fc doc: Add some basic how-to for lua
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-02-14 14:17:52 -05:00
Santosh P K
b9e6727acd zebra: Capabality and stale route handling for GR client.
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-31 03:36:37 -08:00
Donatas Abraitis
92ac2692f3
Merge pull request #5728 from opensourcerouting/move_rpm_to_python3
Move rpm to python3
2020-01-28 10:40:08 +02:00
Martin Winter
03d2acc86e doc: Update RedHat packaging description to use Python 3
Signed-off-by: Martin Winter <mwinter@opensourcerouting.org>
2020-01-25 23:00:47 +01:00
Lou Berger
dc935a5147 doc: recommend compiling with sharpd to enable scaling testing
Signed-off-by: Lou Berger <lberger@labn.net>
2020-01-21 06:27:43 -05:00
Quentin Young
cce3ef382e doc: add instructions for static linking
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2020-01-16 12:47:34 -05:00
Donatas Abraitis
6819445cf2 doc: Replace wrong paths for centos/fedora source build instructions
Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
2020-01-10 00:11:09 +02:00
Donatas Abraitis
ca3260476e doc: Use proper numbering for packaging-redhat.rst
Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
2019-12-27 14:03:00 +02:00
Donatas Abraitis
1fe4beb2ed doc: Add a section in Building FRR for CentOS 8
Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
2019-12-27 14:03:00 +02:00
Donald Sharp
8bc6e62914 doc: Update workflow to include new automated testing Requirement
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-17 14:57:15 -05:00
Stephen Worley
118cf7edb0 doc: add doc for easy commit sign-off with -s
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-12-04 11:27:30 -05:00
Donatas Abraitis
a78d1c77fe bgpd: Remove not used bgp_find_nexthop() function
Seems like a dead code.

Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
2019-11-08 15:04:29 +02:00
Quentin Young
8a6b34c260 doc: clean up && index topotest json docs
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-11-04 18:51:31 +00:00
Donald Sharp
16318c5cdc doc: Update documentation to talk about development branches
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-31 20:55:08 -04:00
Quentin Young
972d752122 doc: strip ws, shell -> console
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-10-21 16:11:09 +00:00
Quentin Young
f4bcc72f99 doc: update release procedure docs
Add a lot of detail and update some outdated stuff.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-10-18 18:50:10 +00:00
Quentin Young
b41f3f0a21 doc: fix messed up topotests docs
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-10-18 18:50:10 +00:00
Donald Sharp
36c9027ac7
Merge pull request #5088 from pogojotz/revert-asm-equiv-in-MTYPE
lib: Revert usage of asm-code in MTYPE definitions
2019-10-15 15:49:31 -04:00
Quentin Young
6f7a92544b doc: add style guide for YANG
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-10-09 19:30:10 +00:00
Rafael Zalamena
4260f16567 doc: update topotests doc for address sanitizer
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-08 21:35:06 -03:00
Juergen Werner
ee46da2691 lib: Fix static variable initialization
Signed-off-by: Juergen Werner <juergen@opensourcerouting.org>
2019-10-01 17:27:39 +02:00
Juergen Werner
4d8ebeddc5 lib: Revert usage of asm-code in MTYPE definitions
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-10-01 15:23:00 +02:00
David Lamparter
81047bc5b7 doc: add frr_{each,with} to coding style
Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2019-09-03 17:18:35 +02:00
David Lamparter
6421f2c6d9 doc: add developer docs for frr_with_mutex
Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2019-09-03 17:15:17 +02:00
Donald Sharp
76eb017923
Merge pull request #4497 from opensourcerouting/rcu
RCU support
2019-08-08 08:41:07 -04:00
Donald Sharp
3a738964ec
Merge pull request #4763 from opensourcerouting/ds-work
lib: get rid of pqueue_*, use DECLARE_HEAP in thread.c
2019-08-07 16:45:02 -04:00
Renato Westphal
4d50168e02 doc: suggest the installation of the libcap development library
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-06 15:53:42 -03:00
David Lamparter
e51f518467 doc: add a small FAQ for the typesafe datastructs
Signed-off-by: David Lamparter <equinox@diac24.net>
2019-08-01 16:54:18 +02:00
David Lamparter
3e41733f1b lib: RCU
Please refer to doc/developer/rcu.rst for documentation.

Signed-off-by: David Lamparter <equinox@diac24.net>
2019-07-31 03:34:09 +02:00
Igor Ryzhov
f65d330cbc lib: fix missing M:A:C to X:X:X:X:X:X changes
Signed-off-by: Igor Ryzhov <iryzhov@nfware.com>
2019-07-25 17:15:27 +03:00
Jafar Al-Gharaibeh
7bc33bcc19
Merge pull request #4088 from opensourcerouting/bump-libyang-requirement-vers
build, lib: bump libyang requirement version to >= 0.16.105 (-r3)
2019-07-09 17:59:17 +03:00
Martin Winter
cd68e28aac
Merge pull request #4643 from pguibert6WIND/pytest_compat
doc: inform user to use pytest < version 5.0
2019-07-09 14:42:55 +02:00
Ashish Pant
eb0a7b65a0 doc: Document for topojson changes
Signed-off-by: Ashish Pant <ashish12pant@gmail.com>

Describes topojson framework and guidelines to use it.
2019-07-09 10:26:53 +05:30
Philippe Guibert
fbcf1146db doc: inform user to use pytest < version 5.0
pytest intends to deprecate users not having python 2 on the system.
in order to make topotest work, just use an older pytest version.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2019-07-04 19:50:49 +02:00
Renato Westphal
716ffcc8fe build, lib: bump libyang requirement version to >= 0.16.105
After ~4 months of deprecation period [1], drop support for older
libyang versions that don't support embedded extensions.

In addition to support for embedded extensions, libyang 0.16-r3
contains several bug fixes and performance improvements compared
to libyang-0.16-r1. It was about time to update.

Fixes:
* Issue #3273
* Issue #3971

[1] See commit 68626e08.

Signed-off-by: Renato Westphal <renato@opensourcerouting.org>
2019-07-01 22:59:54 -03:00
Donald Sharp
2bc398c3c4
Merge pull request #4573 from opensourcerouting/mtype_cleanup
MTYPE cleanup pass
2019-06-21 07:40:27 -04:00
David Lamparter
056830ba69 lib: improve MTYPE definitions
The "static struct mtype * const MTYPE_FOO" doesn't quite make a
"constant" that is usable for initializers.  An 1-element array works
better.

Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2019-06-21 08:54:25 +02:00
Stephen Worley
fda5621069 doc: Add firewalld notice in fedora
Add a note in the fedora build guide on how to disable
firewalld and clear iptables that come by default.

Signed-off-by: Stephen Worley <sworley@cumulusnetworks.com>
2019-06-20 12:11:25 -04:00