Commit Graph

408 Commits

Author SHA1 Message Date
Jakub Urbańczyk
ac9123240d doc: add documentation for the dataplane batching
Signed-off-by: Jakub Urbańczyk <xthaid@gmail.com>
2020-08-10 21:57:12 +02:00
Rafael Zalamena
d92f5fd847 doc: initial documentation for gRPC
Give the FRR users some examples of gRPC usage in scripts to let them
start experimenting with the new configuration interface provided by
YANG/northbound.

Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2020-08-10 16:39:06 -03:00
Renato Westphal
240b7826f6 build, yang: bump libyang minimum required version to 1.0.184
It's time to say good bye to libyang 0.16.105. The recently
released libyang 1.0.184 includes numerous bug fixes and performance
improvements that we need.

Despite the major version bump from 0.x to 1.x, the libyang API is
the same except for a single backward-incompatible change in the
user types interface (which we're currently not using). Hence no
code changes were necessary to adapt FRR to libyang 1.x.

This commit also reintroduces some leafrefs that needed to be
removed from our YANG modules due to a bug that was present on
libyang 0.16.105.

Signed-off-by: Renato Westphal <renato@opensourcerouting.org>
2020-08-07 14:07:46 -03:00
Pawel Dembicki
1ef8b0b133 doc: Update instructions for building for OpenWrt
Frr was added to official OpenWrt repo. No need to use
unofficial sources from Github PR.

Signed-off-by: Pawel Dembicki <p.dembicki@wb.com.pl>
2020-08-06 14:45:08 +02:00
Donatas Abraitis
c4c3330652
Merge pull request #6693 from qlyoung/doc-value-initialization-practices
Document value initialization practices
2020-07-08 11:04:14 +03:00
Quentin Young
431dd37e6f doc: remove trailing whitespace
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2020-07-07 14:02:35 -04:00
Quentin Young
2787347dfe doc: note preferences for value initialization
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2020-07-07 14:02:29 -04:00
Mark Stapp
d9c43f8f19 doc: add note about generous BGP topotest timeouts
Add note blocks to the topotest and topotest-json dev docs to
emphasize the need for generous BGP retry/convergence timers.

Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-07-07 08:55:31 -04:00
Quentin Young
47563324c3 doc: specify output for json commands w/ no output
JSON commands should always return valid JSON

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2020-07-06 12:07:33 -04:00
Quentin Young
cbd730b98a doc: add docker image build instructions
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2020-06-24 19:14:19 -04:00
Donald Sharp
c78307d68d
Merge pull request #6493 from opensourcerouting/workflow-debian
doc/workflow: write down debian/* branch semantics
2020-06-10 08:15:35 -04:00
Mark Stapp
cdfab16269 doc: update zebra/zapi doc
Add the new OPAQUE zapi messages; a couple of edits.

Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-06-02 08:22:24 -04:00
David Lamparter
32db86a98b doc/workflow: write down debian/* branch semantics
Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2020-06-01 15:02:23 +02:00
Mark Stapp
7d68dd44ff doc: encourage const in the developer doc
Add a little text about using 'const' in the dev doc.

Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-05-28 12:37:51 -04:00
Mark Stapp
252ca75b61 doc: add dev doc for ubuntu 20.04
Add a doc for ubuntu 20 LTS; it's mainly the same as the 18 LTS
doc, with a couple of extra notes.

Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-05-27 08:49:36 -04:00
David Lamparter
daf3441d2b lib: add const iteration & find to typesafe lists
Based on work originally by Mark Stapp <mjs@voltanet.io>.

Make it possible to iterate the typesafe lists in a const
context, as well as find items from them.

Signed-off-by: Mark Stapp <mjs@voltanet.io>
[above signoff was for the original version before modification]
Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2020-05-04 22:13:28 +02:00
David Lamparter
15e9c561b2 Merge commit '97cfd5d207e46a027809125cfb356fd301af0cf5'
(from PR #6137)
2020-05-04 21:02:13 +02:00
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
Quentin Young
e15361b322
Merge pull request #6253 from opensourcerouting/fpm-extra
zebra/fpm: fix shutdown and add more documentation
2020-04-21 11:28:05 -04:00
David Lamparter
70aa675d6c doc: add some Github workflow notes
Just writing down what seems to be established procedure.

Signed-off-by: David Lamparter <equinox@diac24.net>
2020-04-21 03:31:02 +02:00
David Lamparter
08cffeb5d9 doc: document strcpy & sprintf ban
Signed-off-by: David Lamparter <equinox@diac24.net>
2020-04-21 03:30:59 +02:00
David Lamparter
d35c30ca9d doc: remove mailing list patch submission
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-20 23:20:13 +02:00
Rafael Zalamena
9d73613388 doc: update FPM documentation
Tell users about new FPM implementation and add more documentation about
it.

Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2020-04-17 20:18:54 -03:00
Olivier Dugeon
c2c3db58a4
Merge pull request #6224 from mjstapp/zclient_session_id
lib,zebra: add a session id for zapi sessions
2020-04-16 21:12:30 +02:00
Mark Stapp
4e0b5b31b7 lib,zebra: add a session id for zapi sessions
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-16 12:07:54 -04:00
Santosh P K
09133ff4f7
Merge pull request #5451 from opensourcerouting/rcu-log
logging subsystem rewrite
2020-04-16 20:23:44 +05:30
David Lamparter
6c19e557a5 doc: logging: clarify per-thread buffering
Log buffer flushing is thread-local.

Signed-off-by: David Lamparter <equinox@diac24.net>
2020-04-07 15:41:04 +02: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
David Lamparter
0eb5f93863 doc: new logging subsystem
Signed-off-by: David Lamparter <equinox@diac24.net>
2020-04-01 06:53:26 +02: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
Stephen Worley
c7e8718cbd doc: Add systemd-devel to fedora build instruction
systemd-devel is a neccessary package for building frr, added to
the install list.

Signed-off-by: Stephen Worley <sworley@cumulusnetworks.com>
2019-06-12 11:59:21 -04:00
Donald Sharp
3f759ec92f
Merge pull request #4449 from opensourcerouting/py-detect
build: refactor & revamp python autoconf logic
2019-06-07 07:19:35 -04:00
Donald Sharp
695a52fd5e
Merge pull request #4333 from opensourcerouting/printfrr
printfrr() world domination tour
2019-06-05 13:30:42 -04:00
David Lamparter
ca9dfee009 workflow: document current C++ approach
Signed-off-by: David Lamparter <equinox@diac24.net>
2019-06-04 18:12:19 +02:00
David Lamparter
ac97970d24 workflow: update notes for release numbering
People have been complaining our major version number increases to
fast and/or in a meaningless way...

Signed-off-by: David Lamparter <equinox@diac24.net>
2019-06-04 18:04:26 +02:00
David Lamparter
45da32d7a4 build: refactor & revamp python autoconf logic
Signed-off-by: David Lamparter <equinox@diac24.net>
2019-06-04 16:21:20 +02:00
David Lamparter
2a37d6c5df doc: add some printfrr() docs
Signed-off-by: David Lamparter <equinox@diac24.net>
2019-06-03 18:57:31 +02:00
David Lamparter
81af03178b doc: add libtool note
(and document that ASAN/MSAN/TSAN are mutually exclusive while at it)

Signed-off-by: David Lamparter <equinox@diac24.net>
2019-06-02 20:44:38 +02:00
Donald Sharp
a7ed7133b2
Merge pull request #4400 from LabNConsulting/working/master/centos7-doc
fix centos7 build - set SPHINXBUILD to match centos7 yum installed package
2019-05-30 21:22:12 -04:00
Mark Stapp
e60aaed91d doc: clean up memleak section of topotests doc
Cleaned up some repetition (cut-and-paste?) in the topotests
developer doc.

Signed-off-by: Mark Stapp <mjs@voltanet.io>
2019-05-29 11:45:02 -04:00
Lou Berger
3c70fb0119 doc/developer: set SPHINXBUILD to match centos7 yum installed package
Signed-off-by: Lou Berger <lberger@labn.net>
2019-05-28 09:42:33 -04:00
Donald Sharp
493ecb4ffa doc: Update docs to represent changes on the ground
The lists documentation had not been updated to represent
the for_eachXXX to frr_eachXXX changes.  Make it so.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2019-05-25 20:28:35 -04:00
Renato Westphal
173c7642f2
Merge pull request #4364 from FRRouting/doc-libsnmp-dev-debian9
doc: add libsnmp-dev to debian 9 build deps
2019-05-21 15:54:49 -03:00
Quentin Young
c1bcb969a0 doc: add libsnmp-dev to debian 8 & 9 build deps
Needed for `--enable-snmp`

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-05-21 15:49:45 +00:00
David Lamparter
5cb4277dfe lib: add DECLARE_HEAP datastructure
This is an 8-ary heap (cacheline optimized.)  It works as a semi-sorted
kind of middle ground between unsorted and sorted datastructures;  pop()
always returns the lowest item but ordering is only loosely enforced.

Signed-off-by: David Lamparter <equinox@diac24.net>
2019-05-21 05:42:13 +02:00
David Lamparter
fdad523b54 lib: add DECLARE_DLIST (double-linked list)
Turns out we need one of these.  Same API as DECLARE_LIST, but deleting
random items is much faster.

Signed-off-by: David Lamparter <equinox@diac24.net>
2019-05-21 05:18:16 +02:00
Donald Sharp
07dfa57d9b
Merge pull request #4316 from LabNConsulting/working/master/tt-scale-vrfs
bgp_l3vpn_to_bgp_vrf: test adding/removing 50K*2CEs VRF routes
2019-05-16 09:53:12 -04:00
Lou Berger
a191719ee2 doc/developer: topotest now compile should now enable sharpd, alos care most about master
Signed-off-by: Lou Berger <lberger@labn.net>
2019-05-15 21:31:31 +00:00
Renato Westphal
174e8ee1ae
Merge pull request #4309 from nikos-github/frr-doc
doc: Provide info on what pkg to install if mpls-router module is missing
2019-05-13 14:32:18 -03:00
nikos
44f3760caa doc: Provide info on what pkg to install if mpls-router module is missing
The mpls-route module may be missing from Ubuntu 18.4. Provide info on
what pkg to install plus what directory py.test needs to be run from.

Signed-off-by: nikos <ntriantafillis@gmail.com>
2019-05-10 17:17:34 -07:00
Renato Westphal
773fc72b1f
Merge pull request #4242 from donaldsharp/zebra_diet
Zebra diet
2019-05-10 08:29:59 -03:00
Juergen Werner
54e53978fc doc: Fix failing make doc
This build system bug was introduced with 9251d1f596.

Signed-off-by: Juergen Werner <pogojotz@gmx.net>
2019-05-03 20:17:08 +02:00
Donald Sharp
21fee7927f doc: Some minor doc cleanup for new data structures
Noticed during attempts at usage that the documentation
needed a couple small updates:

1) Tell the user which header to include
2) Some functions want the address of the data structure

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2019-05-02 16:21:38 -04:00
Lou Berger
e8b9ad5cdd
Revert "Zebra diet" 2019-05-02 06:54:59 -04:00
Donald Sharp
820b3b6596 doc: Some minor doc cleanup for new data structures
Noticed during attempts at usage that the documentation
needed a couple small updates:

1) Tell the user which header to include
2) Some functions want the address of the data structure

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2019-05-01 20:28:57 -04:00
Lou Berger
31e944a8a7
Merge pull request #3045 from opensourcerouting/atoms
READY: lists/skiplists/rb-trees new API & sequence lock & atomic lists
2019-04-30 10:26:35 -04:00
David Lamparter
737d6e0956 doc: add developer docs for type-safe lists
Signed-off-by: David Lamparter <equinox@diac24.net>
2019-04-27 19:33:45 +02:00
Quentin Young
7c8c9c8827 doc: typo / grammar pass on OSPF API docs
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-04-24 17:41:06 +00:00
Quentin Young
06fa7bb966 doc: add copyright notice from Ralph Keller
Ralph has kindly granted us GPLv2+ license to use this documentation,
and requests that we keep a reference to his name. Add these facts to
the documentation.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-04-24 17:37:09 +00:00
Quentin Young
37f92f2215 doc: cleanup OSPF API server documentation
* Reflow to 80 columns
* Improve markup
* Add --apiserver option to example ospfd invocations
* Add note on requirement of this option to use api server

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-04-22 20:22:00 +00:00
Renato Westphal
45242058ec doc: update libyang build instructions to enable compiler optimizations
libyang defaults CMAKE_BUILD_TYPE to "Debug", which disables compiler
optimizations. We should instruct our users to build libyang in the
"Release" mode so that compiler optimizations are enabled and they
can benefit from the associated performance improvements.

Signed-off-by: Renato Westphal <renato@opensourcerouting.org>
2019-04-16 09:52:20 -03:00
Quentin Young
03e72d8071 doc: document libyang cache bug workaround
Document workaround for
https://github.com/CESNET/libyang/issues/752

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-04-15 19:29:10 +00:00
F. Aragon
39e97e8732
doc: fix typo
Signed-off-by: F. Aragon <paco@voltanet.io>
2019-04-08 16:46:33 +02:00
Quentin Young
7d9a2e6d23 doc: remove unneeded build deps
Remove the following:
* gawk
* dejagnu

Add the following for FreeBSD 9 and OpenBSD 6:
* libexecinfo

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-29 18:56:20 +00:00
Rafael Zalamena
5264c1cc64
Merge pull request #4002 from qlyoung/doc-update-build-docs-fedora
update build docs - Fedora, Ubuntu
2019-03-27 19:31:45 -03:00
Quentin Young
0844023418 doc: update build docs for Ubuntu 14.04
Same as priors

Tested on Ubuntu 14.04

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-26 22:04:49 +00:00
Quentin Young
650c632224 doc: update build docs for Ubuntu 16.04
Same updates as Ubuntu 18.04 doc

Tested on Ubuntu 16.04

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-26 21:16:34 +00:00
David Lamparter
da1a93983a
Merge pull request #3998 from pguibert6WIND/workflow_bug_fixes_older
doc: permit maintenance on more than the 2 last maintenance releases
2019-03-26 16:45:48 +01:00
Quentin Young
ae999ff862 doc: update build docs for Ubuntu 18.04
* Update build package list
* Update ./configure options
* Fix some RST syntax errors
* Use monolithic config examples
* Use compile include snippet
* Reorganize a bit

Tested on Ubuntu 18.04

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-25 20:29:49 +00:00
Quentin Young
4983c2177f doc: update building.rst for new fedora doc
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-25 20:29:49 +00:00
Quentin Young
4ff6f66ac9 doc: reorganize fedora doc a bit
* Use compile include snippet
* Move daemons enable section to end
* Fix a couple syntax errors

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-25 20:29:34 +00:00
Quentin Young
c2793eda33 doc: pull out compile instructions into snippet
We're going to use this same snippet across every build doc so let's
just pull it into its own include file now.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-25 20:21:10 +00:00
Quentin Young
0ac848ab87 doc: mv Fedora 24 docs to cover 24+
Tested these on Fedora 24 and 28, so they should be true for all
versions in-between as well as Fedora 29 and all upcoming versions.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-25 15:48:09 +00:00
Quentin Young
ba8083e5ce doc: update Fedora 24 build doc
* Cross reference RPM build docs
* Add perl and patch to build deps
* Add libyang-pluginsdir to ./configure options
* Change instructions to unified config

Verified on Fedora 28.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-25 15:48:07 +00:00
Quentin Young
63374e1d8b doc: update Fedora 24 build doc style
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-25 15:47:09 +00:00
David Lamparter
46ba857461
Merge pull request #4001 from qlyoung/doc-update-libyang-building
doc: update instructions for building libyang
2019-03-23 14:24:27 +01:00
David Lamparter
cdec5d956b
Merge pull request #3996 from qlyoung/doc-move-rpm-to-devdocs
move rpm build doc to devdocs
2019-03-23 14:22:49 +01:00
Quentin Young
d758f97a24 doc: update instructions for building libyang
* Upstream libyang now works with FRR; use it
* Install libyang to system library directories to satisfy pkg-config
* Remove warnings about ABI version
* Remove outdated binary package links
* Cleanup formatting

Validated that these instructions work on:
- Fedora 24
- Fedora 28.
- Ubuntu 18.04

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-22 18:57:20 +00:00
Quentin Young
9251d1f596 doc: move rpm build doc to dev docs
------------{ <(O.O)> }------------

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-22 16:08:28 +00:00
Philippe Guibert
07ff01d255 doc: permit maintenance on more than the 2 last maintenance releases
it is possible to do some ponctual backporting of bug fixes, on older
than the 2 last maintenance releases.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2019-03-22 15:56:11 +01:00
Quentin Young
924947e412 doc: fix underline level
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-21 18:50:25 +00:00
Ruben Kerkhof
56f0bea718 doc: fix a couple of typos
Found with https://github.com/codespell-project/codespell

Signed-off-by: Ruben Kerkhof <ruben@rubenkerkhof.com>
2019-03-20 20:08:33 +01:00
Martin Winter
f6ff9aa59e doc: Fix path and order in debian package build doc
Signed-off-by: Martin Winter <mwinter@opensourcerouting.org>
2019-02-19 21:34:08 +01:00
David Lamparter
443b605e76 doc/developer: document new Debian packaging
Signed-off-by: David Lamparter <equinox@diac24.net>
2019-02-19 21:32:18 +01:00
David Lamparter
081253fcd5 tools/tarsource.sh: create debian changelog
Signed-off-by: David Lamparter <equinox@diac24.net>
2019-02-19 21:31:18 +01:00
David Lamparter
fbeed19878 doc: drop deprecated Ubuntu 12.04 docs
Signed-off-by: David Lamparter <equinox@diac24.net>
2019-02-19 21:31:18 +01:00
David Lamparter
b3c4c164b5 debian: make package "official"
Move us into place in debian/

Signed-off-by: David Lamparter <equinox@diac24.net>
2019-02-19 21:30:54 +01:00
Quentin Young
ccb50d4e9f
Merge pull request #3816 from opensourcerouting/doc-pager-theme
[master] doc: VTYSH_PAGER docs + new FRR theme
2019-02-19 12:41:08 -05:00
David Lamparter
23ebff805c
Merge pull request #3790 from qlyoung/doc-add-buildessential-libsystemdev-docs
doc: update build dependencies for debian systems
2019-02-19 17:54:25 +01:00
Quentin Young
b02525800b doc: update build dependencies for debian systems
Add build-essential and, for platforms with systemd, libsystemd-dev to
the package list for builds

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-02-19 16:51:34 +00:00
sergey
5ba3319778
XSTRDUP function signature fix
I think  there is a mistake in XSTRDUP function signature.
2019-02-18 16:06:37 +02:00
David Lamparter
856d02a59a doc: orange FRR theme
Signed-off-by: David Lamparter <equinox@diac24.net>
2019-02-18 14:39:13 +01:00
Quentin Young
370c8e079f doc: move topotests docs to developers guide
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-02-05 19:25:16 +00:00
Renato Westphal
65aef3a8bb
Merge pull request #3621 from donaldsharp/modules_doc_update
doc: Update modules.rst to better represent what is needed
2019-01-29 11:58:55 -02:00
Quentin Young
a2bd5d4c8f doc: fix mistaken indentation
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-01-25 16:32:18 +00:00
David Lamparter
02a0df1f22 build, lib/yang: bake in extensions if possible
Starting with libyang 0.16.74, we can load internally embedded yang
extensions instead of going through the file system/dlopen.  Detect
support for this at build time and use if available.

NB: the fallback mechanism will go away in a short while.

Signed-off-by: David Lamparter <equinox@diac24.net>
2019-01-24 17:44:41 +01:00
Renato Westphal
177a547ab2 doc: fix small inconsistencies in the table of zapi command values
Signed-off-by: Renato Westphal <renato@opensourcerouting.org>
2019-01-18 16:06:00 -02:00
Donald Sharp
2a7d947108 doc: Update modules.rst to better represent what is needed
The modules.rst documents how to create a module, let's update
it a bit to reflect what an end user needs to do a bit more.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2019-01-16 09:32:06 -05:00
Renato Westphal
0e3bfb0df7 doc: update build instructions for freebsd on how to obtain libyang
Unfortunately the first version of the FreeBSD libyang port contained
a bug in which the libyang pkginfo file wasn't being installed
correctly in the system, and this prevented the FRR build system from
detecting the library. This bug was already fixed months ago but some
FreeBSD package repositories still have the old bugged version of the
port. This means we can't suggest people to install libyang using
"pkg install" since this causes problems for most people. In this
case, suggest FreeBSD users to build and install libyang manually
as we suggest for other BSD platforms.

This commit should be reverted once all FreeBSD package repositories
are updated with the new version of the libyang port.

Signed-off-by: Renato Westphal <renato@opensourcerouting.org>
2019-01-14 16:34:33 -02:00
Philippe Guibert
e2abcff860 doc: add a community rule to permit usage of GPLv3
explain why GPLv3 must be permitted, and explicitly mention that code
not compatible with GPLv3 is prohibited.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2018-12-17 12:14:48 +01:00
David Lamparter
9c830772cd *: get rid of most daemons.conf references
There's a few left over to get compatibility and not break user
installs, but most is gone.

Signed-off-by: David Lamparter <equinox@diac24.net>
2018-12-06 23:05:48 +01:00
David Lamparter
02968310e0
Merge pull request #2725 from pguibert6WIND/workflow_lts
doc: change workflow to support long term maintenance branches
2018-11-19 16:54:56 +01:00
Philippe Guibert
bd2b4fc346 doc: change workflow to support long term maintenance branches
Add in the workflow the possibility to do long term support.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2018-11-13 17:38:53 +01:00