Merge remote-tracking branch 'frr/master' into tcp-zebra

7 files changed, 75 insertions, 151 deletions

diff --git a/doc/Makefile.am b/doc/Makefile.am
index b2bdf91cd..9016df737 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -45,17 +45,19 @@ figures_txt = $(figures_names_parts:%=fig%.txt)
 # provided by automake. If you are an automake wizard, please feel free to
 # compact it somehow.
 
-# Built from defines.texi.in
-BUILT_SOURCES = defines.texi
-
 info_TEXINFOS = frr.texi
 
 # Have to manually specify the frr.pdf rule in order to allow
 # us to have a generic automatic .pdf rule to build the figure sources
 # because it cant just work from the png's directly it seems - contrary
 # to the documentation...
-frr.pdf: $(info_TEXINFOS) $(figures_pdf) $(frr_TEXINFOS)
-	$(TEXI2PDF) -o "$@" $< || true
+frr.pdf: $(info_TEXINFOS) $(figures_pdf) $(frr_TEXINFOS) defines.texi
+	$(TEXI2PDF) -o "$@" $<
+
+# don't ask me why the info file is in srcdir
+$(srcdir)/frr.info: $(frr_TEXINFOS) defines.texi
+frr.dvi: $(frr_TEXINFOS) defines.texi
+frr.html: $(frr_TEXINFOS) defines.texi
 
 frr_TEXINFOS = appendix.texi basic.texi bgpd.texi isisd.texi filter.texi \
 	vnc.texi \
@@ -65,7 +67,7 @@ frr_TEXINFOS = appendix.texi basic.texi bgpd.texi isisd.texi filter.texi \
 	eigrpd.texi \
 	ospf6d.texi ospfd.texi \
 	overview.texi protocol.texi ripd.texi ripngd.texi routemap.texi \
-	snmp.texi vtysh.texi routeserver.texi defines.texi $(figures_png) \
+	snmp.texi vtysh.texi routeserver.texi $(figures_png) \
 	snmptrap.texi ospf_fundamentals.texi isisd.texi $(figures_txt)
 
 .png.eps:
diff --git a/doc/basic.texi b/doc/basic.texi
index 05d72bc80..6e43210bb 100644
--- a/doc/basic.texi
+++ b/doc/basic.texi
@@ -450,7 +450,7 @@ Trying 127.0.0.1...
 Connected to localhost.
 Escape character is '^]'.
 
-Hello, this is @value{PACKAGE_NAME} (version @value{VERSION})
+Hello, this is @value{PACKAGE_NAME} (version @value{PACKAGE_VERSION})
 @value{COPYRIGHT_STR}
 
 User Access Verification
diff --git a/doc/bgpd.texi b/doc/bgpd.texi
index 8e0da1294..d6b07a270 100644
--- a/doc/bgpd.texi
+++ b/doc/bgpd.texi
@@ -698,8 +698,11 @@ This command is deprecated and may be removed in a future release. Its
 use should be avoided.
 @end deffn
 
-@deffn {BGP} {neighbor @var{peer} next-hop-self [all]} {}
-@deffnx {BGP} {no neighbor @var{peer} next-hop-self [all]} {}
+@c for some reason, using [all] here triggers a bug in texinfo...
+@deffn {BGP} {neighbor @var{peer} next-hop-self} {}
+@deffnx {BGP} {no neighbor @var{peer} next-hop-self} {}
+@deffnx {BGP} {neighbor @var{peer} next-hop-self all} {}
+@deffnx {BGP} {no neighbor @var{peer} next-hop-self all} {}
 This command specifies an announced route's nexthop as being equivalent
 to the address of the bgp router if it is learned via eBGP.
 If the optional keyword @code{all} is specified the modifiation is done
diff --git a/doc/defines.texi.in b/doc/defines.texi.in
index 0fadba964..b2af89e40 100644
--- a/doc/defines.texi.in
+++ b/doc/defines.texi.in
@@ -5,6 +5,8 @@
 @set PACKAGE_NAME @PACKAGE_NAME@
 @set PACKAGE_TARNAME @PACKAGE_TARNAME@
 @set PACKAGE_STRING @PACKAGE_STRING@
+@set PACKAGE_URL @PACKAGE_URL@
+@set PACKAGE_VERSION @PACKAGE_VERSION@
 @set AUTHORS Kunihiro Ishiguro, et al.
 @set COPYRIGHT_YEAR 1999-2005
 @set COPYRIGHT_STR Copyright @copyright{} @value{COPYRIGHT_YEAR} @value{AUTHORS}
diff --git a/doc/frr.texi b/doc/frr.texi
index b08bb6fd0..d268b4b98 100644
--- a/doc/frr.texi
+++ b/doc/frr.texi
@@ -7,13 +7,9 @@
 @setfilename frr.info
 @c Set variables - sourced from defines.texi
 @include defines.texi
-@settitle @uref{http://www.frrouting.org,,@value{PACKAGE_NAME}}
+@settitle @uref{@value{PACKAGE_URL},,@value{PACKAGE_NAME}}
 @c %**end of header
 
-@c automake will automatically generate version.texi
-@c and set EDITION, VERSION, UPDATED and UPDATED-MONTH
-@include version.texi
-
 @copying
 @value{COPYRIGHT_STR}
 @quotation
@@ -44,21 +40,18 @@ approved by Kunihiro Ishiguro.
 @c @smallbook
 
 @ifinfo
-This file documents the Frr Software Routing Suite which manages common
-TCP/IP routing protocols.
+This file documents the @uref{@value{PACKAGE_URL},,Frr Software Routing Suite}
+which manages common TCP/IP routing protocols.
 
-This is Edition @value{EDITION}, last updated @value{UPDATED} of
-@cite{The Frr Manual}, for @uref{http://www.frrouting.org/,,@value{PACKAGE_NAME}}
-Version @value{VERSION}.
+This document was generated for version @value{PACKAGE_VERSION}.
 
 @insertcopying
 @end ifinfo
 
 @titlepage
-@title @uref{http://www.frrouting.org,,Frr}
+@title @uref{@value{PACKAGE_URL},,Frr}
 @subtitle A routing software package for TCP/IP networks
-@subtitle @uref{http://www.frrouting.org,,@value{PACKAGE_NAME}} @value{VERSION}
-@subtitle @value{UPDATED-MONTH}
+@subtitle @uref{@value{PACKAGE_URL},,@value{PACKAGE_NAME}} @value{PACKAGE_VERSION}
 @author @value{AUTHORS}
 
 @page
@@ -72,9 +65,9 @@ Version @value{VERSION}.
 @node Top
 @top Frr -- With Virtual Network Control
 		     
-@uref{http://www.frrouting.org,,Frr} is an advanced routing software package
+@uref{@value{PACKAGE_URL},,Frr} is an advanced routing software package
 that provides a suite of TCP/IP based routing protocols.  This is the Manual
-for @value{PACKAGE_STRING}. @uref{http://www.frrouting.org,,Frr} is a fork of 
+for @value{PACKAGE_STRING}. @uref{@value{PACKAGE_URL},,Frr} is a fork of 
 @uref{http://www.quagga.net,,Quagga}.
 
 @insertcopying
diff --git a/doc/overview.texi b/doc/overview.texi
index 7ecf3d95c..c988e219b 100644
--- a/doc/overview.texi
+++ b/doc/overview.texi
@@ -2,7 +2,7 @@
 @chapter Overview
 @cindex Overview
 
-  @uref{http://www.frrouting.org,,Frr} is a routing software package that
+  @uref{@value{PACKAGE_URL},,Frr} is a routing software package that
 provides TCP/IP based routing services with routing protocols support such
 as RIPv1, RIPv2, RIPng, OSPFv2, OSPFv3, IS-IS, BGP-4, and BGP-4+ (@pxref{Supported
 RFCs}). Frr also supports special BGP Route Reflector and Route Server
@@ -275,12 +275,12 @@ November 1995.}
 
 The official Frr web-site is located at:
 
-@uref{http://www.frrouting.org/}
+@uref{@value{PACKAGE_URL}}
 
 and contains further information, as well as links to additional
 resources. 
 
-@uref{http://www.frrouting.org/,Frr} is a fork of Quagga, whose
+@uref{@value{PACKAGE_URL},Frr} is a fork of Quagga, whose
 web-site is located at:
 
 @uref{http://www.quagga.net/}.
@@ -296,12 +296,12 @@ web-site is located at:
 There is a mailing list for discussions about Frr.  If you have any
 comments or suggestions to Frr, please subscribe to:
 
-@uref{http://lists.nox.tf/listinfo/frr-users}.
+@uref{https://lists.frrouting.org/listinfo/frog}.
 
-The @uref{http://www.frrouting.org/,,Frr} site has further information on
+The @uref{@value{PACKAGE_URL},,Frr} site has further information on
 the available mailing lists, see:
 
-	@uref{http://lists.nox.tf/lists.php}
+	@uref{https://lists.frrouting.org/}
 
 @node Bug Reports
 @section Bug Reports
diff --git a/doc/watchfrr.8.in b/doc/watchfrr.8.in
index 82098e1b0..782ac7b46 100644
--- a/doc/watchfrr.8.in
+++ b/doc/watchfrr.8.in
@@ -20,59 +20,6 @@ daemon's VTY UNIX stream socket, and send echo commands to ensure the
 daemon responds. When the daemon crashes, EOF is received from the socket,
 so that watchfrr can react immediately.
 .PP
-This program can run in one of the following 5 modes:
-.TP
-.B Mode 0: monitor
-In this mode, the program serves as a monitor and reports status changes.
-.IP
-Example usage: watchfrr \-d zebra ospfd bgpd
-.TP
-.B Mode 1: global restart
-In this mode, whenever a daemon hangs or crashes, the given command is used
-to restart all watched daemons.
-.IP
-Example usage: watchfrr \-dz \e
-.br
--R '/sbin/service zebra restart; /sbin/service ospfd restart' \e
-.br
-zebra ospfd
-.TP
-.B Mode 2: individual daemon restart
-In this mode, whenever a single daemon hangs or crashes, the given command
-is used to restart this daemon only.
-.IP
-Example usage: watchfrr \-dz \-r '/sbin/service %s restart' \e
-.br
-zebra ospfd bgpd
-.TP
-.B Mode 3: phased zebra restart
-In this mode, whenever a single daemon hangs or crashes, the given command
-is used to restart this daemon only. The only exception is the zebra
-daemon; in this case, the following steps are taken: (1) all other daemons
-are stopped, (2) zebra is restarted, and (3) other daemons are started
-again.
-.IP
-Example usage: watchfrr \-adz \-r '/sbin/service %s restart' \e
-.br
-\-s '/sbin/service %s start' \e
-.br
-\-k '/sbin/service %s stop' zebra ospfd bgpd
-.TP
-.B Mode 4: phased global restart for any failure
-In this mode, whenever a single daemon hangs or crashes, the following
-steps are taken: (1) all other daemons are stopped, (2) zebra is restarted,
-and (3) other daemons are started again.
-.IP
-Example usage: watchfrr \-Adz \-r '/sbin/service %s restart' \e
-.br
-\-s '/sbin/service %s start' \e
-.br
-\-k '/sbin/service %s stop' zebra ospfd bgpd
-.PP
-Important: It is believed that mode 2 (individual daemon restart) is not
-safe, and mode 3 (phased zebra restart) may not be safe with certain
-routing daemons.
-.PP
 In order to avoid restarting the daemons in quick succession, you can
 supply the
 .B \-m
@@ -87,6 +34,36 @@ the restart delay is set to the value of
 otherwise the interval is doubled (but capped at the value of
 .BR \-M ).
 .SH OPTIONS
+The following 3 options specify scripts that
+.B watchfrr
+uses to perform start/stop/restart actions.  These options are mandatory
+unless the
+.B --dry
+option is used:
+.TP
+.BI \-s " command" "\fR, \fB\-\-start\-command " command
+Supply a Bourne shell
+.I command
+to start a single daemon. The command string should contain the '%s'
+placeholder to be substituted with the daemon name.
+.TP
+.BI \-k " command" "\fR, \fB\-\-kill\-command " command
+Supply a Bourne shell
+.I command
+to stop a single daemon. The command string should contain the '%s'
+placeholder to be substituted with the daemon name.
+.TP
+.BI \-r " command" "\fR, \fB\-\-restart " command
+Supply a Bourne shell
+.I command
+to restart a single daemon. The command string should contain the '%s'
+placeholder to be substituted with the daemon name.
+.PP
+Other options:
+.TP
+.BI \-\-dry
+Run watchfrr in "dry-run" mode, only monitoring the specified daemons but not
+performing any start/stop/restart actions.
 .TP
 .BR \-d ", " \-\-daemon
 Run in daemon mode. When supplied, error messages are sent to Syslog
@@ -97,10 +74,6 @@ Set the VTY socket
 .I directory
 (the default value is "/var/run/frr").
 .TP
-.BR \-e ", " \-\-no\-echo
-Do not ping the daemons to test whether they respond. This option is
-necessary if one or more daemons do not support the echo command.
-.TP
 .BI \-l " level" "\fR, \fB\-\-loglevel " level
 Set the logging
 .I level
@@ -131,68 +104,6 @@ Set the restart (kill) timeout in seconds (the default value is "20"). If
 any background jobs are still running after this period has elapsed, they
 will be killed.
 .TP
-.BI \-r " command" "\fR, \fB\-\-restart " command
-Supply a Bourne shell
-.I command
-to restart a single daemon. The command string should contain the '%s'
-placeholder to be substituted with the daemon name.
-.IP
-Note that
-.B \-r
-and
-.B \-R
-options are not compatible.
-.TP
-.BI \-s " command" "\fR, \fB\-\-start\-command " command
-Supply a Bourne shell
-.I command
-to start a single daemon. The command string should contain the '%s'
-placeholder to be substituted with the daemon name.
-.TP
-.BI \-k " command" "\fR, \fB\-\-kill\-command " command
-Supply a Bourne shell
-.I command
-to stop a single daemon. The command string should contain the '%s'
-placeholder to be substituted with the daemon name.
-.TP
-.BR \-R ", " \-\-restart\-all
-When one or more daemons are shut down, try to restart them using the
-Bourne shell command supplied on the command line.
-.IP
-Note that
-.B \-r
-and
-.B \-R
-options are not compatible.
-.TP
-.BR \-z ", " \-\-unresponsive\-restart
-When a daemon is in an unresponsive state, treat it as being shut down for
-the restart purposes.
-.TP
-.BR \-a ", " \-\-all\-restart
-When zebra hangs or crashes, restart all daemons taking the following
-steps: (1) stop all other daemons, (2) restart zebra, and (3) start other
-daemons again.
-.IP
-Note that this option also requires
-.BR \-r ,
-.BR \-s ,
-and
-.B \-k
-options to be specified.
-.TP
-.BR \-A ", " \-\-always\-all\-restart
-When any daemon (i.e., not just zebra) hangs or crashes, restart all
-daemons taking the following steps: (1) stop all other daemons, (2) restart
-zebra, and (3) start other daemons again.
-.IP
-Note that this option also requires
-.BR \-r ,
-.BR \-s ,
-and
-.B \-k
-options to be specified.
-.TP
 .BI \-p " filename" "\fR, \fB\-\-pid\-file " filename
 Set the process identifier
 .I filename
@@ -204,9 +115,8 @@ When the supplied
 is found in any of the command line option arguments (i.e.,
 .BR \-r ,
 .BR \-s ,
-.BR \-k ,
 or
-.BR \-R ),
+.BR \-k ),
 replace it with a space.
 .IP
 This is an ugly hack to circumvent problems with passing the command line
@@ -217,6 +127,20 @@ Display the version information and exit.
 .TP
 .BR \-h ", " \-\-help
 Display the usage information and exit.
+.SH PREVIOUS OPTIONS
+Prior versions of \fBwatchfrr\fR supported some additional options that no
+longer exist:
+.IP
+.BR \-a ,\  \-A ,\  \-e ,\  \-R ,\  \-z
+.PP
+The \fB-a\fR, \fB-A\fR and \fB-R\fR options were used to select alternate
+monitoring modes that offered different patterns of restarting daemons.  The
+"correct" mode (phased restart) is now the default. The \fB-e\fR and \fB-z\fR
+options used to disable some monitoring aspects, watchfrr now always has all
+monitoring features enabled.
+.PP
+Removing these options should result in correct operation, if it does not
+please file a bug report.
 .SH SEE ALSO
 .BR zebra (8),
 .BR bgpd (8),