From: Maria Matejka Date: Sun, 19 Jan 2025 00:06:24 +0000 (+0100) Subject: Doc: autoconvertor of our SGML to Markdown X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d787662d52c8edf6acdf31173f6e3b123be4b6ad;p=thirdparty%2Fbird.git Doc: autoconvertor of our SGML to Markdown Some minor changes were done in the original documentation to allow for easier conversion, and also to make the documentation a little bit more strictly valid. --- diff --git a/Makefile.in b/Makefile.in index 839efe243..29e627e1f 100644 --- a/Makefile.in +++ b/Makefile.in @@ -22,6 +22,7 @@ RANLIB=@RANLIB@ INSTALL=@INSTALL@ INSTALL_PROGRAM=@INSTALL_PROGRAM@ INSTALL_DATA=@INSTALL_DATA@ +PANDOC=@PANDOC@ client=$(addprefix $(exedir)/,@CLIENT@) daemon=$(exedir)/bird diff --git a/configure.ac b/configure.ac index 3eeb446d3..cf6a2d581 100644 --- a/configure.ac +++ b/configure.ac @@ -83,6 +83,7 @@ AC_ARG_WITH([iproutedir], AC_ARG_VAR([FLEX], [location of the Flex program]) AC_ARG_VAR([BISON], [location of the Bison program]) AC_ARG_VAR([M4], [location of the M4 program]) +AC_ARG_VAR([PANDOC], [location of the Pandoc program]) if test "$enable_debug_expensive" = yes; then enable_debug=yes @@ -188,6 +189,7 @@ AC_PROG_RANLIB AC_CHECK_PROG([FLEX], [flex], [flex]) AC_CHECK_PROG([BISON], [bison], [bison]) AC_CHECK_PROGS([M4], [gm4 m4]) +AC_CHECK_PROG([PANDOC], [pandoc], [pandoc]) test -z "$FLEX" && AC_MSG_ERROR([Flex is missing.]) test -z "$BISON" && AC_MSG_ERROR([Bison is missing.]) diff --git a/doc/Makefile b/doc/Makefile index 0d1deb8eb..c17648877 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -25,6 +25,20 @@ $(o)%.sgml: $(s)%.sgml $(objdir)/.dir-stamp $(o)%.html: $(o)%.sgml cd $(dir $@) && $(toolsdir)/linuxdoc -B html $(notdir $<) +ifeq ($(PANDOC),) +$(o)%.md: $(s)%.sgml + @echo "ERROR: No pandoc available, install pandoc to build documentation" + @false +else +LINUXDOC_PANDOC_PARSER := $(srcdir)/tools/linuxdoc.lua +$(o)%.md: $(s)%.sgml $(LINUXDOC_PANDOC_PARSER) $(objdir)/.dir-stamp + $(PANDOC) -f $(LINUXDOC_PANDOC_PARSER) -s -t markdown -o $@ $< + +$(o)%-singlepage.html: $(o)%.md + $(PANDOC) -f markdown -t html5 -s -o $@ $< + +endif + $(o)%.tex: $(o)%.sgml cd $(dir $@) && $(toolsdir)/linuxdoc -B latex --output=tex $(notdir $<) diff --git a/doc/bird.sgml b/doc/bird.sgml index 7abb8348c..6cd0098e1 100644 --- a/doc/bird.sgml +++ b/doc/bird.sgml @@ -786,8 +786,8 @@ to set options. server setups, running GC on hundreds of full BGP routing tables can take significant amount of time, therefore they should use higher GC periods. Default: adaptive, based on number of routing tables in the - configuration. From 10 s (with <= 25 routing tables) up to 600 s (with - >= 1500 routing tables). + configuration. From 10 s (with <= 25 routing tables) up to 600 s (with + >= 1500 routing tables). @@ -2726,14 +2726,14 @@ protocol bfd [<name>] { passive mode, which means that the router does not send BFD packets until it has received one from the other side. Default: disabled. - authentication none + No passwords are sent in BFD packets. This is the default value. - authentication simple + Every packet carries 16 bytes of password. Received packets lacking this password are ignored. This authentication mechanism is very weak. - authentication [meticulous] keyed md5|sha1 + An authentication code is appended to each packet. The cryptographic algorithm is keyed MD5 or keyed SHA-1. Note that the algorithm is common for all keys (on one interface), in contrast to OSPF or RIP, where it @@ -2745,7 +2745,7 @@ protocol bfd [<name>] { offers better resistance to replay attacks but may require more computation. - password "text" + Specifies a password used for authentication. See common option for detailed description. Note that password option - - Border Gateway Protocol 4 (BGP) - - BGP Communities Attribute - - Protection of BGP Sessions via TCP MD5 Signature - - Use of BGP Multiprotocol Extensions for IPv6 - - Route Refresh Capability - - Carrying Label Information in BGP - - BGP Extended Communities Attribute - - BGP/MPLS IPv4 Virtual Private Networks - - BGP Route Reflection - - Subcodes for BGP Cease Notification Message - - BGP/MPLS IPv6 Virtual Private Networks - - Graceful Restart Mechanism for BGP - - Multiprotocol extensions for BGP - - Connecting IPv6 Islands over IPv4 MPLS - - AS confederations for BGP - - Generalized TTL Security Mechanism - - Capabilities Advertisement with BGP - - Dissemination of Flow Specification Rules - - 4-Octet AS Specific BGP Extended Community - - AS-Wide Unique BGP Identifier - - Subcodes for BGP Finite State Machine Error - - BGP Support for 4-Octet AS Numbers - - Accumulated IGP Metric Attribute for BGP - - Enhanced Route Refresh Capability for BGP - - Revised Error Handling for BGP UPDATE Messages - - Advertisement of Multiple Paths in BGP - - Internet Exchange BGP Route Server - - BGP Large Communities Attribute - - BGP Administrative Shutdown Communication - - Default EBGP Route Propagation Behavior without Policies - - Extended Message Support for BGP - - Advertising IPv4 NLRI with an IPv6 Next Hop - - Extended Optional Parameters Length for BGP OPEN Message - - Revised Validation Procedure for BGP Flow Specifications - - Route Leak Prevention and Detection Using Roles - - Send Hold Timer + – Border Gateway Protocol 4 (BGP) + – BGP Communities Attribute + – Protection of BGP Sessions via TCP MD5 Signature + – Use of BGP Multiprotocol Extensions for IPv6 + – Route Refresh Capability + – Carrying Label Information in BGP + – BGP Extended Communities Attribute + – BGP/MPLS IPv4 Virtual Private Networks + – BGP Route Reflection + – Subcodes for BGP Cease Notification Message + – BGP/MPLS IPv6 Virtual Private Networks + – Graceful Restart Mechanism for BGP + – Multiprotocol extensions for BGP + – Connecting IPv6 Islands over IPv4 MPLS + – AS confederations for BGP + – Generalized TTL Security Mechanism + – Capabilities Advertisement with BGP + – Dissemination of Flow Specification Rules + – 4-Octet AS Specific BGP Extended Community + – AS-Wide Unique BGP Identifier + – Subcodes for BGP Finite State Machine Error + – BGP Support for 4-Octet AS Numbers + – Accumulated IGP Metric Attribute for BGP + – Enhanced Route Refresh Capability for BGP + – Revised Error Handling for BGP UPDATE Messages + – Advertisement of Multiple Paths in BGP + – Internet Exchange BGP Route Server + – BGP Large Communities Attribute + – BGP Administrative Shutdown Communication + – Default EBGP Route Propagation Behavior without Policies + – Extended Message Support for BGP + – Advertising IPv4 NLRI with an IPv6 Next Hop + – Extended Optional Parameters Length for BGP OPEN Message + – Revised Validation Procedure for BGP Flow Specifications + – Route Leak Prevention and Detection Using Roles + – Send Hold Timer Route selection rules @@ -3754,7 +3754,7 @@ nothing about it. as one known by BIRD, therefore use of this statement carries a risk of incompatibility with future BIRD versions. -