This is very helpful for users who want to quickly remind themselves what a
particular command does.
+ Configuration Snippets
+ ^^^^^^^^^^^^^^^^^^^^^^
+
+ When putting blocks of example configuration please use the
+ ``.. code-block::`` directive and specify ``frr`` as the highlighting language,
+ as in the following example. This will tell Sphinx to use a custom Pygments
+ lexer to highlight FRR configuration syntax.
+
+ .. code-block:: rest
+
+ .. code-block:: frr
+
+ !
+ ! Example configuration file.
+ !
+ log file /tmp/log.log
+ service integrated-vtysh-config
+ !
+ ip route 1.2.3.0/24 reject
+ ipv6 route de:ea:db:ee:ff::/64 reject
+ !
+
+
.. _GitHub: https://github.com/frrouting/frr
.. _GitHub issues: https://github.com/frrouting/frr/issues
+
+.. rubric:: Footnotes
+
+.. [#tool_style_conflicts] For example, lines over 80 characters are allowed
+ for text strings to make it possible to search the code for them: please
+ see `Linux kernel style (breaking long lines and strings) <https://www.kernel.org/doc/html/v4.10/process/coding-style.html#breaking-long-lines-and-strings>`_
+ and `Issue #1794 <https://github.com/FRRouting/frr/issues/1794>`_.