Align documentation with recommendation of Linux Documentation Project by gustafn · Pull Request #12460 · openssl/openssl

gustafn · 2020-07-16T08:20:09Z

CLA: trivial

This change applies the recommendation of the Linux Documentation Project
to the documentation files of OpenSSL. Additionally, util/find-doc-nits
was updated accordingly.

The change follows a suggestion of mspncp on #12370

Checklist

documentation is added or updated

mspncp

LGTM

t-j-h · 2020-07-16T22:56:50Z

This is not a trivial change IMHO. It requires a CLA. I would otherwise approve it.

mspncp · 2020-07-16T23:37:58Z

Hmm... I thought it was consensus to consider spelling corrections as not copyrightable?

t-j-h · 2020-07-16T23:49:37Z

These aren't spelling corrections ... and it does come to the scope of a change moving from trivial to non-trivial.

slontis · 2020-07-17T01:53:42Z

util/find-doc-nits

    'file name'     => 'filename',
    'file system'   => 'filesystem',
    'host name'     => 'hostname',
+    'host name'     => 'hostname',


Look like a duplicate?

slontis · 2020-07-17T01:54:14Z

util/find-doc-nits

+    'non-blocking'  => 'nonblocking',
+    'non-default'   => 'nondefault',
+    'non-empty'     => 'nonempty',
+    'non-negative'  => 'non-negative',


slontis · 2020-07-17T01:55:41Z

util/find-doc-nits

-    'super-user'    => 'superuser',
+    'sub-system'    => 'subsystem',
    'super block'   => 'superblock',
+    'super user'    => 'superuser',


move this down one.

slontis · 2020-07-17T01:56:06Z

util/find-doc-nits

    'useable'       => 'usable',
-    'userspace'     => 'user space',
    'user name'     => 'username',
+    'user name'     => 'username',


duplicate again?

slontis

util/find-doc-nits needs some changes..
I also think a CLA is required.

paulidale

Agreed a CLA is required.

This change addresses the issues in the pull request openssl#12460 by essentially removing duplicate lines, changed order of lines (actually away from a lexicographical order) and fixed one false positive. An ICLA is filed.

gustafn · 2020-07-17T09:35:18Z

Although i share the opinion of mspncp (how can the application of publicly accepted spelling rules create a copyright infringement claim?) i know as main contributor of a larger long-term projects with many contributors that e.g. license updates can be a pain in such project. So i have filed an ICLA via email to the requested address.

It is my understanding that

sooner or later you will have my email-address on file such that
a "CLA: trivial" or some other explicit reference to a "CLA" will be needed in the future.

All requested changes are addressed in the updated branch

t-j-h · 2020-07-17T09:37:16Z

Remove the CLA: trivial header and once your CLA is registered (I saw it come in) then you just close and open the case to trigger a recheck and it will be good to proceed. Thanks for taking that step quickly - the change and your CLA are very much appreciated.

gustafn · 2020-07-17T10:26:40Z

Remove the CLA: trivial header

In order change the previous commit message, i did a "git reset" in the feature branch to the change before my first commit, did a new commit without the "CLA: trivial" and a "git push -f". I hope, this is what was intended.

you just close and open the case to trigger a recheck.

Ok, i will close and reopen this pull request after some time (e.g. this evening).

This change applies the recommendation of the Linux Documentation Project to the documentation files of OpenSSL. Additionally, util/find-doc-nits was updated accordingly. The change follows a suggestion of mspncp on openssl#12370 and incoporates the requested changes on the pull request

slontis · 2020-07-18T01:13:26Z

In order change the previous commit message, i did a "git reset

FYI:
If you only need to fix the last commit like this you can just do

git commit --amend

It still requires the force push..

For multiple commits you can use

git rebase -i master

And then edit the commit line you need to change to use 'r' (reword)

mspncp · 2020-07-18T08:29:43Z

@gustafn it seems like your email address hasn’t been added to the database yet. Whoever does it will reopen your ticket to kick the CLA bot, so you need not worry about it.

mattcaswell · 2020-07-20T14:31:19Z

Close/reopen to kick CLA bot.

openssl-machine · 2020-07-22T00:00:14Z

This pull request is ready to merge

This change applies the recommendation of the Linux Documentation Project to the documentation files of OpenSSL. Additionally, util/find-doc-nits was updated accordingly. The change follows a suggestion of mspncp on #12370 and incoporates the requested changes on the pull request Reviewed-by: Shane Lontis <[email protected]> Reviewed-by: Matthias St. Pierre <[email protected]> (Merged from #12460)

mspncp · 2020-07-22T07:17:50Z

Merged to master in 490c871. Thank you @gustafn!

gustafn mentioned this pull request Jul 16, 2020

Fix typos and repeated words #12370

Closed

mspncp approved these changes Jul 16, 2020

View reviewed changes

mspncp added approval: review pending This pull request needs review by a committer branch: master Applies to master branch labels Jul 16, 2020

t-j-h added the hold: cla required The contributor needs to submit a license agreement label Jul 16, 2020

slontis reviewed Jul 17, 2020

View reviewed changes

slontis requested changes Jul 17, 2020

View reviewed changes

paulidale reviewed Jul 17, 2020

View reviewed changes

openssl-machine removed the hold: cla required The contributor needs to submit a license agreement label Jul 17, 2020

gustafn force-pushed the master-linux-doc-compatibility branch from 57b3023 to 763b1e2 Compare July 17, 2020 10:15

openssl-machine added the hold: cla required The contributor needs to submit a license agreement label Jul 17, 2020

gustafn force-pushed the master-linux-doc-compatibility branch from 763b1e2 to 09794ea Compare July 17, 2020 10:33

gustafn closed this Jul 17, 2020

gustafn reopened this Jul 17, 2020

gustafn closed this Jul 18, 2020

gustafn reopened this Jul 18, 2020

mattcaswell closed this Jul 20, 2020

mattcaswell reopened this Jul 20, 2020

openssl-machine removed the hold: cla required The contributor needs to submit a license agreement label Jul 20, 2020

slontis approved these changes Jul 20, 2020

View reviewed changes

slontis added approval: done This pull request has the required number of approvals and removed approval: review pending This pull request needs review by a committer labels Jul 20, 2020

openssl-machine removed the approval: done This pull request has the required number of approvals label Jul 22, 2020

openssl-machine added the approval: ready to merge The 24 hour grace period has passed, ready to merge label Jul 22, 2020

mspncp closed this Jul 22, 2020

gustafn deleted the master-linux-doc-compatibility branch July 23, 2020 12:26

gustafn mentioned this pull request Jul 24, 2020

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

Closed

1 task

Uh oh!

Comments

Conversation

gustafn commented Jul 16, 2020

Checklist

Uh oh!

mspncp left a comment

Choose a reason for hiding this comment

Uh oh!

t-j-h commented Jul 16, 2020

Uh oh!

mspncp commented Jul 16, 2020

Uh oh!

t-j-h commented Jul 16, 2020

Uh oh!

slontis Jul 17, 2020

Choose a reason for hiding this comment

Uh oh!

slontis Jul 17, 2020

Choose a reason for hiding this comment

Uh oh!

slontis Jul 17, 2020

Choose a reason for hiding this comment

Uh oh!

slontis Jul 17, 2020

Choose a reason for hiding this comment

Uh oh!

slontis left a comment

Choose a reason for hiding this comment

Uh oh!

paulidale left a comment

Choose a reason for hiding this comment

Uh oh!

gustafn commented Jul 17, 2020

Uh oh!

t-j-h commented Jul 17, 2020

Uh oh!

gustafn commented Jul 17, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

slontis commented Jul 18, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mspncp commented Jul 18, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mattcaswell commented Jul 20, 2020

Uh oh!

openssl-machine commented Jul 22, 2020

Uh oh!

mspncp commented Jul 22, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

gustafn commented Jul 17, 2020 •

edited

Loading

slontis commented Jul 18, 2020 •

edited

Loading

mspncp commented Jul 18, 2020 •

edited

Loading