Skip to content

Conversation

@gustafn
Copy link
Contributor

@gustafn gustafn commented Jun 27, 2020

CLA: trivial

Checklist
  • documentation is added or updated

@openssl-machine openssl-machine added the hold: cla required The contributor needs to submit a license agreement label Jun 27, 2020
@gustafn
Copy link
Contributor Author

gustafn commented Jun 27, 2020

CLA: trivial was added by commit 9701755

@levitte
Copy link
Member

levitte commented Jun 28, 2020

We have, albeit maybe not loud enough, informally decided on British spelling.

@richsalz
Copy link
Contributor

See, for example, #10079 and the discussion.

@gustafn
Copy link
Contributor Author

gustafn commented Jun 29, 2020

there are currently US and UK spelling mixed. If there is interest, i can rework the pull request and target it to typos, word repetitions and US->UK spellings

@richsalz
Copy link
Contributor

If you do this (not commenting on whether or not it is worthwhile), you should look at #10079 and update util/find-doc-nits

@gustafn
Copy link
Contributor Author

gustafn commented Jun 29, 2020

Interestingly, the way from the current documentation to the US spelling seems shorter then the way to the UK spelling (raw data):

        # to US
        # 134 files changed, 335 insertions(+), 337 deletions(-)

        # to UK
        # 181 files changed, 391 insertions(+), 393 deletions(-)

There are currently several API calls in US spelling (just looking at the current documentation)

            CRYPTO_secure_malloc_initialized()
            EVP_RAND_verify_zeroization()
            OSSL_FUNC_rand_verify_zeroization()
            OSSL_FUNC_serializer_*()
            OSSL_OP_SERIALIZER
            OSSL_SERIALIZER_*()
            OSSL_SERIALIZER_PARAM_*
            RAND_DRBG_verify_zeroization()

Not sure, whether anyone wants to change the spelling of these API calls.... but having API calls in US and its docs in UK is also weird.

In case, UK vs. US is a controversial discussion, i could offer as a third option a pull request containing only spelling changes neutral to the UK vs. US issue.

@richsalz
Copy link
Contributor

I could offer as a third option a pull request containing only spelling changes neutral to the UK vs. US issue.

yes please. (I'm not a member of the project these days but I have done a lot of work improving the docs.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

hold: cla required The contributor needs to submit a license agreement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants