Browse Source

doc: Fix overfull hboxes errors that cause PDF build to return fail

* overfull hboxes cause texi2dvi to return fail, even if the PDf is written.
  We hacked around this by running it with '...  || true', but that
  sucks for buildboting the docs.

  Fix all the overfull hboxes.

* ospfd.texi: Long command definitions can cause hbox overruns in the
  columnar command definitions index.  This leads to strange errors
  about "Missing number, treated as zero." when building the index -
  very hard to figure out.

  'show ip ospf database ...' was the culprit.  Use a distinct deffnx
  alias for each option instead of trying to stuff them into 1 line.
Paul Jakma 2 years ago
parent
commit
1bfd6551c9
4 changed files with 26 additions and 17 deletions
  1. 1 1
      doc/main.texi
  2. 3 2
      doc/nhrpd.texi
  3. 10 8
      doc/ospfd.texi
  4. 12 6
      doc/snmptrap.texi

+ 1 - 1
doc/main.texi

@@ -355,11 +355,11 @@ Within a route-map, set the preferred source address for matching routes
 when installing in the kernel.
 @end deffn
 
-@example
 The following creates a prefix-list that matches all addresses, a route-map
 that sets the preferred source address, and applies the route-map to all
 @command{rip} routes.
 
+@example
 @group
 ip prefix-list ANY permit 0.0.0.0/0 le 32
 route-map RM1 permit 10

+ 3 - 2
doc/nhrpd.texi

@@ -91,8 +91,9 @@ This can be achieved with the following iptables rule.
 @group
 iptables -A FORWARD -i gre1 -o gre1 \
 	-m hashlimit --hashlimit-upto 4/minute --hashlimit-burst 1 \
-	--hashlimit-mode srcip,dstip --hashlimit-srcmask 24 --hashlimit-dstmask 24 \
-	--hashlimit-name loglimit-0 -j NFLOG --nflog-group 1 --nflog-range 128
+	--hashlimit-mode srcip,dstip --hashlimit-srcmask 24 \
+	--hashlimit-dstmask 24 --hashlimit-name loglimit-0 \
+	-j NFLOG --nflog-group 1 --nflog-range 128
 @end group
 @end example
 

+ 10 - 8
doc/ospfd.texi

@@ -613,14 +613,16 @@ interfaces if no interface is given.
 @end deffn
 
 @deffn {Command} {show ip ospf database} {}
-@end deffn
-
-@deffn {Command} {show ip ospf database (asbr-summary|external|network|router|summary)} {}
-@deffnx {Command} {show ip ospf database (asbr-summary|external|network|router|summary) @var{link-state-id}} {}
-@deffnx {Command} {show ip ospf database (asbr-summary|external|network|router|summary) @var{link-state-id} adv-router @var{adv-router}} {}
-@deffnx {Command} {show ip ospf database (asbr-summary|external|network|router|summary) adv-router @var{adv-router}} {}
-@deffnx {Command} {show ip ospf database (asbr-summary|external|network|router|summary) @var{link-state-id} self-originate} {}
-@deffnx {Command} {show ip ospf database (asbr-summary|external|network|router|summary) self-originate} {}
+@deffnx {Command} {show ip ospf database asbr-summary} {}
+@deffnx {Command} {show ip ospf database external} {}
+@deffnx {Command} {show ip ospf database network} {}
+@deffnx {Command} {show ip ospf database asbr-router} {}
+@deffnx {Command} {show ip ospf database summary} {}
+@deffnx {Command} {show ip ospf database @dots{} @var{link-state-id}} {}
+@deffnx {Command} {show ip ospf database @dots{} @var{link-state-id} adv-router @var{adv-router}} {}
+@deffnx {Command} {show ip ospf database @dots{} adv-router @var{adv-router}} {}
+@deffnx {Command} {show ip ospf database @dots{} @var{link-state-id} self-originate} {}
+@deffnx {Command} {show ip ospf database @dots{} self-originate} {}
 @end deffn
 
 @deffn {Command} {show ip ospf database max-age} {}

+ 12 - 6
doc/snmptrap.texi

@@ -69,15 +69,21 @@ like sound a siren, have your display flash, etc., be creative ;).
 
   # get some vars from stdin
   uptime=`echo $INPUT | cut -d' ' -f5`
-  peer=`echo $INPUT | cut -d' ' -f8 | sed -e 's/SNMPv2-SMI::mib-2.15.3.1.14.//g'`
+  peer=`echo $INPUT | cut -d' ' -f8 | \
+	sed -e 's/SNMPv2-SMI::mib-2.15.3.1.14.//g'`
   peerstate=`echo $INPUT | cut -d' ' -f13`
   errorcode=`echo $INPUT | cut -d' ' -f9 | sed -e 's/\"//g'`
   suberrorcode=`echo $INPUT | cut -d' ' -f10 | sed -e 's/\"//g'`
-  remoteas=`snmpget -v2c -c $COMMUNITY localhost SNMPv2-SMI::mib-2.15.3.1.9.$peer | cut -d' ' -f4`
-
-  WHOISINFO=`whois -h whois.ripe.net " -r AS$remoteas" | egrep '(as-name|descr)'`
-  asname=`echo "$WHOISINFO" | grep "^as-name:" | sed -e 's/^as-name://g' -e 's/  //g' -e 's/^ //g' | uniq`
-  asdescr=`echo "$WHOISINFO" | grep "^descr:" | sed -e 's/^descr://g' -e 's/  //g' -e 's/^ //g' | uniq`
+  remoteas=`snmpget -v2c -c $COMMUNITY \
+		localhost SNMPv2-SMI::mib-2.15.3.1.9.$peer \
+		| cut -d' ' -f4`
+
+  WHOISINFO=`whois -h whois.ripe.net " -r AS$remoteas" | \
+		egrep '(as-name|descr)'`
+  asname=`echo "$WHOISINFO" | grep "^as-name:" | \
+		sed -e 's/^as-name://g' -e 's/  //g' -e 's/^ //g' | uniq`
+  asdescr=`echo "$WHOISINFO" | grep "^descr:" | \
+		sed -e 's/^descr://g' -e 's/  //g' -e 's/^ //g' | uniq`
 
   # if peer address is in $WARN_PEER, the email should also
   # be sent to $EMAILADDR_WARN