Commit Graph

513 Commits

Author SHA1 Message Date
Lou Berger
0b984829be
Merge pull request #1989 from qlyoung/defpy-hidden
lib, python: DEFPY_ATTR, DEFPY_HIDDEN
2018-04-11 20:12:25 -04:00
Russ White
058054cac1
Merge pull request #1903 from donaldsharp/PBRD
Pbrd
2018-04-11 09:06:45 -04:00
Quentin Young
d3c2e31675
doc: update style exceptions list
And make note of future policy

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-04-10 13:19:32 -04:00
Quentin Young
e1a8a773a2
Merge pull request #1883 from LabNConsulting/working/master/community-document-checkpatch
COMMUNITY.md: document more details of current coding style process
2018-04-10 12:26:08 -04:00
G. Paul Ziemba
115e70a1b7 doc: workflow.rst: more details of current coding style process
Signed-off-by: G. Paul Ziemba <paulz@labn.net>
2018-04-07 17:24:23 -07:00
kishiguro
db759bb009 Update document about -p 0. When port number is 0, that means do not listen bgp port.
Signed-off-by: Kunihiro Ishiguro <ishi@coreswitch.io>
2018-04-06 14:43:36 -07:00
Quentin Young
6568993b1b doc: bit of cleanup for pbr docs
* Indent is 3 spaces
* Use CLI cross-references
* Wrap to 80 columns
* Adjust section capitalization

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-04-06 13:22:43 -04:00
Donald Sharp
a6c93cb20f doc: Add documentation for PBRD
Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-04-06 13:22:43 -04:00
Russ White
43944e5c11
Merge pull request #2022 from qlyoung/warn-vtysh-u-security
doc: warn users about vtysh / telnet security
2018-04-04 20:54:31 -04:00
Russ White
4c95b7ec0c
Merge pull request #2013 from qlyoung/docuser
doc: add more CLI documentation
2018-04-04 20:53:46 -04:00
Martin Winter
381fec2452
Merge pull request #2023 from LabNConsulting/working/master/confdate+release
Use new way of avoiding deprecated related warnings in non-dev branches
2018-04-05 01:23:37 +01:00
Arthur Jones
19e622d51e alpine packaging: build packages and base image directly from git
Currently, we tar up the git repo before building alpine packages.
This ensures that the packages we're building are exactly what is
checked in.  But, in practice, this restriction causes us to not
be able to build off of git contexts, which is a convenient feature
especially when using docker-compose.

So, here, we build the alpine packages directly from the contents
of the current directory and we install the packages into a base
image to ease downstream consumption.  There is still work to be
done in that area, as we need to package up the daemons, frr user
and all the rest, but that's for later...

Testing-done:

Built directly from the git repo, built from a reference to the
git repo and built using docker-compose, all seemed to work.  Also,
tested by @leleobhz and seems to build fine.

Thanks to Leonardo Amaral (@leleobhz) for reporting the issue and for
the original idea for a fix.

Issue: https://github.com/FRRouting/frr/issues/2024
Signed-off-by: Arthur Jones <arthur.jones@riverbed.com>
2018-04-04 10:05:44 -07:00
Lou Berger
110bb12121 doc: add note and example on use of VERSION_TYPE_DEV and CONFDATE
Signed-off-by: Lou Berger <lberger@labn.net>
2018-04-03 14:04:31 -04:00
Quentin Young
a3ff031191
doc: warn users about vtysh / telnet security
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-04-03 13:53:04 -04:00
Quentin Young
2d75202acc
Merge pull request #1894 from LabNConsulting/working/master/vtysh-not-enabled
vtysh: add -u/--user flag to run commands without enable
2018-04-03 11:50:35 -04:00
Russ White
dad5c29e5f
Merge pull request #2014 from qlyoung/draft-bz-v4goawayflag-00
Revert "zebra: implement draft-bz-v4goawayflag-00"
2018-04-03 11:13:23 -04:00
Martin Winter
a329ad23cf
Merge pull request #1882 from LabNConsulting/working/master/community-dismiss
workflow.rst: add note that author's shouldn't delete a comment or review
2018-04-03 15:54:27 +01:00
Quentin Young
a75b6ff5b1
Revert "zebra: implement draft-bz-v4goawayflag-00"
This reverts commit 3fec765a8d.

April fools!

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-04-02 15:26:06 -04:00
Quentin Young
cb3d8153a3
doc: add more CLI documentation
* Document modes & nodes
* Document walkup behavior
* Document struct cmd_node
* Add graph of node relationships
* Reorder sections to make more logical sense
* Rewrap sections to 80 lines
* Fix code block indent
* Specify language for code blocks in order to get syntax highlighting

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-04-02 15:04:04 -04:00
Quentin Young
3fec765a8d
zebra: implement draft-bz-v4goawayflag-00
Adds support for V4 GoAway flag as described in
https://www.ietf.org/id/draft-bz-v4goawayflag-00.txt

This option allows advertising neighbors to indicate to recipients that
they should disable IPv4 on the link.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-04-01 16:37:24 -04:00
Russ White
5f047032e7
Merge pull request #1984 from donaldsharp/conf_date_master
lib: Remove backwards compatiblity at 1 year
2018-03-30 12:35:53 -04:00
Lou Berger
cab3f81198 doc: add note on use of scripts to enable immediate removale deprecated APIs/macros
Signed-off-by: Lou Berger <lberger@labn.net>
2018-03-30 12:13:54 -04:00
Quentin Young
f22744c31e
doc: cleanup documentation nits
* Ubuntu 18.04 build doc was not included in its toctree
* Duplicate definition of the same CLI command removed

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-03-30 11:09:15 -04:00
Russ White
a7e7b53f57
Merge pull request #1992 from qlyoung/change-alpine-build-doc-title
doc: change title of Alpine build doc
2018-03-30 08:51:44 -04:00
Lou Berger
88507dba34
Merge pull request #1961 from qlyoung/docuser
doc: tweak html body width
2018-03-30 08:10:50 -04:00
Quentin Young
33582b1abe
doc: change title of Alpine build doc
Match the rest of them.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-03-29 14:29:08 -04:00
Donald Sharp
5413757f02 doc: Cleanup a couple of issues in the bgp doc
Add the documentation for 'remote-as [internal|external]`
Cleanup some old obsolete information
Specify that interfaces can be used as a peer in bgp

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-03-28 15:37:25 -04:00
Donald Sharp
e13fd66fc6 doc: Update some bgp set nexthop documentation
Update the BGP route-map 'set ip next-hop' documentation
to include some missing data.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-03-28 15:14:03 -04:00
Lou Berger
5aa5df3995 manpages: vtysh.rst add description of -u/--user flags
Signed-off-by: Lou Berger <lberger@labn.net>
2018-03-28 10:56:06 -04:00
Lou Berger
615e608d76
Merge pull request #1854 from qlyoung/integer-standards-compliance
*: use C99 standard fixed-width integer types
2018-03-28 10:30:54 -04:00
Quentin Young
d7c0a89a3a
*: use C99 standard fixed-width integer types
The following types are nonstandard:
- u_char
- u_short
- u_int
- u_long
- u_int8_t
- u_int16_t
- u_int32_t

Replace them with the C99 standard types:
- uint8_t
- unsigned short
- unsigned int
- unsigned long
- uint8_t
- uint16_t
- uint32_t

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-03-27 15:13:34 -04:00
Quentin Young
28ac5a0381
tools, doc: update checkpatch for u_int_*
* Checkpatch.pl now checks for nonstandard integral types
* Add shell script to replace all nonstandard types with their standard
  counterparts in C source files
* Document usage of types, mention conversion script

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-03-27 15:00:23 -04:00
Martin Winter
1eeedf677e doc: Add Ubuntu 18.04 doc to dist tar
Signed-off-by: Martin Winter <mwinter@opensourcerouting.org>
2018-03-27 07:41:28 -07:00
Martin Winter
d4c798b3cc doc: Add Building instructions for Ubuntu 18.04
Signed-off-by: Martin Winter <mwinter@opensourcerouting.org>
2018-03-27 07:09:11 -07:00
Lou Berger
22265b3584 developer: workflow.rst - fix typo
Signed-off-by: Lou Berger <lberger@labn.net>
2018-03-27 08:11:48 -04:00
Lou Berger
493e3eed5d developer: workflow.rst - add text on how to respond to reviews/comments
add note that author's shouldn't remove a comment or review.
           also add a note that automatically generated comments can
           be deleted by authors and others when such comments are not
           the most results from that automated comment source.

Signed-off-by: Lou Berger <lberger@labn.net>
2018-03-27 08:08:15 -04:00
Russ White
6a32d26634
Merge pull request #1946 from qlyoung/asan-configure-option
frr: add configure flags for sanitizers, document sanitizers
2018-03-26 17:16:53 -04:00
Quentin Young
4386f12983
doc: tweak html body width
The default theme has a css rule that limits the body element width to
800px, which results in sizeable chunk of empty space to the right of
the docs. Add a small css override to remove this limit (like the Python
docs do).

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-03-23 13:20:43 -04:00
Martin Winter
aab81a046e
Merge pull request #1904 from qlyoung/docuser
docs cleanup
2018-03-22 23:39:55 +00:00
Quentin Young
9e00128623
doc: document sanitizers & scanners
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-03-22 14:55:13 -04:00
Quentin Young
0773854304
doc: work around broken makeinfo on centos7
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-03-22 12:01:13 -04:00
Russ White
c6323200a7
Merge pull request #1935 from qlyoung/doc-how-to-style
doc: document code style tools
2018-03-21 14:41:44 -04:00
Quentin Young
2780ae0c5c
doc: use not ` for :file:
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-03-21 12:34:51 -04:00
Quentin Young
4da7fda369
doc: bgp.rst cleanup
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-03-20 15:24:00 -04:00
Quentin Young
d0217a1278
doc: fixup Makefile.am dist sources
Add missing sources. Also took the liberty of sorting the sources
alphabetically.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-03-20 15:20:35 -04:00
Quentin Young
7d4cab4df3
doc: cleanup alpine build doc
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-03-20 15:20:35 -04:00
Quentin Young
5eda4aa864
doc: forgot to add cligraph.* to dist sources
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-03-20 15:20:34 -04:00
Quentin Young
f86e65dfd0
doc: cleanup some misc files
* Translate plaintext stub documenting bgpd preprocessor constants for
  attributes into a RST file and include it in the doctree
* Remove the Markdown version of the OSPF-API document, as I've already
  translated it into RST
* Remove the Markdown version of the modules document, as I've already
  translated it into RST
* Rename the various "Building_FRR_*" documents to match standard RST
  file conventions

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-03-20 15:20:34 -04:00
Quentin Young
88ba7d9e17
doc: cligraph.svg -> cligraph.png, misc cleanup
LaTeX doesn't know how to typeset SVG images, so use a png. Sphinx has a
plugin to automatically convert images to the right format for every
builder but it depends on imagemagick and God only knows what plugin
support is like on Centos 6...

Also correct the name of the BGP typecodes doc in its index file.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-03-20 15:20:34 -04:00
Quentin Young
2e5ac3f476
doc: bgpd.rst title cleanup
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-03-20 15:20:34 -04:00