Skip to content

Commit

Permalink
{etc,man}: improve check_route address notification flag documentation (
Browse files Browse the repository at this point in the history
#301)

Improve the man page for the check_route address notification flag.

Add check_route to the comments of mptcpd.conf.in.

Signed-off-by: Arınç ÜNAL <arinc.unal@arinc9.com>
  • Loading branch information
arinc9 authored Sep 3, 2024
1 parent 334bb9c commit a4e7b65
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
9 changes: 8 additions & 1 deletion etc/mptcpd.conf.in
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,17 @@ path-manager=@mptcpd_default_pm@
# skip_loopback
# Ignore (do not notify) host (loopback) address updates
#
# check_route
# Notify address only if a default route is available from such
# address and the related device. If the route check fails, it
# will be re-done after a little timeout, to allow e.g. DHCP to
# configure the host properly. Complex policy routing
# configuration may confuse or circumvent this check.
#
# These flags determine whether mptpcd plugins will be notified when
# related addresses are updated.
#
# notify-flags=existing,skip_link_local,skip_loopback
# notify-flags=existing,skip_link_local,skip_loopback,check_route

# --------------------------
# Plugins to load
Expand Down
10 changes: 5 additions & 5 deletions man/mptcpd.8.in
Original file line number Diff line number Diff line change
Expand Up @@ -102,17 +102,17 @@ ignore (do not notify) host (loopback) address updates
.RS
.TP
.I check_route
notify address only if a default route is available from such
address and the related device. If the route check fails, it will
re-done after a little timeout, to allow .e.g. DHCP to configure the
host properly. Complex Policy routing configuration may confuse or
notify address only if a default route is available from such address
and the related device. If the route check fails, it will be re-done
after a little timeout, to allow e.g. DHCP to configure the host
properly. Complex policy routing configuration may confuse or
circumvent this check.
.RE
.P
.RS
These flags determine whether mptpcd plugins will be notified when
related addresses are updated, e.g.
.B --notify-flags=existing,skip_link_local,check_route
.B --notify-flags=existing,skip_link_local,skip_loopback,check_route
.RE

.TP
Expand Down

0 comments on commit a4e7b65

Please sign in to comment.