Commit Graph

151 Commits

Author SHA1 Message Date
Quentin Young
9b6a13adc4 doc: ignore libyang-building.rst in sources
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-10-28 02:06:30 +00:00
Renato Westphal
f805c84eaf doc: update libyang build instructions
The --with-yangmodelsdir and --with-libyang-pluginsdir build-time options
pertain to FRR so they shouldn't be placed along with the libyang build
instructions. Move these instructions to where they belong to avoid
confusion.

Signed-off-by: Renato Westphal <renato@opensourcerouting.org>
2018-11-03 15:42:56 -02:00
Christian Franke
e7f4117541 doc: Add building-libyang.rst to distfiles
Signed-off-by: Christian Franke <chris@opensourcerouting.org>
2018-11-01 14:03:09 +01:00
Lou Berger
aedd2f8515 doc: add info on libyang install and configure options
Signed-off-by: Lou Berger <lberger@labn.net>
2018-10-31 08:31:46 -04:00
Renato Westphal
fc5a4adc5d doc: add build instructions for libyang
These instructions are intended to be temporary until we have libyang
packages available for all supported platforms.

Signed-off-by: Renato Westphal <renato@opensourcerouting.org>
2018-10-27 16:16:12 -02:00
Lou Berger
b3c8d34291
Merge pull request #3032 from donaldsharp/bgp_info
`struct bgp_info` to `struct bgp_path_info`
2018-10-11 09:17:31 -04:00
Renato Westphal
dde90f1e7c doc: simplify build instructions
Remove all --enable-xxx configuration flags for features that are enabled
by default.

Signed-off-by: Renato Westphal <renato@opensourcerouting.org>
2018-10-10 11:14:37 -03:00
Renato Westphal
345c140ec2 doc: update build instructions for Debian 9
The instruction to checkout to the stable/3.0 branch doesn't belong
here.

Signed-off-by: Renato Westphal <renato@opensourcerouting.org>
2018-10-10 11:14:37 -03:00
Renato Westphal
9580f50deb doc: remove LibXML from the list of dependencies
Signed-off-by: Renato Westphal <renato@opensourcerouting.org>
2018-10-10 11:14:37 -03:00
Donald Sharp
4b7e606625 bgpd: Convert struct bgp_info to struct bgp_path_info
Do a straight conversion of `struct bgp_info` to `struct bgp_path_info`.
This commit will setup the rename of variables as well.

This is being done because `struct bgp_info` is not descriptive
of what this data actually is.  It is path information for routes
that we keep to build the actual routes nexthops plus some extra
information.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-10-09 14:14:25 -04:00
Martin Winter
ad6707b564
Merge pull request #3108 from dmbaturin/master
Add a script for building a Debian package in one step.
2018-10-02 16:58:12 +02:00
Daniil Baturin
836ad9fb4e tools: add a script for building a Debian package in one step.
The script simplifies the relatively lengthy procedure.
It should be invoked from the top level source directory, for example:
./tools/build-debian-package.sh

Signed-off-by: Daniil Baturin <daniil@baturin.org>
2018-10-01 20:44:01 +02:00
jpmondet
1c64265f86
frr-reload.py: Add python2 & python3 compatibility.
Signed-off-by: jpmondet <jp@mondet.org>
2018-09-26 21:45:33 +02:00
Quentin Young
e12ea4bb86 doc: document CLI deprecation period length
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-09-17 16:48:11 +00:00
Donald Sharp
2f62815fed doc: Fixup to use consistent frrvty group name
In some places we were using `frrvt` instead of `frrvty`.  Make it consistent
with every other place and use frrvty.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-09-10 08:46:50 -04:00
David Lamparter
a214288c50 build: move SPHINXBUILD= to configure in rpm build
Need to pass this on configure now to work properly.

Signed-off-by: David Lamparter <equinox@diac24.net>
2018-09-09 20:01:08 +02:00
David Lamparter
aad24c5ba6 build: remove common.am
Fold things into where they make sense.

Signed-off-by: David Lamparter <equinox@diac24.net>
2018-09-08 21:26:54 +02:00
Quentin Young
2862f9e185 doc: fix building.rst index
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-09-04 19:28:42 +00:00
Quentin Young
ecaadbaeb4 doc: update subdir.am
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-08-31 17:15:14 +00:00
Quentin Young
09b67c0938 doc: update misc build docs
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-08-31 17:13:31 +00:00
Quentin Young
fff24a2e73 doc: name correct sphinx package under FreeBSD 11
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-08-31 17:13:31 +00:00
Quentin Young
8ba7845f5e doc: rename building_frr_on* -> building_frr_for*
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-08-31 17:13:31 +00:00
David Lamparter
9e53b31551 build: non-recursive doc + parallel sphinx
Sphinx actually does work with a parallel build, if the doctree creation
is a separate step (which the other builds will then just read
unmodified.)  This can be done with the "dummy" target.

This also adds "-j6" to sphinx-build and adds a "--disable-doc-html"
switch on ./configure to turn on/off building HTML docs separately.

Also, HTML docs are now installed by "make install" to
/usr/share/doc/frr/html.

Signed-off-by: David Lamparter <equinox@diac24.net>
2018-08-30 08:06:44 +02:00
Quentin Young
4ebfd799c0
Merge pull request #2917 from opensourcerouting/doc-devel-openwrt
doc/developer/openwrt: Update instructions for building for OpenWRT
2018-08-29 11:39:07 -04:00
Lou Berger
7e678379ed doc: add comment on closing PRs
Signed-off-by: Lou Berger <lberger@labn.net>
2018-08-29 09:48:12 +02:00
Lou Berger
01bf2ccbdb doc: add comment on PR title and description
Signed-off-by: Lou Berger <lberger@labn.net>
2018-08-29 09:48:12 +02:00
Christian Franke
625b8bc2a4 doc/developer/openwrt: Update instructions for building for OpenWRT
Signed-off-by: Christian Franke <chris@opensourcerouting.org>
2018-08-27 11:06:21 +02:00
Quentin Young
7968503909
Merge pull request #2891 from opensourcerouting/logging-docs
doc/developer: logging guide
2018-08-24 16:29:46 -04:00
Donald Sharp
0477276088 doc, lib, zebra: Remove deprecated encode and decode functionality
The ZEBRA_IPV4_ROUTE_[ADD|DELETE] and ZEBRA_IPV6_ROUTE_[ADD|DELETE] functionality
has been deprecated for a year now, let's remove this code from the system.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-08-24 10:56:15 -04:00
David Lamparter
3e5d2f718a doc/developer: logging guide
This roughly outlines when to use which logging function.  It's
certainly something to have to point people to, so they get things nice
and right - and so we get at least somewhat consistent behaviour for the
user.

Signed-off-by: David Lamparter <equinox@diac24.net>
2018-08-22 17:39:34 +02:00
Donald Sharp
c4aee4fe31
Merge pull request #2652 from LabNConsulting/working/master/confdate_cleanup
Simplify deprecation check
2018-07-23 08:46:26 -04:00
Emanuele Di Pascale
9e2f406adb doc: add cmd line param section to modules.rst
Signed-off-by: Emanuele Di Pascale <emanuele@voltanet.io>
2018-07-19 18:28:25 +02:00
Lou Berger
e60dd6cae4 doc: update doc to no longer requires use of VERSION_TYPE_DEV
Signed-off-by: Lou Berger <lberger@labn.net>
2018-07-10 16:19:30 -04:00
Quentin Young
11acdeacaf
Merge pull request #2553 from opensourcerouting/release_proc
doc: Add document for Release Build by maintainer
2018-07-10 15:39:49 -04:00
Quentin Young
5931e2599b doc: cleanup maintainer release document
* Sphinx numbered lists use 1. not 1)
* Indents are three spaces
* Blocks under lists should be indented along with the rest of the list
  content
* Sphinx converts :: to : when used as a code block marker
* Apply some preformatted markup to things that should be preformatted
* Remove trailing whitespace

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-07-10 19:39:39 +00:00
Martin Winter
20e9d2ccea doc: Add document for Release Build by maintainer
Signed-off-by: Martin Winter <mwinter@opensourcerouting.org>
2018-07-10 00:49:28 -07:00
Quentin Young
590a7368df doc: add dev docs on code review practices
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-07-09 18:32:01 +00:00
Quentin Young
b682099337 doc: update workflow.rst
* Rewrap lines to 80 characters
* Update some portions to reflect current practices
* Clean up some formatting (indent, markup, etc)
* Reorganize sections on patch submission
* Remove link to nonexistent github wiki page

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-06-15 18:38:38 +00:00
MasterofJOKers
3f4f5b0437 doc: Correct wiki URL in workflow-documentation
The organization on github is called "FRRouting".

Signed-off-by: MasterofJOKers <joker@someserver.de>
2018-06-14 09:33:32 +02:00
Quentin Young
a86dc99646
Merge pull request #2376 from mjstapp/doc_link
doc: fix broken link to 'code formatting' section
2018-06-05 17:30:07 -04:00
Mark Stapp
c964e51136 doc: fix broken link to 'code formatting' section
Mismatch in rst source was producing a dead link in the html output

Signed-off-by: Mark Stapp <mjs@voltanet.io>
2018-06-05 15:32:07 -04:00
Lou Berger
ba89f1597a
Merge pull request #2367 from qlyoung/docuser
doc: document 'show cli graph'
2018-06-05 12:09:41 -04:00
Quentin Young
8957c78a9e doc: document 'show cli graph'
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-06-04 20:20:31 +00:00
Quentin Young
44ee1b20c0 *: remove update-autotools
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-24 22:45:49 +00:00
Quentin Young
ac40b262ef doc: remove duplicated packages from dep list
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-23 15:35:41 +00:00
Quentin Young
79871dbfcf doc: make frr a system group
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-22 21:46:08 +00:00
Quentin Young
07c40b22af doc: add install-info build dependency
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-22 21:46:02 +00:00
Quentin Young
d60d744157 doc: remove recommendation against integrated conf
Missed this in code review

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-22 21:14:00 +00:00
Quentin Young
f448f9145f doc: clean up 18.04 build doc
Some excess underlines, 4-space indents and typos cleaned up.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-22 21:14:00 +00:00
Quentin Young
9eb51ce361 doc: fix distclean
Apparently Automake has some undocumented logic somewhere that makes it
so any Makefile generated from an Automake Makefile.am is removed from
its secret list of things to delete that it deletes when performing a
recursive distclean before actually performing the recursive distclean
and since the secret list is automatically generated from the list of
things that Autoconf should generate in configure.ac we can't remove the
Makefile from that list or it will break Automake's list of things to
automatically generate that it generates from Autoconf's list of things
to automatically generate.

Thus, to prevent Automake from deleting Makefiles and then immediately
trying to use the Makefiles it just deleted to delete said Makefiles, we
must remove ourselves from the secret list, which is accomplished by
changing the file extension to '.am' instead of '.in'.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-18 19:35:24 +00:00