Re: drop please from manual pages

2022-02-05 Thread Todd C . Miller
On Sat, 05 Feb 2022 23:06:32 +1100, Jonathan Gray wrote:

> drop please from manual pages excluding third party parts of tree
> suggested by multiple documentation style guides

OK millert@

 - todd



Re: drop please from manual pages

2022-02-05 Thread Jason McIntyre
On Sat, Feb 05, 2022 at 11:06:32PM +1100, Jonathan Gray wrote:
> drop please from manual pages excluding third party parts of tree
> suggested by multiple documentation style guides
> 

hi. i'm ok with this.
jmc

> diff --git lib/libc/stdlib/atexit.3 lib/libc/stdlib/atexit.3
> index a95a45b92e4..891641489e3 100644
> --- lib/libc/stdlib/atexit.3
> +++ lib/libc/stdlib/atexit.3
> @@ -68,7 +68,7 @@ that matters, not the source of the function that was 
> registered.
>  is very difficult to use correctly without creating
>  .Xr exit 3 Ns -time
>  races.
> -Unless absolutely necessary, please avoid using it.
> +Unless absolutely necessary, avoid using it.
>  .Sh RETURN VALUES
>  The
>  .Nm
> diff --git lib/libc/sys/getentropy.2 lib/libc/sys/getentropy.2
> index 234969e7a1d..942a591a0cc 100644
> --- lib/libc/sys/getentropy.2
> +++ lib/libc/sys/getentropy.2
> @@ -33,7 +33,7 @@ as input for process-context pseudorandom generators like
>  The maximum buffer size permitted is 256 bytes.
>  .Pp
>  .Fn getentropy
> -is not intended for regular code; please use the
> +is not intended for regular code; use the
>  .Xr arc4random 3
>  family of functions instead.
>  .Pp
> diff --git lib/libkeynote/keynote.4 lib/libkeynote/keynote.4
> index aabd2db365d..6e5a29dffb4 100644
> --- lib/libkeynote/keynote.4
> +++ lib/libkeynote/keynote.4
> @@ -374,7 +374,7 @@ attribute
>  .Sh QUERY SEMANTICS
>  The discussion in the following sections assume some familiarity with
>  assertion syntax.
> -Please refer to
> +Refer to
>  .Xr keynote 5
>  for more details on the syntax.
>  .Sh QUERY PARAMETERS
> diff --git lib/libpthread/man/pthreads.3 lib/libpthread/man/pthreads.3
> index 94e86227874..c2de5274f3a 100644
> --- lib/libpthread/man/pthreads.3
> +++ lib/libpthread/man/pthreads.3
> @@ -463,7 +463,7 @@ conform to
>  .St -p1003.1-96
>  and various later versions of
>  .Pq Dq Tn POSIX .
> -Please consult the manpages for the individual functions for details.
> +Consult the manpages for the individual functions for details.
>  .Sh HISTORY
>  This 1-to-1 implementation of the
>  .Nm
> diff --git lib/libssl/man/SSL_get_ex_data_X509_STORE_CTX_idx.3 
> lib/libssl/man/SSL_get_ex_data_X509_STORE_CTX_idx.3
> index e30e4de84fa..adea288e4df 100644
> --- lib/libssl/man/SSL_get_ex_data_X509_STORE_CTX_idx.3
> +++ lib/libssl/man/SSL_get_ex_data_X509_STORE_CTX_idx.3
> @@ -104,7 +104,7 @@ provides access to
>  object for the connection during the
>  .Fn verify_callback
>  when checking the peer's certificate.
> -Please check the example in
> +Check the example in
>  .Xr SSL_CTX_set_verify 3 .
>  .Sh SEE ALSO
>  .Xr CRYPTO_set_ex_data 3 ,
> diff --git sbin/iked/iked.conf.5 sbin/iked/iked.conf.5
> index 78dfbbfa1d1..7343c4a01ea 100644
> --- sbin/iked/iked.conf.5
> +++ sbin/iked/iked.conf.5
> @@ -197,8 +197,7 @@ Enable OCSP and set the fallback URL of the OCSP 
> responder.
>  This fallback will be used if the trusted CA from
>  .Pa /etc/iked/ca/
>  does not have an OCSP-URL extension.
> -Please note that the matching responder certificates
> -have to be placed in
> +The matching responder certificates have to be placed in
>  .Pa /etc/iked/ocsp/responder.crt .
>  .Pp
>  The optional
> @@ -231,7 +230,7 @@ and the
>  and
>  .Ar password
>  arguments.
> -Note that the password has to be specified in plain text which is
> +The password has to be specified in plain text which is
>  required to support different challenge-based EAP methods like
>  EAP-MD5 or EAP-MSCHAPv2.
>  .El
> @@ -255,7 +254,7 @@ the connection, the default action is to ignore the 
> connection attempt or
>  to use the
>  .Ar default
>  policy, if set.
> -Please also see the
> +See the
>  .Sx EXAMPLES
>  section for a detailed example of the policy evaluation.
>  .Pp
> @@ -360,7 +359,7 @@ which can be either
>  .Ar inet
>  or
>  .Ar inet6 .
> -Note that this only matters for IKEv2 endpoints and does not
> +This only matters for IKEv2 endpoints and does not
>  restrict the traffic selectors to negotiate flows with different
>  address families, e.g. IPv6 flows negotiated by IPv4 endpoints.
>  .Pp
> @@ -626,7 +625,7 @@ and
>  .Ql G
>  for kilo-, mega- and gigabytes accordingly.
>  .Pp
> -Please note that rekeying must happen at least several times a day as
> +Rekeying must happen at least several times a day as
>  IPsec security heavily depends on frequent key renewals.
>  .Pp
>  .It Op Ar ikeauth
> @@ -1028,7 +1027,7 @@ The currently supported group types are either
>  MODP (exponentiation groups modulo a prime),
>  ECP (elliptic curve groups modulo a prime),
>  or Curve25519.
> -Please note that MODP groups of less than

drop please from manual pages

2022-02-05 Thread Jonathan Gray
drop please from manual pages excluding third party parts of tree
suggested by multiple documentation style guides

diff --git lib/libc/stdlib/atexit.3 lib/libc/stdlib/atexit.3
index a95a45b92e4..891641489e3 100644
--- lib/libc/stdlib/atexit.3
+++ lib/libc/stdlib/atexit.3
@@ -68,7 +68,7 @@ that matters, not the source of the function that was 
registered.
 is very difficult to use correctly without creating
 .Xr exit 3 Ns -time
 races.
-Unless absolutely necessary, please avoid using it.
+Unless absolutely necessary, avoid using it.
 .Sh RETURN VALUES
 The
 .Nm
diff --git lib/libc/sys/getentropy.2 lib/libc/sys/getentropy.2
index 234969e7a1d..942a591a0cc 100644
--- lib/libc/sys/getentropy.2
+++ lib/libc/sys/getentropy.2
@@ -33,7 +33,7 @@ as input for process-context pseudorandom generators like
 The maximum buffer size permitted is 256 bytes.
 .Pp
 .Fn getentropy
-is not intended for regular code; please use the
+is not intended for regular code; use the
 .Xr arc4random 3
 family of functions instead.
 .Pp
diff --git lib/libkeynote/keynote.4 lib/libkeynote/keynote.4
index aabd2db365d..6e5a29dffb4 100644
--- lib/libkeynote/keynote.4
+++ lib/libkeynote/keynote.4
@@ -374,7 +374,7 @@ attribute
 .Sh QUERY SEMANTICS
 The discussion in the following sections assume some familiarity with
 assertion syntax.
-Please refer to
+Refer to
 .Xr keynote 5
 for more details on the syntax.
 .Sh QUERY PARAMETERS
diff --git lib/libpthread/man/pthreads.3 lib/libpthread/man/pthreads.3
index 94e86227874..c2de5274f3a 100644
--- lib/libpthread/man/pthreads.3
+++ lib/libpthread/man/pthreads.3
@@ -463,7 +463,7 @@ conform to
 .St -p1003.1-96
 and various later versions of
 .Pq Dq Tn POSIX .
-Please consult the manpages for the individual functions for details.
+Consult the manpages for the individual functions for details.
 .Sh HISTORY
 This 1-to-1 implementation of the
 .Nm
diff --git lib/libssl/man/SSL_get_ex_data_X509_STORE_CTX_idx.3 
lib/libssl/man/SSL_get_ex_data_X509_STORE_CTX_idx.3
index e30e4de84fa..adea288e4df 100644
--- lib/libssl/man/SSL_get_ex_data_X509_STORE_CTX_idx.3
+++ lib/libssl/man/SSL_get_ex_data_X509_STORE_CTX_idx.3
@@ -104,7 +104,7 @@ provides access to
 object for the connection during the
 .Fn verify_callback
 when checking the peer's certificate.
-Please check the example in
+Check the example in
 .Xr SSL_CTX_set_verify 3 .
 .Sh SEE ALSO
 .Xr CRYPTO_set_ex_data 3 ,
diff --git sbin/iked/iked.conf.5 sbin/iked/iked.conf.5
index 78dfbbfa1d1..7343c4a01ea 100644
--- sbin/iked/iked.conf.5
+++ sbin/iked/iked.conf.5
@@ -197,8 +197,7 @@ Enable OCSP and set the fallback URL of the OCSP responder.
 This fallback will be used if the trusted CA from
 .Pa /etc/iked/ca/
 does not have an OCSP-URL extension.
-Please note that the matching responder certificates
-have to be placed in
+The matching responder certificates have to be placed in
 .Pa /etc/iked/ocsp/responder.crt .
 .Pp
 The optional
@@ -231,7 +230,7 @@ and the
 and
 .Ar password
 arguments.
-Note that the password has to be specified in plain text which is
+The password has to be specified in plain text which is
 required to support different challenge-based EAP methods like
 EAP-MD5 or EAP-MSCHAPv2.
 .El
@@ -255,7 +254,7 @@ the connection, the default action is to ignore the 
connection attempt or
 to use the
 .Ar default
 policy, if set.
-Please also see the
+See the
 .Sx EXAMPLES
 section for a detailed example of the policy evaluation.
 .Pp
@@ -360,7 +359,7 @@ which can be either
 .Ar inet
 or
 .Ar inet6 .
-Note that this only matters for IKEv2 endpoints and does not
+This only matters for IKEv2 endpoints and does not
 restrict the traffic selectors to negotiate flows with different
 address families, e.g. IPv6 flows negotiated by IPv4 endpoints.
 .Pp
@@ -626,7 +625,7 @@ and
 .Ql G
 for kilo-, mega- and gigabytes accordingly.
 .Pp
-Please note that rekeying must happen at least several times a day as
+Rekeying must happen at least several times a day as
 IPsec security heavily depends on frequent key renewals.
 .Pp
 .It Op Ar ikeauth
@@ -1028,7 +1027,7 @@ The currently supported group types are either
 MODP (exponentiation groups modulo a prime),
 ECP (elliptic curve groups modulo a prime),
 or Curve25519.
-Please note that MODP groups of less than 2048 bits are considered
+MODP groups of less than 2048 bits are considered
 as weak or insecure (see RFC 8247 section 2.4) and only provided for
 backwards compatibility.
 .Sh FILES
diff --git sbin/isakmpd/isakmpd.conf.5 sbin/isakmpd/isakmpd.conf.5
index 4d35e162393..1ea562f3447 100644
--- sbin/isakmpd/isakmpd.conf.5
+++ sbin/isakmpd/isakmpd.conf.5
@@ -1372,7 +1372,7 @@ LIFE_DURATION=1000,768:1536
 .Xr isakmpd 8
 .Sh CAVEATS
 Using aggressive mode is discouraged due to various design problems.
-If your peer only supports aggressive mode, please consider replacing that
+If your peer only supports aggressive mode, consider replacing that
 peer with a sane ISAKMP/IKE implementation.
 For details see
 .Lk