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>

diff --git a/doc/developer/conf.py b/doc/developer/conf.py
index af8673e5fabf09e27ca8835c00919be65b8be5d9..9acfab739a943f376ccc58fb23dcb843c402781b 100644 (file)
--- a/doc/developer/conf.py
+++ b/doc/developer/conf.py
@@ -131,7 +131,7 @@ language = None
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build', 'building-libyang.rst', 'topotests-snippets.rst']
+exclude_patterns = ['_build', 'building-libyang.rst', 'topotests-snippets.rst', 'include-compile.rst']
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.

diff --git a/doc/developer/include-compile.rst b/doc/developer/include-compile.rst
new file mode 100644 (file)
index 0000000..0ff0ae3
--- /dev/null
+++ b/doc/developer/include-compile.rst
@@ -0,0 +1,37 @@
+Clone the FRR git repo and use the included ``configure`` script to configure
+FRR's build time options to your liking. The full option listing can be
+obtained by running ``./configure -h``. The options shown below are examples.
+
+.. note::
+
+   If your platform uses ``systemd``, please make sure to add
+   ``--enable-systemd=yes`` to your configure options.
+
+.. code-block:: console
+
+   git clone https://github.com/frrouting/frr.git frr
+   cd frr
+   ./bootstrap.sh
+   ./configure \
+       --prefix=/usr \
+       --includedir=\${prefix}/include \
+       --enable-exampledir=\${prefix}/share/doc/frr/examples \
+       --bindir=\${prefix}/bin \
+       --sbindir=\${prefix}/lib/frr \
+       --libdir=\${prefix}/lib/frr \
+       --libexecdir=\${prefix}/lib/frr \
+       --localstatedir=/var/run/frr \
+       --sysconfdir=/etc/frr \
+       --with-moduledir=\${prefix}/lib/frr/modules \
+       --with-libyang-pluginsdir=\${prefix}/lib/frr/libyang_plugins \
+       --enable-configfile-mask=0640 \
+       --enable-logfile-mask=0640 \
+       --enable-snmp=agentx \
+       --enable-multipath=64 \
+       --enable-user=frr \
+       --enable-group=frr \
+       --enable-vty-group=frrvty \
+       --with-pkg-git-version \
+       --with-pkg-extra-version=-MyOwnFRRVersion
+   make
+   sudo make install

diff --git a/doc/developer/subdir.am b/doc/developer/subdir.am
index 6580dca58f81b3c1aca8f0d32330a7af1bd9bc5b..7ae48881abb87a338bf0d43ea8c2e13502bd1346 100644 (file)
--- a/doc/developer/subdir.am
+++ b/doc/developer/subdir.am
@@ -27,6 +27,7 @@ dev_RSTFILES = \
        doc/developer/cli.rst \
        doc/developer/conf.py \
        doc/developer/hooks.rst \
+       doc/developer/include-compile.rst \
        doc/developer/index.rst \
        doc/developer/library.rst \
        doc/developer/logging.rst \