diff options
Diffstat (limited to 'doc/developer')
| -rw-r--r-- | doc/developer/building-frr-for-centos6.rst | 6 | ||||
| -rw-r--r-- | doc/developer/building-frr-for-ubuntu1804.rst | 2 | ||||
| -rw-r--r-- | doc/developer/conf.py | 2 | ||||
| -rw-r--r-- | doc/developer/maintainer-release-build.rst | 4 | ||||
| -rw-r--r-- | doc/developer/modules.rst | 6 | ||||
| -rw-r--r-- | doc/developer/next-hop-tracking.rst | 2 | ||||
| -rw-r--r-- | doc/developer/packaging-debian.rst | 4 | ||||
| -rw-r--r-- | doc/developer/packaging.rst | 1 | ||||
| -rw-r--r-- | doc/developer/process-architecture.rst | 4 |
9 files changed, 16 insertions, 15 deletions
diff --git a/doc/developer/building-frr-for-centos6.rst b/doc/developer/building-frr-for-centos6.rst index 5f9ce705f2..c57573cb9f 100644 --- a/doc/developer/building-frr-for-centos6.rst +++ b/doc/developer/building-frr-for-centos6.rst @@ -244,7 +244,7 @@ Load the modifed sysctl's on the system: Add init.d startup files ^^^^^^^^^^^^^^^^^^^^^^^^ -.. code-block:: +.. code-block:: shell sudo install -p -m 755 redhat/frr.init /etc/init.d/frr sudo chkconfig --add frr @@ -252,13 +252,13 @@ Add init.d startup files Enable FRR daemon at startup ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. code-block:: +.. code-block:: shell sudo chkconfig frr on Start FRR manually (or reboot) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. code-block:: +.. code-block:: shell sudo /etc/init.d/frr start diff --git a/doc/developer/building-frr-for-ubuntu1804.rst b/doc/developer/building-frr-for-ubuntu1804.rst index 2d1edc063d..e69ded8f73 100644 --- a/doc/developer/building-frr-for-ubuntu1804.rst +++ b/doc/developer/building-frr-for-ubuntu1804.rst @@ -115,7 +115,7 @@ Create empty FRR configuration files ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Although not strictly necessary, it's good practice to create empty -configuration files _before_ starting FRR. This assures that the permissions +configuration files _before_ starting FRR. This assures that the permissions are correct. If the files are not already present, FRR will create them. It's also important to consider _which_ files to create. FRR supports writing diff --git a/doc/developer/conf.py b/doc/developer/conf.py index 61253c4b2f..254c9f6bfc 100644 --- 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'] +exclude_patterns = ['_build', 'building-libyang.rst'] # The reST default role (used for this markup: `text`) to use for all # documents. diff --git a/doc/developer/maintainer-release-build.rst b/doc/developer/maintainer-release-build.rst index 907bd14ee6..85aaa5365a 100644 --- a/doc/developer/maintainer-release-build.rst +++ b/doc/developer/maintainer-release-build.rst @@ -1,5 +1,5 @@ -Release Build Procedure for FRR maintainers -========================================================= +Release Build Procedure for FRR Maintainers +=========================================== 1. Rename branch (if needed) diff --git a/doc/developer/modules.rst b/doc/developer/modules.rst index bde7682e4e..99c79462ab 100644 --- a/doc/developer/modules.rst +++ b/doc/developer/modules.rst @@ -103,9 +103,9 @@ standard entry point for loadable modules. Command line parameters ----------------------- -Command line parameters can be passed directly to a module by appending a -colon to the module name when loading it, e.g. ``-M mymodule:myparameter``. -The text after the colon will be accessible in the module's code through +Command line parameters can be passed directly to a module by appending a +colon to the module name when loading it, e.g. ``-M mymodule:myparameter``. +The text after the colon will be accessible in the module's code through ``THIS_MODULE->load_args``. For example, see how the format parameter is configured in the ``zfpm_init()`` function inside ``zebra_fpm.c``. diff --git a/doc/developer/next-hop-tracking.rst b/doc/developer/next-hop-tracking.rst index e6484102a8..a9af5e749c 100644 --- a/doc/developer/next-hop-tracking.rst +++ b/doc/developer/next-hop-tracking.rst @@ -269,7 +269,7 @@ RNH table:: O O / \ O O - + struct rnh { uint8_t flags; diff --git a/doc/developer/packaging-debian.rst b/doc/developer/packaging-debian.rst index 4ea784c0fc..c812a38212 100644 --- a/doc/developer/packaging-debian.rst +++ b/doc/developer/packaging-debian.rst @@ -1,5 +1,5 @@ -Debian -====== +Packaging Debian +================ (Tested on Ubuntu 12.04, 14.04, 16.04, 17.10, 18.04, Debian 8 and 9) diff --git a/doc/developer/packaging.rst b/doc/developer/packaging.rst index e9bb3a5409..27e6e155fb 100644 --- a/doc/developer/packaging.rst +++ b/doc/developer/packaging.rst @@ -5,4 +5,5 @@ Packaging .. toctree:: :maxdepth: 2 + maintainer-release-build packaging-debian diff --git a/doc/developer/process-architecture.rst b/doc/developer/process-architecture.rst index 806afa644c..6e0eb68188 100644 --- a/doc/developer/process-architecture.rst +++ b/doc/developer/process-architecture.rst @@ -118,7 +118,7 @@ The following diagram illustrates a simplified version of this infrastructure. .. todo: replace these with SVG .. figure:: ../figures/threadmaster-single.png :align: center - + Lifecycle of a program using a single threadmaster. The series of "task" boxes represents the current ready task queue. The various @@ -183,7 +183,7 @@ running their own ``threadmaster``-based event loop. .. todo: replace these with SVG .. figure:: ../figures/threadmaster-multiple.png :align: center - + Lifecycle of a program using multiple pthreads, each running their own ``threadmaster`` |