summaryrefslogtreecommitdiff
path: root/doc/developer
diff options
context:
space:
mode:
Diffstat (limited to 'doc/developer')
-rw-r--r--doc/developer/building-frr-for-centos6.rst15
-rw-r--r--doc/developer/building-frr-for-centos7.rst8
-rw-r--r--doc/developer/building-frr-for-fedora24.rst8
-rw-r--r--doc/developer/building.rst34
-rw-r--r--doc/developer/cli.rst2
-rw-r--r--doc/developer/workflow.rst2
6 files changed, 35 insertions, 34 deletions
diff --git a/doc/developer/building-frr-for-centos6.rst b/doc/developer/building-frr-for-centos6.rst
index d4c2c3bfd0..5f10f3715d 100644
--- a/doc/developer/building-frr-for-centos6.rst
+++ b/doc/developer/building-frr-for-centos6.rst
@@ -128,8 +128,8 @@ Add frr groups and user
.. code-block:: shell
sudo groupadd -g 92 frr
- sudo groupadd -r -g 85 frrvt
- sudo useradd -u 92 -g 92 -M -r -G frrvt -s /sbin/nologin \
+ sudo groupadd -r -g 85 frrvty
+ sudo useradd -u 92 -g 92 -M -r -G frrvty -s /sbin/nologin \
-c "FRR FRRouting suite" -d /var/run/frr frr
Download Source, configure and compile it
@@ -158,7 +158,7 @@ an example.)
--enable-ospfapi=yes \
--enable-user=frr \
--enable-group=frr \
- --enable-vty-group=frrvt \
+ --enable-vty-group=frrvty \
--enable-rtadv \
--disable-exampledir \
--enable-watchfrr \
@@ -168,10 +168,11 @@ an example.)
--enable-eigrpd \
--enable-babeld \
--with-pkg-git-version \
- --with-pkg-extra-version=-MyOwnFRRVersion
- make SPHINXBUILD=sphinx-build2.7
- make check PYTHON=/usr/bin/python2.7 SPHINXBUILD=sphinx-build2.7
- sudo make SPHINXBUILD=sphinx-build2.7 install
+ --with-pkg-extra-version=-MyOwnFRRVersion \
+ SPHINXBUILD=sphinx-build2.7
+ make
+ make check PYTHON=/usr/bin/python2.7
+ sudo make install
Create empty FRR configuration files
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/doc/developer/building-frr-for-centos7.rst b/doc/developer/building-frr-for-centos7.rst
index 31cd4dcc49..b157f540ab 100644
--- a/doc/developer/building-frr-for-centos7.rst
+++ b/doc/developer/building-frr-for-centos7.rst
@@ -36,8 +36,8 @@ Add frr groups and user
::
sudo groupadd -g 92 frr
- sudo groupadd -r -g 85 frrvt
- sudo useradd -u 92 -g 92 -M -r -G frrvt -s /sbin/nologin \
+ sudo groupadd -r -g 85 frrvty
+ sudo useradd -u 92 -g 92 -M -r -G frrvty -s /sbin/nologin \
-c "FRR FRRouting suite" -d /var/run/frr frr
Download Source, configure and compile it
@@ -66,7 +66,7 @@ an example.)
--enable-ospfapi=yes \
--enable-user=frr \
--enable-group=frr \
- --enable-vty-group=frrvt \
+ --enable-vty-group=frrvty \
--enable-rtadv \
--enable-systemd=yes \
--disable-exampledir \
@@ -102,7 +102,7 @@ Create empty FRR configuration files
sudo touch /etc/frr/babeld.conf
sudo chown -R frr:frr /etc/frr/
sudo touch /etc/frr/vtysh.conf
- sudo chown frr:frrvt /etc/frr/vtysh.conf
+ sudo chown frr:frrvty /etc/frr/vtysh.conf
sudo chmod 640 /etc/frr/*.conf
Install daemon config file
diff --git a/doc/developer/building-frr-for-fedora24.rst b/doc/developer/building-frr-for-fedora24.rst
index 208c580b63..669cc4ae2f 100644
--- a/doc/developer/building-frr-for-fedora24.rst
+++ b/doc/developer/building-frr-for-fedora24.rst
@@ -29,8 +29,8 @@ Add frr groups and user
::
sudo groupadd -g 92 frr
- sudo groupadd -r -g 85 frrvt
- sudo useradd -u 92 -g 92 -M -r -G frrvt -s /sbin/nologin \
+ sudo groupadd -r -g 85 frrvty
+ sudo useradd -u 92 -g 92 -M -r -G frrvty -s /sbin/nologin \
-c "FRR FRRouting suite" -d /var/run/frr frr
Download Source, configure and compile it
@@ -59,7 +59,7 @@ an example.)
--enable-ospfapi=yes \
--enable-user=frr \
--enable-group=frr \
- --enable-vty-group=frrvt \
+ --enable-vty-group=frrvty \
--enable-rtadv \
--disable-exampledir \
--enable-watchfrr \
@@ -95,7 +95,7 @@ Create empty FRR configuration files
sudo touch /etc/frr/babeld.conf
sudo chown -R frr:frr /etc/frr/
sudo touch /etc/frr/vtysh.conf
- sudo chown frr:frrvt /etc/frr/vtysh.conf
+ sudo chown frr:frrvty /etc/frr/vtysh.conf
sudo chmod 640 /etc/frr/*.conf
Install daemon config file
diff --git a/doc/developer/building.rst b/doc/developer/building.rst
index d145849f7f..4c18445f9d 100644
--- a/doc/developer/building.rst
+++ b/doc/developer/building.rst
@@ -7,21 +7,21 @@ Building FRR
.. toctree::
:maxdepth: 2
- building-frr-on-alpine
- building-frr-on-centos6
- building-frr-on-centos7
- building-frr-on-debian8
- building-frr-on-debian9
- building-frr-on-fedora24
- building-frr-on-freebsd10
- building-frr-on-freebsd11
- building-frr-on-freebsd9
- building-frr-on-netbsd6
- building-frr-on-netbsd7
- building-frr-on-omnios
- building-frr-on-openbsd6
+ building-frr-for-alpine
+ building-frr-for-centos6
+ building-frr-for-centos7
+ building-frr-for-debian8
+ building-frr-for-debian9
+ building-frr-for-fedora24
+ building-frr-for-freebsd10
+ building-frr-for-freebsd11
+ building-frr-for-freebsd9
+ building-frr-for-netbsd6
+ building-frr-for-netbsd7
+ building-frr-for-omnios
+ building-frr-for-openbsd6
building-frr-for-openwrt
- building-frr-on-ubuntu1204
- building-frr-on-ubuntu1404
- building-frr-on-ubuntu1604
- building-frr-on-ubuntu1804
+ building-frr-for-ubuntu1204
+ building-frr-for-ubuntu1404
+ building-frr-for-ubuntu1604
+ building-frr-for-ubuntu1804
diff --git a/doc/developer/cli.rst b/doc/developer/cli.rst
index 20391c47bc..c0716a5c93 100644
--- a/doc/developer/cli.rst
+++ b/doc/developer/cli.rst
@@ -450,8 +450,6 @@ is no ordering requirement)
.. code-block:: make
- include ../common.am
-
# ...
# if linked into a LTLIBRARY (.la/.so):
diff --git a/doc/developer/workflow.rst b/doc/developer/workflow.rst
index d316de0f38..ee7592fd6a 100644
--- a/doc/developer/workflow.rst
+++ b/doc/developer/workflow.rst
@@ -778,6 +778,8 @@ That said, compatibility measures can (and should) be removed when either:
- some measure of time (dependent on the specific case) has passed, so that
the compatibility grace period is considered expired.
+For CLI commands, the deprecation period is 1 year.
+
In all cases, compatibility pieces should be marked with compiler/preprocessor
annotations to print warnings at compile time, pointing to the appropriate
update path. A ``-Werror`` build should fail if compatibility bits are used. To