Fix typos, repeated words, align spelling to LDP #16712

gustafn · 2021-09-29T21:21:53Z

This is a followup to PR #12527, which i seem to have closed. This PR contains various spelling improvements (typos, repeated words) and aligns the spelling with the rules of the Linux Documentation project.

Checklist

documentation is added or updated

t8m · 2021-09-30T07:57:07Z

Ouch, this is a huge patch. I suppose we do not want this on older branches.

gustafn · 2021-09-30T10:50:42Z

Ouch, this is a huge patch. I suppose we do not want this on older branches.

It is about the same size as before. Not sure if splitting would help.

t8m · 2021-09-30T11:13:14Z

I am not asking for split, although splitting it might make it more easily reviewable.

t8m

Good work! Some changes need to be dropped or adjusted. Please use git commit --fixup to commit the changes according to the review.

CHANGES.md

t8m · 2021-10-15T12:54:23Z

CHANGES.md

 * AIX shared library support overhaul. Switch to AIX "natural" way of
   handling shared libraries, which means collecting shared objects of
-   different versions and bitnesses in one common archive. This allows to
+   different versions and bitnesses in one common archive. This allows us to


Why adding us

This is a common error in technical writings by non-native-speakers of English
https://english.stackexchange.com/questions/85069/is-the-construction-it-allows-to-proper-english

I have made a slightly rephrased suggestion.

CHANGES.md

t8m · 2021-10-15T13:15:17Z

crypto/ui/ui_openssl.c

@@ -448,7 +448,7 @@ static int open_console(UI *ui)
 #  endif
 #  ifdef ENODEV
            /*
-             * MacOS X returns ENODEV (Operation not supported by device),
+             * macOS X returns ENODEV (Operation not supported by device),


Please drop this

I've changed it back as requested. Please note that Apple has changed the capitalization a few years ago towards macOS (10.12)

t8m · 2021-10-15T13:17:14Z

doc/man3/ASYNC_start_job.pod

@@ -51,7 +51,7 @@ will be automatically created, as long as the total of B<ASYNC_JOB>s managed by
 the pool does not exceed I<max_size>. When the pool is first initialised
 I<init_size> B<ASYNC_JOB>s will be created immediately. If ASYNC_init_thread()
 is not called before the pool is first used then it will be called automatically
-with a I<max_size> of 0 (no upper limit) and an I<init_size> of 0 (no
+with a I<max_size> of 0 (no upper limit) and a I<init_size> of 0 (no


This does not look like correct change.

t8m · 2021-10-15T13:18:07Z

doc/man3/EC_GROUP_new.pod

@@ -117,7 +117,7 @@ over Fp I<p> is the prime for the field. For a curve over F2^m I<p> represents
 the irreducible polynomial - each bit represents a term in the polynomial.
 Therefore, there will either be three or five bits set dependent on whether the
 polynomial is a trinomial or a pentanomial.
-In either case, I<a> and I<b> represents the coefficients a and b from the
+In either case, I<a> and I<b> represents the coefficients I<a> and I<b> from the


Please revert this.

t8m · 2021-10-15T13:20:54Z

doc/man3/SSL_set_bio.pod

@@ -70,7 +70,7 @@ references are consumed for the B<rbio>.

 If the B<rbio> and B<wbio> parameters are different and the B<wbio> is the
 same as the previously set value and the old B<rbio> and B<wbio> values
-were the same as each other then one reference is consumed for the B<rbio>
+were the same as each other than one reference is consumed for the B<rbio>


Incorrect change, please revert. This is If.... then....

t8m · 2021-10-15T13:25:31Z

include/openssl/core_names.h

@@ -267,7 +267,7 @@ extern "C" {
 #define OSSL_DRBG_PARAM_ENTROPY_REQUIRED        "entropy_required"
 #define OSSL_DRBG_PARAM_PREDICTION_RESISTANCE   "prediction_resistance"
 #define OSSL_DRBG_PARAM_MIN_LENGTH              "minium_length"
-#define OSSL_DRBG_PARAM_MAX_LENGTH              "maxium_length"
+#define OSSL_DRBG_PARAM_MAX_LENGTH              "maximum_length"


Ha, nice catch but we will need separate PR for this as this changes API of providers. Perhaps we will need a compatibility item... unsure what to do with this.

So please drop this change and open an issue.

minium isnt quite right either :)

Heh, right.

ok, reverted. Will open a separate ticket.

slontis · 2021-10-21T05:55:36Z

crypto/property/property_err.c

    "not an ascii character"},
    {ERR_PACK(ERR_LIB_PROP, 0, PROP_R_NOT_AN_HEXADECIMAL_DIGIT),
-    "not an hexadecimal digit"},
+    "not a hexadecimal digit"},


This is also a generated file..

IMO unless you drop the openssl.txt this is not going to be changed by the generator scripts.

The same change was as well in crypto/err/openssl.txt, so the generator scripts will produce the same .c file in case they are triggered. I've left this change in the PR.

slontis · 2021-10-21T06:10:58Z

crypto/x509/v3err.c

@@ -15,7 +15,7 @@
 #ifndef OPENSSL_NO_ERR

 static const ERR_STRING_DATA X509V3_str_reasons[] = {
-    {ERR_PACK(ERR_LIB_X509V3, 0, X509V3_R_BAD_IP_ADDRESS), "bad ip address"},
+    {ERR_PACK(ERR_LIB_X509V3, 0, X509V3_R_BAD_IP_ADDRESS), "bad IP address"},


Another generated error file..

Same as above.

gustafn · 2021-10-26T09:33:54Z

The changes were committed with the --fixup flag.

t8m · 2021-10-26T14:05:00Z

doc/man3/ASYNC_start_job.pod

 I<init_size> B<ASYNC_JOB>s will be created immediately. If ASYNC_init_thread()
 is not called before the pool is first used then it will be called automatically
-with a I<max_size> of 0 (no upper limit) and a I<init_size> of 0 (no
+with an I<max_size> of 0 (no upper limit) and a I<init_size> of 0 (no


This is still wrong. You did not revert the a I<init... but changed further an I<max... which should be kept with a.

t8m · 2021-10-27T12:15:59Z

Could you please rebase the PR to resolve the conflict?

openssl-machine · 2021-11-27T00:07:03Z

This PR is in a state where it requires action by @openssl/committers but the last update was 30 days ago

Make it clear that the cipher/digest objects returned from EVP_get_cipherbyname() and EVP_get_digestbyname() functions have no associated implementation fetched from a provider. Fixes openssl#16864 Reviewed-by: Paul Dale <pauli@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from openssl#16893)

… LDP. Mostly revamped from #16712 - fall thru -> fall through - time stamp -> timestamp - host name -> hostname - ipv6 -> IPv6 Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from #19059) (cherry picked from commit 9929c81)

openssl-machine · 2022-12-15T00:08:58Z

This PR is in a state where it requires action by @openssl/committers but the last update was 309 days ago

partially revamped from openssl#16712 - fall thru -> fall through - time stamp -> timestamp - file name -> filename - host name -> hostname Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from openssl#19059)

partially revamped from openssl#16712 - fall thru -> fall through - time stamp -> timestamp - host name -> hostname - ipv6 -> IPv6 Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from openssl#19059)

Partially revamped from openssl#16712 - fall thru -> fall through - time stamp -> timestamp - host name -> hostname - ipv6 -> IPv6 Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from openssl#19059)

… LDP. Mostly revamped from openssl#16712 - fall thru -> fall through - time stamp -> timestamp - host name -> hostname - ipv6 -> IPv6 Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from openssl#19059)

openssl-machine · 2023-01-15T00:08:59Z

This PR is in a state where it requires action by @openssl/committers but the last update was 340 days ago

openssl-machine · 2023-02-15T00:09:58Z

This PR is in a state where it requires action by @openssl/committers but the last update was 371 days ago

openssl-machine · 2023-03-18T00:10:04Z

This PR is in a state where it requires action by @openssl/committers but the last update was 402 days ago

openssl-machine · 2023-04-18T00:09:36Z

This PR is in a state where it requires action by @openssl/committers but the last update was 433 days ago

tom-cosgrove-arm · 2023-04-18T06:02:32Z

@gustafn There are a lot of "various spelling improvements" in this, some clear typo fixes, some preferences. With such a large PR, and such a variety of different changes, it takes a long time to get it through, and a lot of work by reviewers.

I would suggest splitting into smaller PRs, where each one does the same kind of thing: e.g. clear typo fixes in one (file name to filename is preference, not a typo fix). Then parts of this whole can go through, and any sticking points resolved more easily

gustafn · 2023-04-18T08:04:55Z

I would suggest splitting into smaller PRs, where each one does the same kind of thing: e.g. clear typo fixes in one (file name to filename is preference, not a typo fix). Then parts of this whole can go through, and any sticking points resolved more easily

I will do so. Sorry, for being so lame in this matter, I had some hospital time with an every growing work list, some other more urgent releases... Split this huge change and rechecking will take me some time in a block... But I'll certainly come back to this.

Thanks for the reminder and giving me the feeling that this is appreciated!

openssl-machine · 2023-05-19T00:09:24Z

This PR is in a state where it requires action by @openssl/committers but the last update was 30 days ago

openssl-machine · 2023-06-19T00:09:43Z

This PR is in a state where it requires action by @openssl/committers but the last update was 61 days ago

openssl-machine · 2023-07-20T00:09:14Z

This PR is in a state where it requires action by @openssl/committers but the last update was 92 days ago

openssl-machine · 2023-08-20T00:09:06Z

This PR is in a state where it requires action by @openssl/committers but the last update was 123 days ago

openssl-machine · 2023-09-20T00:09:46Z

This PR is in a state where it requires action by @openssl/committers but the last update was 154 days ago

openssl-machine · 2023-10-21T00:09:33Z

This PR is in a state where it requires action by @openssl/committers but the last update was 185 days ago

openssl-machine · 2023-11-21T00:09:59Z

This PR is in a state where it requires action by @openssl/committers but the last update was 216 days ago

openssl-machine · 2023-12-22T00:09:58Z

This PR is in a state where it requires action by @openssl/committers but the last update was 247 days ago

openssl-machine · 2024-01-22T00:09:29Z

This PR is in a state where it requires action by @openssl/committers but the last update was 278 days ago

openssl-machine · 2024-02-22T00:09:13Z

This PR is in a state where it requires action by @openssl/committers but the last update was 309 days ago

openssl-machine · 2024-03-24T00:09:06Z

This PR is in a state where it requires action by @openssl/committers but the last update was 340 days ago

openssl-machine · 2024-04-24T00:09:21Z

This PR is in a state where it requires action by @openssl/committers but the last update was 371 days ago

openssl-machine · 2024-05-25T00:09:12Z

This PR is in a state where it requires action by @openssl/committers but the last update was 402 days ago

openssl-machine · 2024-06-25T00:09:03Z

This PR is in a state where it requires action by @openssl/committers but the last update was 433 days ago

FdaSilvaYY · 2024-06-25T11:47:43Z

This PR can be close as I revamped most of it, and codebase has moved since.

t8m · 2024-06-25T12:18:37Z

Closing this then.

github-actions bot added the severity: fips change The pull request changes FIPS provider sources label Sep 29, 2021

Fix typos, repeated words, align spelling to LDP

a388552

gustafn force-pushed the master-src-typography branch from 8a818cb to a388552 Compare September 29, 2021 21:48

gustafn mentioned this pull request Sep 30, 2021

Fix typos, repeated words, align spelling to LDP #12527

Closed

1 task

t8m added branch: master Applies to master branch triaged: cleanup The issue/pr deals with cleanup of comments/docs not altering code significantly triaged: documentation The issue/pr deals with documentation (errors) approval: otc review pending labels Sep 30, 2021

t8m requested changes Oct 15, 2021

View reviewed changes

slontis reviewed Oct 21, 2021

View reviewed changes

fixup! Fix typos, repeated words, align spelling to LDP

e9563da

gustafn mentioned this pull request Oct 26, 2021

Misspelled constants in include/openssl/core_names.h #16919

Open

t8m requested changes Oct 26, 2021

View reviewed changes

t8m approved these changes Oct 26, 2021

View reviewed changes

t8m added approval: review pending This pull request needs review by a committer and removed approval: otc review pending labels Oct 26, 2021

gustafn force-pushed the master-src-typography branch from d0a1878 to 2703e06 Compare October 27, 2021 15:13

gustafn force-pushed the master-src-typography branch 2 times, most recently from 84e3b9b to 5872756 Compare December 8, 2021 18:07

fixup! fixup! Fix typos, repeated words, align spelling to LDP

00eec21

gustafn force-pushed the master-src-typography branch from 5872756 to 00eec21 Compare December 8, 2021 18:09

mattcaswell and others added 2 commits December 8, 2021 19:41

fixup! Fix typos, repeated words, align spelling to LDP

0b98e60

DimitriPapadopoulos mentioned this pull request May 9, 2023

Fix typos found by codespell #20910

Closed

2 tasks

t8m closed this Jun 25, 2024

Uh oh!

Fix typos, repeated words, align spelling to LDP #16712

Fix typos, repeated words, align spelling to LDP #16712

Uh oh!

Conversation

gustafn commented Sep 29, 2021

Checklist

Uh oh!

t8m commented Sep 30, 2021

Uh oh!

gustafn commented Sep 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

t8m commented Sep 30, 2021

Uh oh!

t8m left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gustafn commented Oct 26, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

t8m commented Oct 27, 2021

Uh oh!

openssl-machine commented Nov 27, 2021

Uh oh!

openssl-machine commented Dec 15, 2022

Uh oh!

openssl-machine commented Jan 15, 2023

Uh oh!

openssl-machine commented Feb 15, 2023

Uh oh!

openssl-machine commented Mar 18, 2023

Uh oh!

openssl-machine commented Apr 18, 2023

Uh oh!

tom-cosgrove-arm commented Apr 18, 2023

Uh oh!

gustafn commented Sep 30, 2021 •

edited

Loading