[Git][NTPsec/ntpsec][master] 3 commits: doc: Revise mrulist documentation to be less opaque.

[James Browning]

James Browning pushed to branch master at NTPsec / ntpsec


Commits:
60fb5a8b by James Browning at 2020-10-01T02:07:14-07:00
doc: Revise mrulist documentation to be less opaque.

- - - - -
e880627f by James Browning at 2020-10-01T07:35:33-07:00
doc: Repahrasing in ntpq and mode 6 docs/comments.

- - - - -
b675e786 by James Browning at 2020-10-01T08:34:15-07:00
docs: Specify starting point for ntpq/mode6 mrulist.

- - - - -


2 changed files:

- docs/includes/ntpq-body.adoc
- ntpd/ntp_control.c


Changes:

=====================================
docs/includes/ntpq-body.adoc
=====================================
@@ -313,34 +313,38 @@ ind assid status conf reach auth condition last_event cnt
   monitor facility. This is useful for tracking who _uses_ or
   _abuses_ your server.
 +
-With the exception of +sort=+'sortorder', the options
+Except for +sort=+'sortorder', the options
 filter the list returned by +ntpd+. The +limited+ and +kod+ options
 return only entries representing client addresses from which the last
 packet received triggered either discarding or a KoD response.
 the +addr.'num'=+ option adds specific addresses to retrieve when
 +limit=+'1'. Values of 0 to 15 are supported for 'num'. Also, used
-internallly with +last.'num'=+'hextime' to select starting point
+internally with +last.'num'=+'hextime' to select the starting point
 for retrieving continued response.
 the +frags=+'frags' option limits the number of datagrams
 (fragments) in response.  Used by newer ntpq versions instead
 of limit= when retrieving multiple entries.
-The +limit=+ option limits the MRU entries returned. limit=1
-is a special case:  Instead of fetching beginning with the
-supplied starting point's newer neighbor, fetch the supplied
-entries. This enables fetching a multiple entries by IP
-addresses.  When limit is not one and frags= is provided,
-the fragment limit controls.
-The +mincount=+'count' option filters entries that have received less
+The +limit=+ option limits the MRU entries returned per response.
+limit=1 is a special case:  Instead of fetching beginning with
+the supplied starting points (provided by a last.x and addr.x
+where 0 <= x <= 15, default the beginning of time) newer neighbor,
+fetch the supplied entries. This enables fetching multiple entries
+from given IP addresses (provided by addr.x= entries where 0 <= x
+<= 15). When limit is not one and frags= is provided,
+the fragment limit controls. NOTE: a single mrulist command may
+cause many query/response rounds allowing limits as low as 3 to
+potentially retrieve thousands of entries in responses.
+The +mincount=+'count' option filters out entries that have received less
 than 'count' packets.
-The +mindrop=+'drop' option filters entries that have dropped less
+The +mindrop=+'drop' option filters out entries that have dropped less
 than 'drop' packets.
-The +minscore=+'score' option filters entries with a score less
+The +minscore=+'score' option filters out entries with a score less
 than 'score'.
-The +maxlstint=+'seconds' option filters entries where no packets have
+The +maxlstint=+'seconds' option filters out entries where no packets have
 arrived within 'seconds'.
-The +minlstint=+'seconds' option filters entries with a packet has
+The +minlstint=+'seconds' option filters out entries with a packet has
 arrived within 'seconds'.
-The +laddr=+'localaddr' option filters entries for packets
+The +laddr=+'localaddr' option filters out entries for packets
 received on any local address other than 'localaddr'. +resany=+'hexmask'
 and +resall=+'hexmask' filter entries containing none or less than all,
 respectively, of the bits in 'hexmask', which must begin with +0x+.


=====================================
ntpd/ntp_control.c
=====================================
@@ -3347,12 +3347,19 @@ send_mru_entry(
  *	limit=		Limit on MRU entries returned.  One of frags= or
  *			limit= must be provided.
  *			limit=1 is a special case:  Instead of fetching
- *			beginning with the supplied starting point's
- *			newer neighbor, fetch the supplied entry, and
- *			in that case the #.last timestamp can be zero.
- *			This enables fetching a single entry by IP
- *			address.  When limit is not one and frags= is
- *			provided, the fragment limit controls.
+ *			beginning with the supplied starting points
+ *			(provided by a last.x and addr.x where 0 <= x
+ *			<= 15, default the beginning of time) newer
+ *			neighbor, fetch the supplied entries (provided
+ *			by addr.x= entries where 0 <= x <= 15), and in
+ *			that case the #.last timestamp can be zero.
+ *			This enables fetching a multiple entries from
+ *			given  IP addresses.  When limit is not one and
+ *			frags= is provided, the fragment limit controls.
+ *			NOTE: a single mrulist command may cause many
+ *			query/response rounds allowing limits as low as
+ *			3 to potentially retrieve thousands of entries
+ *			in responses.
  *	mincount=	(decimal) Return entries with count >= mincount.
  *	mindrop=	(decimal) Return entries with drop >= mindrop.
  *	minscore=	(float) Return entries with score >= minscore.



View it on GitLab: https://gitlab.com/NTPsec/ntpsec/-/compare/7657a68c2c5aeda8aff6b82666590cc52879c337...b675e7862ffca4efd1cb994489a7a2773680d58c

-- 
View it on GitLab: https://gitlab.com/NTPsec/ntpsec/-/compare/7657a68c2c5aeda8aff6b82666590cc52879c337...b675e7862ffca4efd1cb994489a7a2773680d58c
You're receiving this email because of your account on gitlab.com.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ntpsec.org/pipermail/vc/attachments/20201001/e00d0a2a/attachment-0001.htm>