Re: Typo Diffs
On Fri, Oct 16, 2020 at 02:36:39AM +, Varik Valefor wrote: > Sir or Madam: > > Included within this message should be some diffs which can be applied to > fix some typographical errors and general wording problems which exist > within the OpenBSD manual pages, as well as some other files. > > These changes are proposed because typographical errors look bad and can > lead to assumptions of incompetence. > > KUTGW, > Varik "NOT A COMPUTER PROGRAMMER!!!" Valefor > hi. thanks for your mail - typo fixes are always welcome! i have committed fixes for the two instances of "the the". i'm afraid the other parts of the diff are really just questions of preference, and don;t represent enough of a clear improvement to be committed. none of them are errors (at least, not in 2020). thanks, jmc > - BEGIN DIFFS - > diff --git a/lib/libutil/ober_add_string.3 b/lib/libutil/ober_add_string.3 > index 5eb6bd32ea0..77a13e629a0 100644 > --- a/lib/libutil/ober_add_string.3 > +++ b/lib/libutil/ober_add_string.3 > @@ -134,7 +134,7 @@ creates zero or more > structures. > For each byte in > .Fa fmt , > -arguments of the the types given in the following table are consumed > +arguments of the types given in the following table are consumed > and passed to the listed function, creating one > .Vt ber_element > per byte. > > diff --git a/share/man/man9/physio.9 b/share/man/man9/physio.9 > index 528581eedaa..2977813bbe8 100644 > --- a/share/man/man9/physio.9 > +++ b/share/man/man9/physio.9 > @@ -56,7 +56,7 @@ The maximum amount of data to transfer with each call to > is determined by the > .Fa minphys > routine. > -Since > +Because > .Fa uio > normally describes user space addresses, > .Fn physio > @@ -85,7 +85,9 @@ A break-down of the arguments follows: > The device strategy routine to call for each chunk of data to initiate > device I/O. > .It Fa dev > -The device number identifying the device to interact with. > +The device number of the device with which > +.Nm > +should interact. > .It Fa flags > Direction of transfer; the only valid settings are > .Dv B_READ > > diff --git a/usr.bin/ftp/ftp.1 b/usr.bin/ftp/ftp.1 > index 4f4bfd8d5d5..b5683b0d546 100644 > --- a/usr.bin/ftp/ftp.1 > +++ b/usr.bin/ftp/ftp.1 > @@ -316,7 +316,7 @@ slow connection after > The host with which > .Nm > is to communicate may be specified on the command line. > -If this is done, > +If this host is specified, > .Nm > will immediately attempt to establish a connection to an > FTP server on that host; otherwise, > @@ -1675,7 +1675,7 @@ entry cannot be utilized by multiple > .Ic machine > definitions; rather, it must be defined following each > .Ic machine > -it is intended to be used with. > +with which it is to be used. > If a macro named > .Ic init > is defined, it is automatically executed as the last step in the > > diff --git a/usr.bin/sed/sed.1 b/usr.bin/sed/sed.1 > index 87a5d04aa4a..4d4b0d3660c 100644 > --- a/usr.bin/sed/sed.1 > +++ b/usr.bin/sed/sed.1 > @@ -427,7 +427,7 @@ string for the first instance of the regular expression > in the pattern space. > Any character other than backslash or newline can be used instead of > a slash to delimit the regular expression and the replacement. > -Also see the the section about > +Also see the section about > .Sx SED REGULAR EXPRESSIONS . > .Pp > An ampersand > > diff --git a/usr.bin/openssl/openssl.1 b/usr.bin/openssl/openssl.1 > index e364586f5ad..f1f4361c472 100644 > --- a/usr.bin/openssl/openssl.1 > +++ b/usr.bin/openssl/openssl.1 > @@ -408,10 +408,10 @@ are assumed to be the names of files containing > certificate requests. > The > .Fa password > used to encrypt the private key. > -Since on some systems the command line arguments are visible, > +On some systems, the command line arguments are visible; therefore, > this option should be used with caution. > .It Fl keyfile Ar file > -The private key to sign requests with. > +The private key with which requests should be signed. > .It Fl keyform Cm pem | der > Private key file format. > The default is > > diff --git a/usr.bin/x99token/x99token.1 b/usr.bin/x99token/x99token.1 > index 1d004dea440..8a29f22ce99 100644 > --- a/usr.bin/x99token/x99token.1 > +++ b/usr.bin/x99token/x99token.1 > @@ -49,7 +49,7 @@ is not specified, > is in calculator mode. > In this mode you must enter the same PIN as used in the initialization step. > The PIN is used to decode the key read from the keyfile. > -Next you enter the challenge you have been presented with. > +Next, you enter the challenge which has been presented to you. > The > .Nm > program will provide you with a response to the challenge. > > diff --git a/usr.bin/openssl/openssl.1 b/usr.bin/openssl/openssl.1 > index e364586f5ad..da4b73aee3c 100644 > --- a/usr.bin/openssl/openssl.1 > +++ b/usr.bin/openssl/openssl.1 > @@ -371,7 +371,7 @@ If reading the serial from the text file as specified in > the > configuration fails, create a new random serial
Re: Typo Diffs
On 2020/10/16 02:36, Varik Valefor wrote:
> Sir or Madam:
>
> Included within this message should be some diffs which can be applied to
> fix some typographical errors and general wording problems which exist
> within the OpenBSD manual pages, as well as some other files.
>
> These changes are proposed because typographical errors look bad and can
> lead to assumptions of incompetence.
>
> KUTGW,
> Varik "NOT A COMPUTER PROGRAMMER!!!" Valefor
The "the the" fixes are good; the others seem to mostly be stylistic
changes which are a matter of opinion, a diff in the reverse direction
would be equally valid, we don't usually commit changes like that though
the maintainers of the relevant parts of the tree may take some of them.
One proposed change in openssl(1) is clearly worse ("to for").
> - BEGIN DIFFS -
> diff --git a/lib/libutil/ober_add_string.3 b/lib/libutil/ober_add_string.3
> index 5eb6bd32ea0..77a13e629a0 100644
> --- a/lib/libutil/ober_add_string.3
> +++ b/lib/libutil/ober_add_string.3
> @@ -134,7 +134,7 @@ creates zero or more
> structures.
> For each byte in
> .Fa fmt ,
> -arguments of the the types given in the following table are consumed
> +arguments of the types given in the following table are consumed
> and passed to the listed function, creating one
> .Vt ber_element
> per byte.
>
> diff --git a/share/man/man9/physio.9 b/share/man/man9/physio.9
> index 528581eedaa..2977813bbe8 100644
> --- a/share/man/man9/physio.9
> +++ b/share/man/man9/physio.9
> @@ -56,7 +56,7 @@ The maximum amount of data to transfer with each call to
> is determined by the
> .Fa minphys
> routine.
> -Since
> +Because
> .Fa uio
> normally describes user space addresses,
> .Fn physio
> @@ -85,7 +85,9 @@ A break-down of the arguments follows:
> The device strategy routine to call for each chunk of data to initiate
> device I/O.
> .It Fa dev
> -The device number identifying the device to interact with.
> +The device number of the device with which
> +.Nm
> +should interact.
> .It Fa flags
> Direction of transfer; the only valid settings are
> .Dv B_READ
>
> diff --git a/usr.bin/ftp/ftp.1 b/usr.bin/ftp/ftp.1
> index 4f4bfd8d5d5..b5683b0d546 100644
> --- a/usr.bin/ftp/ftp.1
> +++ b/usr.bin/ftp/ftp.1
> @@ -316,7 +316,7 @@ slow connection after
> The host with which
> .Nm
> is to communicate may be specified on the command line.
> -If this is done,
> +If this host is specified,
> .Nm
> will immediately attempt to establish a connection to an
> FTP server on that host; otherwise,
> @@ -1675,7 +1675,7 @@ entry cannot be utilized by multiple
> .Ic machine
> definitions; rather, it must be defined following each
> .Ic machine
> -it is intended to be used with.
> +with which it is to be used.
> If a macro named
> .Ic init
> is defined, it is automatically executed as the last step in the
>
> diff --git a/usr.bin/sed/sed.1 b/usr.bin/sed/sed.1
> index 87a5d04aa4a..4d4b0d3660c 100644
> --- a/usr.bin/sed/sed.1
> +++ b/usr.bin/sed/sed.1
> @@ -427,7 +427,7 @@ string for the first instance of the regular expression
> in the pattern space.
> Any character other than backslash or newline can be used instead of
> a slash to delimit the regular expression and the replacement.
> -Also see the the section about
> +Also see the section about
> .Sx SED REGULAR EXPRESSIONS .
> .Pp
> An ampersand
>
> diff --git a/usr.bin/openssl/openssl.1 b/usr.bin/openssl/openssl.1
> index e364586f5ad..f1f4361c472 100644
> --- a/usr.bin/openssl/openssl.1
> +++ b/usr.bin/openssl/openssl.1
> @@ -408,10 +408,10 @@ are assumed to be the names of files containing
> certificate requests.
> The
> .Fa password
> used to encrypt the private key.
> -Since on some systems the command line arguments are visible,
> +On some systems, the command line arguments are visible; therefore,
> this option should be used with caution.
> .It Fl keyfile Ar file
> -The private key to sign requests with.
> +The private key with which requests should be signed.
> .It Fl keyform Cm pem | der
> Private key file format.
> The default is
>
> diff --git a/usr.bin/x99token/x99token.1 b/usr.bin/x99token/x99token.1
> index 1d004dea440..8a29f22ce99 100644
> --- a/usr.bin/x99token/x99token.1
> +++ b/usr.bin/x99token/x99token.1
> @@ -49,7 +49,7 @@ is not specified,
> is in calculator mode.
> In this mode you must enter the same PIN as used in the initialization step.
> The PIN is used to decode the key read from the keyfile.
> -Next you enter the challenge you have been presented with.
> +Next, you enter the challenge which has been presented to you.
> The
> .Nm
> program will provide you with a response to the challenge.
>
> diff --git a/usr.bin/openssl/openssl.1 b/usr.bin/openssl/openssl.1
> index e364586f5ad..da4b73aee3c 100644
> --- a/usr.bin/openssl/openssl.1
> +++ b/usr.bin/openssl/openssl.1
> @@ -371,7 +371,7 @@ If reading the serial from the text file as specified in
> the
> configuration fails, create a new random serial
Typo Diffs
Sir or Madam: Included within this message should be some diffs which can be applied to fix some typographical errors and general wording problems which exist within the OpenBSD manual pages, as well as some other files. These changes are proposed because typographical errors look bad and can lead to assumptions of incompetence. KUTGW, Varik "NOT A COMPUTER PROGRAMMER!!!" Valefor - BEGIN DIFFS - diff --git a/lib/libutil/ober_add_string.3 b/lib/libutil/ober_add_string.3 index 5eb6bd32ea0..77a13e629a0 100644 --- a/lib/libutil/ober_add_string.3 +++ b/lib/libutil/ober_add_string.3 @@ -134,7 +134,7 @@ creates zero or more structures. For each byte in .Fa fmt , -arguments of the the types given in the following table are consumed +arguments of the types given in the following table are consumed and passed to the listed function, creating one .Vt ber_element per byte. diff --git a/share/man/man9/physio.9 b/share/man/man9/physio.9 index 528581eedaa..2977813bbe8 100644 --- a/share/man/man9/physio.9 +++ b/share/man/man9/physio.9 @@ -56,7 +56,7 @@ The maximum amount of data to transfer with each call to is determined by the .Fa minphys routine. -Since +Because .Fa uio normally describes user space addresses, .Fn physio @@ -85,7 +85,9 @@ A break-down of the arguments follows: The device strategy routine to call for each chunk of data to initiate device I/O. .It Fa dev -The device number identifying the device to interact with. +The device number of the device with which +.Nm +should interact. .It Fa flags Direction of transfer; the only valid settings are .Dv B_READ diff --git a/usr.bin/ftp/ftp.1 b/usr.bin/ftp/ftp.1 index 4f4bfd8d5d5..b5683b0d546 100644 --- a/usr.bin/ftp/ftp.1 +++ b/usr.bin/ftp/ftp.1 @@ -316,7 +316,7 @@ slow connection after The host with which .Nm is to communicate may be specified on the command line. -If this is done, +If this host is specified, .Nm will immediately attempt to establish a connection to an FTP server on that host; otherwise, @@ -1675,7 +1675,7 @@ entry cannot be utilized by multiple .Ic machine definitions; rather, it must be defined following each .Ic machine -it is intended to be used with. +with which it is to be used. If a macro named .Ic init is defined, it is automatically executed as the last step in the diff --git a/usr.bin/sed/sed.1 b/usr.bin/sed/sed.1 index 87a5d04aa4a..4d4b0d3660c 100644 --- a/usr.bin/sed/sed.1 +++ b/usr.bin/sed/sed.1 @@ -427,7 +427,7 @@ string for the first instance of the regular expression in the pattern space. Any character other than backslash or newline can be used instead of a slash to delimit the regular expression and the replacement. -Also see the the section about +Also see the section about .Sx SED REGULAR EXPRESSIONS . .Pp An ampersand diff --git a/usr.bin/openssl/openssl.1 b/usr.bin/openssl/openssl.1 index e364586f5ad..f1f4361c472 100644 --- a/usr.bin/openssl/openssl.1 +++ b/usr.bin/openssl/openssl.1 @@ -408,10 +408,10 @@ are assumed to be the names of files containing certificate requests. The .Fa password used to encrypt the private key. -Since on some systems the command line arguments are visible, +On some systems, the command line arguments are visible; therefore, this option should be used with caution. .It Fl keyfile Ar file -The private key to sign requests with. +The private key with which requests should be signed. .It Fl keyform Cm pem | der Private key file format. The default is diff --git a/usr.bin/x99token/x99token.1 b/usr.bin/x99token/x99token.1 index 1d004dea440..8a29f22ce99 100644 --- a/usr.bin/x99token/x99token.1 +++ b/usr.bin/x99token/x99token.1 @@ -49,7 +49,7 @@ is not specified, is in calculator mode. In this mode you must enter the same PIN as used in the initialization step. The PIN is used to decode the key read from the keyfile. -Next you enter the challenge you have been presented with. +Next, you enter the challenge which has been presented to you. The .Nm program will provide you with a response to the challenge. diff --git a/usr.bin/openssl/openssl.1 b/usr.bin/openssl/openssl.1 index e364586f5ad..da4b73aee3c 100644 --- a/usr.bin/openssl/openssl.1 +++ b/usr.bin/openssl/openssl.1 @@ -371,7 +371,7 @@ If reading the serial from the text file as specified in the configuration fails, create a new random serial to be used as the next serial number. .It Fl days Ar arg -The number of days to certify the certificate for. +The number of days for which the certificate should be certified. .It Fl enddate Ar date Set the expiry date. The format of the date is [YY]YYMMDDHHMMSSZ, @@ -408,10 +408,10 @@ are assumed to be the names of files containing certificate requests. The .Fa password used to encrypt the private key. -Since on some systems the command line arguments are visible, +On some systems, the command-line arguments are visible; therefore, this option should be used with caution. .It Fl keyfile Ar file -The private key to sign requests
