Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #1704

Merged
merged 100 commits into from
Mar 13, 2018
Merged
Show file tree
Hide file tree
Changes from 90 commits
Commits
Show all changes
100 commits
Select commit Hold shift + click to select a range
d1890d0
doc: begin developer's manual
qlyoung Dec 8, 2017
a42f781
doc: clean up CLI docs
qlyoung Dec 8, 2017
b30de70
doc: change section title for modules docs
qlyoung Dec 8, 2017
b22ba01
doc: more organizing & updating
qlyoung Dec 8, 2017
558669e
doc: add note to document practice changes in docs
qlyoung Dec 11, 2017
8ce7861
doc: add clause for documenting
qlyoung Dec 14, 2017
ab51ead
Revert "doc: add note to document practice changes in docs"
qlyoung Dec 14, 2017
8630065
doc: re-add .gitignore, Makefile for dev docs
qlyoung Dec 14, 2017
42fc5d2
doc: start translating user manual to rst
qlyoung Dec 15, 2017
4652e58
doc: fixup ipv6.rst
qlyoung Dec 20, 2017
2dd0a0e
doc: fixup babeld.rst
qlyoung Dec 20, 2017
8d20986
doc: fixup basic.rst
qlyoung Dec 22, 2017
964b366
doc: make conf.py know about variable substitutions
qlyoung Jan 12, 2018
c3c5a71
doc: fixup bgpd.rst
qlyoung Jan 16, 2018
be46d28
doc: use RST variable substitutions
qlyoung Jan 19, 2018
dc1046f
doc: Frr -> FRR
qlyoung Jan 19, 2018
44f2550
doc: clean up overview.rst, installation.rst
qlyoung Jan 19, 2018
f381786
doc: move routeserver.rst into bgp.rst
qlyoung Jan 19, 2018
fd81009
doc: set 'release' and 'version' again
qlyoung Jan 19, 2018
c2caa29
doc: rename main.rst -> zebra.rst
qlyoung Jan 26, 2018
fce2ac6
doc: remove @group / @end group
qlyoung Jan 26, 2018
a90cfb7
doc: fixup eigrpd.rst
qlyoung Jan 26, 2018
dc5564c
doc: cleanup installation instructions
qlyoung Jan 26, 2018
8fa64b2
doc: @smp{foo} -> ``foo``
qlyoung Jan 26, 2018
07a17e6
doc: shotgun cleanup
qlyoung Jan 26, 2018
a4c5392
doc: replace random @cite{RFC...} with :rfc:...
qlyoung Jan 26, 2018
2731b07
doc: add clicmd role for frr cli
qlyoung Jan 26, 2018
29adcd5
doc: fix cli documentation formatting
qlyoung Jan 26, 2018
dfab266
doc: use :term:, will add glossary later
qlyoung Jan 26, 2018
d50b2aa
doc: use :abbr:
qlyoung Jan 26, 2018
a8c90e1
doc: strip trailing whitespace
qlyoung Jan 26, 2018
ec8404d
doc: remove some more @stuff{}
qlyoung Jan 26, 2018
655cdc3
doc: fixup routemap.rst
qlyoung Jan 29, 2018
50e75a2
doc: cleanup kernel.rst
qlyoung Jan 29, 2018
d1a242f
doc: cleanup multiple
qlyoung Jan 29, 2018
c1a54c0
doc: manually finish conversion
qlyoung Jan 29, 2018
d38549c
Merge branch 'master' into docs-user
qlyoung Jan 30, 2018
a5a48db
doc: additional merging
qlyoung Jan 30, 2018
e3c1296
doc: add pim.rst
qlyoung Jan 30, 2018
cb39e63
doc: manually merge isis.rst
qlyoung Jan 30, 2018
3eb7a2f
doc: reorganize
qlyoung Jan 30, 2018
612b331
doc: remove extraneous texi files
qlyoung Jan 30, 2018
05102dd
doc: move dev doc figures to figures/
qlyoung Jan 31, 2018
a1e276e
doc: overhaul manpages
qlyoung Jan 31, 2018
7bd01bd
doc: copy conf.py for developer's docs
qlyoung Jan 31, 2018
76bd149
doc: remove trailing whitespace
qlyoung Jan 31, 2018
4b44467
doc: remove last bits of texinfo directives
qlyoung Jan 31, 2018
82b7ec1
*: update configure.ac, Makefiles for new manpages
qlyoung Jan 31, 2018
7bed2c9
doc: add targets for user & developer pdf + html
qlyoung Feb 1, 2018
013f976
doc: fixup some build warnings
qlyoung Feb 1, 2018
0efdf0f
doc: clean up cross references
qlyoung Feb 1, 2018
9e146a8
doc: fix more broken refs, restore routeserver.rst
qlyoung Feb 1, 2018
6ee602c
doc: fixup more broken xrefs
qlyoung Feb 2, 2018
9bea107
doc: fixup vnc.rst to only define commands once
qlyoung Feb 2, 2018
6233330
doc: add glossary
qlyoung Feb 2, 2018
11ab532
doc: reference style cleanup
qlyoung Feb 2, 2018
9de103f
doc: document documentation
qlyoung Feb 2, 2018
061dd54
doc: fixup glossary for html build
qlyoung Feb 2, 2018
5a32c42
doc: add logos
qlyoung Feb 2, 2018
c91e9b8
doc: note dependencies necessary to build docs
qlyoung Feb 2, 2018
6180f99
doc: replace manpages Makefile
qlyoung Feb 7, 2018
b60f68e
doc: note appropriate sphinx packages in docs
qlyoung Feb 7, 2018
1a52a8c
debianpkg: add sphinx as build dep
qlyoung Feb 7, 2018
12b7724
doc: fix toctree warning in manpages
qlyoung Feb 7, 2018
50cc712
Merge branch 'master' into docuser
qlyoung Feb 7, 2018
4898758
doc: fix makefiles again
qlyoung Feb 7, 2018
6c74945
doc: use python 2.6 format strings
qlyoung Feb 8, 2018
2f8c365
doc: change html theme, add svg logo
qlyoung Feb 8, 2018
241eff1
doc: include manpage Makefile and conf.py in EXTRA_DIST
qlyoung Feb 12, 2018
79120ae
doc: add everything to makefile
qlyoung Feb 12, 2018
e53d585
doc: document CLI BNF grammar, add DFA figures
qlyoung Feb 13, 2018
3f50501
doc: put correct pkg for Centos6
qlyoung Feb 15, 2018
6be1a07
Merge branch 'master' into docuser
qlyoung Feb 15, 2018
72a475e
debianpkg: update packaging for new docs
qlyoung Feb 16, 2018
9cb4ba0
debianpkg: fixup bad target names
qlyoung Feb 20, 2018
adaf2d6
doc: fallback to sphinx-1.0-build
qlyoung Feb 20, 2018
6165030
doc: fix hardcoded 'make' invocation
qlyoung Feb 22, 2018
b59555c
doc: change info file name from FRR -> frr
qlyoung Feb 22, 2018
3b7c729
doc: Create infodir before writing to it and prefix with DESTDIR
mwinter-osr Feb 23, 2018
351c566
debianpkg: disable pdf build by default
qlyoung Mar 1, 2018
a975744
Merge branch 'master' into docuser
qlyoung Mar 1, 2018
6caf40e
debianpkg: include mtracebis.8
qlyoung Mar 1, 2018
0f2ac0c
doc: s/environment/make
qlyoung Mar 1, 2018
609dee9
redhat: Update spec file for new rst documentation
mwinter-osr Feb 26, 2018
ccd40de
redhat: Update CentOS6 to use python27-sphinx package
mwinter-osr Mar 1, 2018
24a532d
doc: Update Building instructions for CentOS6
mwinter-osr Mar 1, 2018
e221d22
doc: allow env var to ovveride sphinx defaults
qlyoung Mar 5, 2018
e207a4b
doc: prevent `clean` target from building manpages
qlyoung Mar 6, 2018
e3e3aff
doc: sync ospf-sr docs from master
qlyoung Mar 6, 2018
5da3976
Merge branch 'master' into docuser
qlyoung Mar 6, 2018
85dd0c8
doc: update .gitignore
qlyoung Mar 7, 2018
edc33b2
doc: fix make setup
qlyoung Mar 7, 2018
37ba370
doc: change html theme to 'default'
qlyoung Mar 7, 2018
e7cc212
redhat: update frr.spec for doc build changes
qlyoung Mar 7, 2018
8c60fed
doc: disable parallel build
qlyoung Mar 9, 2018
d47ae3d
doc: don't build html by default
qlyoung Mar 9, 2018
1f35b46
Merge branch 'master' into docuser
qlyoung Mar 13, 2018
6d16f23
doc: don't check for sphinx-build on `make clean`
qlyoung Mar 13, 2018
78b4c54
doc: Update CentOS6 doc to use puias repo for updated sphinx
mwinter-osr Mar 13, 2018
65230b5
doc: remove misc trailing whitespace
qlyoung Mar 13, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 0 additions & 18 deletions configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -1875,24 +1875,6 @@ AC_CONFIG_FILES([Makefile
snapcraft/snapcraft.yaml
lib/version.h
tests/lib/cli/test_cli.refout
doc/defines.texi
doc/bgpd.8
doc/isisd.8
doc/ospf6d.8
doc/ospfclient.8
doc/ospfd.8
doc/ldpd.8
doc/ripd.8
doc/eigrpd.8
doc/ripngd.8
doc/pimd.8
doc/mtracebis.8
doc/nhrpd.8
doc/vtysh.1
doc/watchfrr.8
doc/zebra.8
doc/frr.1
doc/frr-args.8
pkgsrc/bgpd.sh pkgsrc/ospf6d.sh pkgsrc/ospfd.sh
pkgsrc/ripd.sh pkgsrc/ripngd.sh pkgsrc/zebra.sh
pkgsrc/eigrpd.sh])
Expand Down
14 changes: 5 additions & 9 deletions debianpkg/backports/ubuntu12.04/debian/rules
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ MULTIPATH ?= 256
WANT_FRR_USER ?= frr
WANT_FRR_VTY_GROUP ?= frrvty

# Don't build PDF docs by default
GENERATE_PDF ?= 0

#
####################################

Expand Down Expand Up @@ -135,18 +138,11 @@ override_dh_auto_configure:
fi

override_dh_auto_build:
#dh_auto_build
$(MAKE)
dh_auto_build -- -C doc draft-zebra-00.txt


# doc/ is a bit crazy
ifeq ($(GENERATE_PDF), 1)
dh_auto_build -- -C doc frr.pdf || true # pdfetex fails with exit code 1 but still produces a good looking .pdf
dh_auto_build -- -C doc user.pdf
endif
rm -vf doc/frr.info
rm -vf doc/user/_build/texinfo/frr.info
dh_auto_build -- -C doc frr.info
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mispelling? Should be uppercase FRR.info
dh_auto_build -- -C doc FRR.info

rm -vf doc/frr.info.html*

override_dh_auto_test:

Expand Down
12 changes: 0 additions & 12 deletions debianpkg/backports/ubuntu14.04/debian/frr.install
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,6 @@ usr/include/frr/
usr/lib/
tools/frr etc/init.d/
usr/share/doc/frr/
usr/share/man/man1/vtysh.1
usr/share/man/man1/frr.1
usr/share/man/man8
usr/share/man/man8/bgpd.8
usr/share/man/man8/ospf6d.8
usr/share/man/man8/ospfd.8
usr/share/man/man8/ripd.8
usr/share/man/man8/ripngd.8
usr/share/man/man8/zebra.8
usr/share/man/man8/isisd.8
usr/share/man/man8/watchfrr.8
usr/share/man/man8/mtracebis.8
usr/share/snmp/mibs/
tools/etc/* etc/
tools/*.service lib/systemd/system
Expand Down
10 changes: 5 additions & 5 deletions debianpkg/backports/ubuntu14.04/debian/rules
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ MULTIPATH ?= 256
WANT_FRR_USER ?= frr
WANT_FRR_VTY_GROUP ?= frrvty

# Don't build PDF docs by default
GENERATE_PDF ?= 0

#
####################################

Expand Down Expand Up @@ -137,16 +140,13 @@ override_dh_auto_configure:
override_dh_auto_build:
#dh_auto_build
$(MAKE)
dh_auto_build -- -C doc draft-zebra-00.txt


# doc/ is a bit crazy
ifeq ($(GENERATE_PDF), 1)
dh_auto_build -- -C doc frr.pdf || true # pdfetex fails with exit code 1 but still produces a good looking .pdf
dh_auto_build -- -C doc user.pdf
endif
rm -vf doc/frr.info
rm -vf doc/_build/texinfo/frr.info
dh_auto_build -- -C doc frr.info
rm -vf doc/frr.info.html*

override_dh_auto_test:

Expand Down
2 changes: 1 addition & 1 deletion debianpkg/control
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Priority: optional
Maintainer: Nobody <nobody@frrouting.org>
Uploaders: Nobody <nobody@frrouting.org>
XSBC-Original-Maintainer: <maintainers@frrouting.org>
Build-Depends: debhelper (>= 7.0.50~), libncurses5-dev, libreadline-dev, texlive-latex-base, texlive-generic-recommended, libpam0g-dev | libpam-dev, libcap-dev, texinfo (>= 4.7), imagemagick, ghostscript, groff, autotools-dev, libpcre3-dev, gawk, chrpath, libsnmp-dev, git, dh-autoreconf, libjson-c-dev, libjson-c2 | libjson-c3, dh-systemd, libsystemd-dev, bison, flex, libc-ares-dev, pkg-config, python (>= 2.7), python-ipaddr
Build-Depends: debhelper (>= 7.0.50~), libncurses5-dev, libreadline-dev, texlive-latex-base, texlive-generic-recommended, libpam0g-dev | libpam-dev, libcap-dev, texinfo (>= 4.7), autotools-dev, libpcre3-dev, gawk, chrpath, libsnmp-dev, git, dh-autoreconf, libjson-c-dev, libjson-c2 | libjson-c3, dh-systemd, libsystemd-dev, bison, flex, libc-ares-dev, pkg-config, python (>= 2.7), python-ipaddr, python-sphinx
Standards-Version: 3.9.6
Homepage: http://www.frrouting.org/

Expand Down
6 changes: 2 additions & 4 deletions debianpkg/frr-doc.docs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,5 @@ AUTHORS
NEWS
README
REPORTING-BUGS
doc/BGP-TypeCode
doc/draft-zebra-00.txt
doc/mpls/
bgpd/BGP4-MIB.txt
doc/user/*.rst
doc/figures/*.png
2 changes: 1 addition & 1 deletion debianpkg/frr-doc.info
Original file line number Diff line number Diff line change
@@ -1 +1 @@
doc/frr.info*
doc/user/_build/texinfo/frr.info
3 changes: 1 addition & 2 deletions debianpkg/frr-doc.install
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
usr/share/info
doc/*.png usr/share/info
doc/user/_build/texinfo/*.png usr/share/info
15 changes: 1 addition & 14 deletions debianpkg/frr.install
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,7 @@ usr/include/frr/
usr/lib/
tools/frr usr/lib/frr
usr/share/doc/frr/
usr/share/man/man1/vtysh.1
usr/share/man/man1/frr.1
usr/share/man/man8
usr/share/man/man8/bgpd.8
usr/share/man/man8/ospf6d.8
usr/share/man/man8/ospfd.8
usr/share/man/man8/ripd.8
usr/share/man/man8/ripngd.8
usr/share/man/man8/zebra.8
usr/share/man/man8/isisd.8
usr/share/man/man8/watchfrr.8
usr/share/man/man8/frr-args.8
usr/share/man/man8/mtracebis.8
usr/share/snmp/mibs/
tools/etc/* etc/
tools/*.service lib/systemd/system
tools/*.service lib/systemd/system
debian/frr.conf usr/lib/tmpfiles.d
24 changes: 15 additions & 9 deletions debianpkg/frr.manpages
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
doc/bgpd.8
doc/ospf6d.8
doc/ospfd.8
doc/ripd.8
doc/ripngd.8
doc/vtysh.1
doc/zebra.8
doc/isisd.8
doc/watchfrr.8
doc/manpages/_build/man/frr.1
doc/manpages/_build/man/bgpd.8
doc/manpages/_build/man/pimd.8
doc/manpages/_build/man/eigrpd.8
doc/manpages/_build/man/ldpd.8
doc/manpages/_build/man/nhrpd.8
doc/manpages/_build/man/ospf6d.8
doc/manpages/_build/man/ospfd.8
doc/manpages/_build/man/ripd.8
doc/manpages/_build/man/ripngd.8
doc/manpages/_build/man/vtysh.1
doc/manpages/_build/man/zebra.8
doc/manpages/_build/man/isisd.8
doc/manpages/_build/man/watchfrr.8
doc/manpages/_build/man/mtracebis.8
13 changes: 5 additions & 8 deletions debianpkg/rules
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ MULTIPATH ?= 256
WANT_FRR_USER ?= frr
WANT_FRR_VTY_GROUP ?= frrvty

# Don't build PDF docs by default
GENERATE_PDF ?= 0

#
####################################

Expand Down Expand Up @@ -136,18 +139,12 @@ override_dh_auto_configure:
fi

override_dh_auto_build:
#dh_auto_build
$(MAKE)
dh_auto_build -- -C doc draft-zebra-00.txt


# doc/ is a bit crazy
ifeq ($(GENERATE_PDF), 1)
dh_auto_build -- -C doc frr.pdf || true # pdfetex fails with exit code 1 but still produces a good looking .pdf
dh_auto_build -- -C doc user.pdf
endif
rm -vf doc/frr.info
rm -vf doc/user/_build/texinfo/frr.info
dh_auto_build -- -C doc frr.info
rm -vf doc/frr.info.html*

override_dh_auto_test:

Expand Down
3 changes: 3 additions & 0 deletions doc/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,6 @@ stamp-vti
*~
*.loT
refix
_build
_static
_template
96 changes: 0 additions & 96 deletions doc/Building_FRR_for_LEDE-OpenWRT.md

This file was deleted.

Loading