Skip to content

Conversation

@richsalz
Copy link
Contributor

@richsalz richsalz commented Oct 3, 2019

Update find-doc-nits to report an error when using US instead of UK spelling.

I am not sure if this catches everything, perhaps a subject of the Crown would want to take a look?

@richsalz
Copy link
Contributor Author

richsalz commented Oct 3, 2019

BTW ping @mattcaswell

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both sides the same?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

forgot to commit before pushing; updated commit.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

surely initialisation must be used somewhere?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wow, good catch. will add it and push a new commit.

@mattcaswell
Copy link
Member

Other possible words:

center -> centre
initialize -> initialise
initialization -> initialisation
realize -> realise
utilize ->utilise

@richsalz
Copy link
Contributor Author

richsalz commented Oct 3, 2019

Try this:

; apropos intialis | wc
; apropos initializ | wc

Does this change the view that we want UK wording?

@richsalz
Copy link
Contributor Author

richsalz commented Oct 3, 2019

Added Matt's list, fixed the errors, pushed a new commit.

@levitte
Copy link
Member

levitte commented Oct 3, 2019

The apropos should make difference... quite a lot of manuals go for US English, so... plus, you gotta spell "initialis" right 😉

Copy link
Member

@mattcaswell mattcaswell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@richsalz
Copy link
Contributor Author

richsalz commented Oct 3, 2019

Rather than typing it in, here's a cut/paste of real output on my machine (Debian something)

; apropos initialis | wc
      1       8      65
; apropos initializ | wc 
     36     283    2296

Is OpenSSL going in the wrong direction by using UK spelling?

@richsalz
Copy link
Contributor Author

richsalz commented Oct 3, 2019

After all, we just went through a lot of trouble to follow the man7 recommendations...

@mspncp
Copy link
Contributor

mspncp commented Oct 3, 2019

After all, we just went through a lot of trouble to follow the man7 recommendations...

Do you have a reference/link to spelling recommendations on man7.org?

@mspncp
Copy link
Contributor

mspncp commented Oct 3, 2019

Never mind, I found it (man man-pages):

   Spelling
       Starting with release 2.59, man-pages follows American spelling conven‐
       tions  (previously,  there  was  a  random  mix of British and American
       spellings); please write all new pages and patches according  to  these
       conventions.

       Aside  from  the well-known spelling differences, there are a few other
       subtleties to watch for:

       *  American English  tends  to  use  the  forms  "backward",  "upward",
          "toward",  and  so  on  rather  than  the British forms "backwards",
          "upwards", "towards", and so on.

@richsalz
Copy link
Contributor Author

richsalz commented Oct 3, 2019

I just sent email to openssl-project asking the OMC to formally decide on a policy.

@richsalz
Copy link
Contributor Author

richsalz commented Oct 3, 2019

Someone please mark this on HOLD until the decision.

@mspncp
Copy link
Contributor

mspncp commented Oct 3, 2019

Apropos: all these recent man7 changes have not been backported to 1.1.1. Shouldn't that be done in order to avoid a cherry-picking nightmare for 1.1.1 LTS?

~/src/openssl$ git log --left-right master...OpenSSL_1_1_1-stable --oneline  | grep man7
< 60a7817cac Add wordlist from man7.org
< c18d2d94c8 Funtion name with variable part in doc/man7/ and doc/internal/man3/
< dfabee82be Make doc/man7/ and doc/internal/man3/ conform with man-pages(7)

@levitte
Copy link
Member

levitte commented Oct 3, 2019

Is OpenSSL going in the wrong direction by using UK spelling?

I see nothing wrong with that. Making it a popularity contest is not a good reason not to, all it shows is that US folks have so far produced the majority of the documentation (for all sorts of reasons)

@richsalz
Copy link
Contributor Author

richsalz commented Oct 3, 2019

It is quite possible doing the cherry-pick will be a nightmare. What I would do is take the PR's and get the diff (via GitHub's .diff pro-tip), and edit filenames for things that have moved, and remove the diff for files that are new.

Or, you could wait until problems actually happen and fix those files.

Lucky for me, this topic came up after most of the changes were done.

@richsalz
Copy link
Contributor Author

richsalz commented Oct 3, 2019

all it shows is that US folks have so far produced the majority of the documentation

No, it doesn't show that. It shows that US spelling has dominated, not that the people writing things were all US people.

@t8m t8m added the hold label Oct 3, 2019
@vdukhovni
Copy link

My take is that policing the choice of UK/US spelling is probably not a good use of our time. What we need is more documentation. Nobody is confused merely because the spelling happens to be US, UK or even a mixture of the two in different sections of the same document.

I'm not opposed to commits that address inconsistencies in spelling within the same sentence or paragraph, variations in spelling can be tolerated, but should not be jarring. I am not in favour of automated normalisation. Even outdated spelling like connexion has its harmless charms if that's what makes the author feel good about writing more text.

@levitte
Copy link
Member

levitte commented Oct 3, 2019

No, it doesn't show that. It shows that US spelling has dominated, not that the people writing things were all US people.

You're right... sorry, tired...

@richsalz
Copy link
Contributor Author

richsalz commented Oct 3, 2019

... sorry, tired ...

Heh. Hard to be active in all timezones (europe, us, australia) without some snoozing :)

@mspncp
Copy link
Contributor

mspncp commented Oct 3, 2019

What I would do is take the PR's and get the diff (via GitHub's .diff pro-tip), and edit filenames for things that have moved, and remove the diff for files that are new.

Great fear and anxiousness I sense, Padavan. Trust in the force of git you must. The power of automatic rename detection strong is within git.

IOW: You will practically never need to save or edit patches, because git can do the job for you much faster. Just do a normal rebase or cherry-pick. Whenever git needs to fall back to 3-way merges, it will do an automatic rename detection. How far it goes back and forth in history (from head-of-master via common-merge-base to head-of-1.1.1) to detect the rename depends on the rename limit. You can increase it if necessary (git will tell you when that's the case). Here are my settings

git config merge.renamelimit 32768
git config diff.renamelimit 32768

HTH,
Matthias

P.S: No need for GitHub pro-tips to create diffs or patches: you can simply use
git show [<commit>] > file.diff or git format-patch.

(Edit: it's git show, not git diff)

@richsalz
Copy link
Contributor Author

richsalz commented Oct 3, 2019

I guess you can teach an old dog new tricks :) But I'm still glad I'm not on the hook for doing it.

@mspncp
Copy link
Contributor

mspncp commented Oct 3, 2019

But I'm still glad I'm not on the hook for doing it.

Just name the pr numbers. I'll take care of the backport ;-)

@mspncp
Copy link
Contributor

mspncp commented Oct 3, 2019

But I'm still glad I'm not on the hook for doing it.

Just name the pr numbers. I'll take care of the backport ;-)

Ah, don't bother. git will tell me anyway.

@richsalz
Copy link
Contributor Author

richsalz commented Oct 3, 2019

There are more coming still waiting for review/merge, but looking at git log It appears to be
#10039, #10023, #10073, #10064, #9974, #10041, #10022, #10043, #10034, #9986

There were various other PR's that impacted the docs which aren't mentioned above, as presumably they had their "backport?" question resolved in the PR.

@levitte
Copy link
Member

levitte commented Oct 3, 2019

@richsalz, of that lists of PRs, only #10039, #10023 and #9974 are still unmerged.

@t8m
Copy link
Member

t8m commented Oct 4, 2019

I have to say I am with @vdukhovni on this.

@richsalz
Copy link
Contributor Author

Was this discussed at the recent F2F? Should I just close this?

@t-j-h
Copy link
Member

t-j-h commented Oct 24, 2019

We have decided to not shift to US spelling.

@richsalz
Copy link
Contributor Author

And do you want to shift/enforce UK spelling? Should I close this?

@mattcaswell
Copy link
Member

Just close I think.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants