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 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 http://www.usenix.org/publications/login/1999-12/features/harmful.html . > diff --git sbin/isakmpd/isakmpd.policy.5 sbin/isakmpd/isakmpd.policy.5 > index 55fb593dfa6..96a1907034b 100644 > --- sbin/isakmpd/isakmpd.policy.5 > +++ sbin/isakmpd/isakmpd.policy.5 > @@ -143,7 +143,7 @@ SAs established from that point on (even if the > associated Phase 1 SA > was already established when the new policies were loaded). > The policy change will not affect already established Phase 2 SAs. > .Pp > -For more details on KeyNote assertion format, please see > +For more details on KeyNote assertion format, see > .Xr keynote 5 . > Briefly, KeyNote policy assertions used in IKE have the following > characteristics: > diff --git sbin/wsconsctl/wsconsctl.8 sbin/wsconsctl/wsconsctl.8 > index f7ef41c50bd..c43b7d5bcf7 100644 > --- sbin/wsconsctl/wsconsctl.8 > +++ sbin/wsconsctl/wsconsctl.8 > @@ -134,7 +134,7 @@ Modify the current keyboard encoding so that, when the > key is pressed, the same encoding sequence as > .Ar Left Control > is sent. > -For a full list of keysyms, and keycodes, please refer > +For a full list of keysyms, and keycodes, refer > to the > .Ar /usr/include/dev/wscons/wsksymdef.h > file. > diff --git share/man/man1/dpb.1 share/man/man1/dpb.1 > index dd8d040845a..a503fb6e675 100644 > --- share/man/man1/dpb.1 > +++ share/man/man1/dpb.1 > @@ -1408,7 +1408,7 @@ affinity mismatch, but job will start on the wrong host > anyways, as the queue > contains no other buildable path. > .El > .Pp > -Please note that the engine is no longer run after each package build event > +The engine is no longer run after each package build event > because of performance considerations, so the > .Sq Q > and > diff --git share/man/man4/carp.4 share/man/man4/carp.4 > index 1ea8d5c2dd5..cb14e7aeb76 100644 > --- share/man/man4/carp.4 > +++ share/man/man4/carp.4 > @@ -186,7 +186,7 @@ In this mode > never sends packets with its virtual MAC address as source. > Stealth mode prevents a switch from learning the virtual MAC > address, so that it has to flood the traffic to all its ports. > -Please note that activating stealth mode on a > +Activating stealth mode on a > .Nm > interface that has already been running might not work instantly. > As a workaround the VHID of the first carpnode can be changed to a > diff --git share/man/man4/ix.4 share/man/man4/ix.4 > index 52557648623..f368ce28bdb 100644 > --- share/man/man4/ix.4 > +++ share/man/man4/ix.4 > @@ -73,7 +73,7 @@ HotLava Tambora 64G4/80G4/64G6/120G6 (SFP+) > SFP+ adapters generally also support SFP type modules with their > associated 1000base-* media types. > .Pp > -Please note that the networking interface should be brought down before > +The networking interface should be brought down before > disconnecting fiber optics, otherwise irreversible damage might be caused > to the equipment. > .Sh SEE ALSO > diff --git share/man/man4/man4.i386/pcibios.4 > share/man/man4/man4.i386/pcibios.4 > index 65e046317d6..3596f9ff708 100644 > --- share/man/man4/man4.i386/pcibios.4 > +++ share/man/man4/man4.i386/pcibios.4 > @@ -90,7 +90,7 @@ And many BIOS implementations don't assign a bus number for > CardBuses. > .Pp > A typical symptom of this is the following boot message: > .D1 Sy cardbus0 at cardslot0: bus 0 device 0... > -Please note that this cardbus0 has a bus number > +This cardbus0 has a bus number > .Sq 0 , > but normally the bus number 0 is used by the machine's > primary PCI bus. > diff --git share/man/man4/tty.4 share/man/man4/tty.4 > index de51cc2d5b7..f4a9b5cab2e 100644 > --- share/man/man4/tty.4 > +++ share/man/man4/tty.4 > @@ -148,7 +148,7 @@ When the > line discipline is in effect, the terminal file behaves and is > operated according to the rules described in > .Xr termios 4 . > -Please refer to that man page for a full description of the terminal > +Refer to that man page for a full description of the terminal > semantics. > The operations described here > generally represent features common > diff --git share/man/man7/script.7 share/man/man7/script.7 > index 80542d1f46f..ab720e873e9 100644 > --- share/man/man7/script.7 > +++ share/man/man7/script.7 > @@ -337,7 +337,7 @@ described is largely portable across > style systems, with two significant exceptions: the maximum length of the > .Sq #! > line, and the behavior if multiple arguments are passed. > -Please be aware that the behavior in the > +Be aware that the behavior in the > face of multiple arguments is not consistent across systems. > .Sh HISTORY > The behavior of the kernel when encountering scripts that start in > diff --git share/man/man9/bus_space.9 share/man/man9/bus_space.9 > index b9fc6e1c71c..c1307eb7d4b 100644 > --- share/man/man9/bus_space.9 > +++ share/man/man9/bus_space.9 > @@ -1471,7 +1471,7 @@ must be a multiple of the access width or the results > are undefined. > .Pp > In all other respects these functions are the same as their non-raw > counterparts. > -Please consult the documentation for those functions for further > +Consult the documentation for those functions for further > information. > .Sh SEE ALSO > .Xr bus_dma 9 > diff --git usr.bin/mandoc/mandoc.1 usr.bin/mandoc/mandoc.1 > index 1e8dcc4b251..2c82f1efd4c 100644 > --- usr.bin/mandoc/mandoc.1 > +++ usr.bin/mandoc/mandoc.1 > @@ -835,7 +835,7 @@ message levels, the > .Cm style > level tries to reduce the probability that issues go unnoticed, > so it may occasionally issue bogus suggestions. > -Please use your good judgement to decide whether any particular > +Use your judgement to decide whether any particular > .Cm style > suggestion really justifies a change to the input file. > .It Cm base > diff --git usr.bin/skeyinit/skeyinit.1 usr.bin/skeyinit/skeyinit.1 > index 0e1a3060df6..e56a799b86d 100644 > --- usr.bin/skeyinit/skeyinit.1 > +++ usr.bin/skeyinit/skeyinit.1 > @@ -118,7 +118,7 @@ type must be specified via the > .Fl a > option > (see above). > -Please note that entering a password or passphrase in plain text > +Entering a password or passphrase in plain text > defeats the purpose of using > .Dq secure > mode. > diff --git usr.bin/ssh/ssh-keygen.1 usr.bin/ssh/ssh-keygen.1 > index e18a1cf65ee..fd51a02a529 100644 > --- usr.bin/ssh/ssh-keygen.1 > +++ usr.bin/ssh/ssh-keygen.1 > @@ -372,12 +372,12 @@ to use on files that mix hashed and non-hashed names. > .It Fl h > When signing a key, create a host certificate instead of a user > certificate. > -Please see the > +See the > .Sx CERTIFICATES > section for details. > .It Fl I Ar certificate_identity > Specify the key identity when signing a public key. > -Please see the > +See the > .Sx CERTIFICATES > section for details. > .It Fl i > @@ -469,7 +469,7 @@ Provides the new passphrase. > Specify one or more principals (user or host names) to be included in > a certificate when signing a key. > Multiple principals may be specified, separated by commas. > -Please see the > +See the > .Sx CERTIFICATES > section for details. > .It Fl O Ar option > @@ -534,7 +534,7 @@ but other methods may be supported in the future. > .It Cm write-attestation Ns = Ns Ar path > May be used at key generation time to record the attestation data > returned from FIDO tokens during key generation. > -Please note that this information is potentially sensitive. > +This information is potentially sensitive. > By default, this information is discarded. > .El > .Pp > @@ -594,7 +594,7 @@ Print the SSHFP fingerprint resource record named > for the specified public key file. > .It Fl s Ar ca_key > Certify (sign) a public key using the specified CA key. > -Please see the > +See the > .Sx CERTIFICATES > section for details. > .Pp > @@ -1059,7 +1059,7 @@ public key must be trusted by > .Xr sshd 8 > or > .Xr ssh 1 . > -Please refer to those manual pages for details. > +Refer to those manual pages for details. > .Sh KEY REVOCATION LISTS > .Nm > is able to manage OpenSSH format Key Revocation Lists (KRLs). > diff --git usr.bin/ssh/ssh.1 usr.bin/ssh/ssh.1 > index 6f29a067044..98765d4e1e8 100644 > --- usr.bin/ssh/ssh.1 > +++ usr.bin/ssh/ssh.1 > @@ -825,7 +825,7 @@ An attacker may then be able to perform activities such > as keystroke monitoring. > .Pp > For this reason, X11 forwarding is subjected to X11 SECURITY extension > restrictions by default. > -Please refer to the > +Refer to the > .Nm > .Fl Y > option and the > diff --git usr.sbin/relayd/relayd.conf.5 usr.sbin/relayd/relayd.conf.5 > index cecbae71f87..6740480bb04 100644 > --- usr.sbin/relayd/relayd.conf.5 > +++ usr.sbin/relayd/relayd.conf.5 > @@ -179,7 +179,7 @@ Set the global timeout in milliseconds for checks. > This can be overridden by the timeout value in the table definitions. > The default timeout is 200 milliseconds and it must not exceed the > global interval. > -Please note that the default value is optimized for checks within the > +The default value is optimized for checks within the > same collision domain \(en use a higher timeout, such as 1000 milliseconds, > for checks of hosts in other subnets. > If this option is to be set, it should be placed before overrides in tables. > diff --git usr.sbin/user/group.8 usr.sbin/user/group.8 > index 2b56c765917..bf0071e3c90 100644 > --- usr.sbin/user/group.8 > +++ usr.sbin/user/group.8 > @@ -65,7 +65,7 @@ and > .Xr groupdel 8 > commands. > .Pp > -For a full explanation of the options, please see the relevant manual page. > +For a full explanation of the options, see the relevant manual page. > .Sh EXIT STATUS > .Ex -std group > .Sh SEE ALSO > diff --git usr.sbin/user/user.8 usr.sbin/user/user.8 > index 11f08c17240..f0fd8a45bbd 100644 > --- usr.sbin/user/user.8 > +++ usr.sbin/user/user.8 > @@ -101,7 +101,7 @@ and > .Xr userdel 8 > commands. > .Pp > -For a full explanation of the options, please see the relevant manual page. > +For a full explanation of the options, see the relevant manual page. > .Sh FILES > .Bl -tag -width /etc/usermgmt.conf -compact > .It Pa /etc/skel/.[A-z]* >
