Skip to content

Rename NOTES*, README*, VERSION, HACKING, LICENSE to .md or .txt#12109

Closed
DDvO wants to merge 3 commits intoopenssl:masterfrom
siemens:rename-NOTES-etc
Closed

Rename NOTES*, README*, VERSION, HACKING, LICENSE to .md or .txt#12109
DDvO wants to merge 3 commits intoopenssl:masterfrom
siemens:rename-NOTES-etc

Conversation

@DDvO
Copy link
Contributor

@DDvO DDvO commented Jun 10, 2020

This implements #12098 (comment).

For the files with names changed to .md, numerous small layout issues had to be solved because those files are now interpreted as MarkDown. It's likely that I missed some of them but at least all those files look reasonable now.

I also had to update various references to the renamed files - hope I caught all of them (I noticed and corrected some cases where similar references to other files renamed earlier had not been updated). Where it made most sense I converted them to proper (clickable) MarkDown-style references.

Copy link
Contributor

@richsalz richsalz left a comment

Choose a reason for hiding this comment

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

I got about 25% through this PR.

Did you run make md-nits on your machine before creating this PR?

@DDvO
Copy link
Contributor Author

DDvO commented Jun 11, 2020

I got about 25% through this PR.

Thanks @richsalz and @levitte for pointing out various mistakes;
I fixed all of them and some further minor issues I found in the course of doing that.

Did you run make md-nits on your machine before creating this PR?

Oh, never heard of that.
So I've installed mdl and I'm working through the findings now...

@levitte
Copy link
Member

levitte commented Jun 11, 2020

So I've installed mdl and I'm working through the findings now...

Please be careful what conclusions you draw. mdl is over-zealous on quite a lot of points (to the point of actually being wrong, or at least overly unflexible), until told otherwise in util/markdownlint.rb.

@DDvO DDvO force-pushed the rename-NOTES-etc branch from 6a837fc to 2740b57 Compare June 11, 2020 09:32
@DDvO
Copy link
Contributor Author

DDvO commented Jun 11, 2020

Please be careful what conclusions you draw. mdl is over-zealous on quite a lot of points (to the point of actually being wrong, or at least overly unflexible), until told otherwise in util/markdownlint.rb.

Good point. For this reason I've added three more rule exceptions,
in particular to allow bare URL. I see no point in re-writing, e.g.,

 directly at http://www.delorie.com/pub/djgpp. For help on which

to

 directly at [http://www.delorie.com/pub/djgpp](http://www.delorie.com/pub/djgpp).
 For help on which

as this just adds redundancy, wastes space,
and often adds the need for extra line breaks.

@DDvO
Copy link
Contributor Author

DDvO commented Jun 11, 2020

I'm done with all changes due to the reviews, and make md-nits is satisfied.

@richsalz
Copy link
Contributor

I didn't mean link references. Some markdown processors, when you would otherwise have [link-text](link-text) allow you to omit the parentheses part.

And while I'm here, just wanted to say that this is amazing work!

@DDvO DDvO force-pushed the rename-NOTES-etc branch from 49735af to a8f6b21 Compare June 13, 2020 13:33
@DDvO
Copy link
Contributor Author

DDvO commented Jun 13, 2020

I've just rebased this, fixing conflicts with the just merged #12098.
Anything more to do on this PR?

@DDvO DDvO force-pushed the rename-NOTES-etc branch from a8f6b21 to 6dd5bea Compare June 22, 2020 08:23
@DDvO
Copy link
Contributor Author

DDvO commented Jun 22, 2020

@levitte, since you reviewed this and in my view all requested changes are done,
can you approve this now?

@DDvO
Copy link
Contributor Author

DDvO commented Jun 22, 2020

Travis failures are unrelated.

@romen
Copy link
Member

romen commented Jun 24, 2020

Please be careful what conclusions you draw. mdl is over-zealous on quite a lot of points (to the point of actually being wrong, or at least overly unflexible), until told otherwise in util/markdownlint.rb.

Good point. For this reason I've added three more rule exceptions,
in particular to allow bare URL. I see no point in re-writing, e.g.,

 directly at http://www.delorie.com/pub/djgpp. For help on which

to

 directly at [http://www.delorie.com/pub/djgpp](http://www.delorie.com/pub/djgpp).
 For help on which

as this just adds redundancy, wastes space,
and often adds the need for extra line breaks.

The sane alternative to disabling the bare URL warning is to write urls within <>: <https://www.example.com/>

@romen romen added the branch: master Applies to master branch label Jun 24, 2020
Copy link
Member

@romen romen left a comment

Choose a reason for hiding this comment

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

A few comments below.

I also have read about 1/3 of the changes so far, and this looks great!

I would mention here (instead than repeating the same comment line by line) that [foo/bar.md] is equivalent to [foo/bar.md](foo/bar.md) and in many places we could prefer the implicit notation for readability and maintainability.

The other general note that I hope we will be able to address is that it seems git (well, the github ui at least, I haven't checked out this PR locally yet to examine more closely) seems to be losing track of some of the renames and instead treating them as o"old file was deleted, here is a new file". This is bad to track changes/blame in the documentation (which is often important in navigating how the project evolved and when features have been added, changed, deprecated, etc.).
IIRC our resident git guru @mspncp recently faced similar problems and of course he found a solution to provide git with enough hints that it was able to track file history/renames correctly. @mspncp can you guide us with your magic once more?

@DDvO DDvO force-pushed the rename-NOTES-etc branch from d313ee0 to 28e8ec1 Compare June 24, 2020 07:12
@DDvO
Copy link
Contributor Author

DDvO commented Jun 24, 2020

A few comments below.

Thanks @romen.

I also have read about 1/3 of the changes so far, and this looks great!

Pleased to hear!

I would mention here (instead than repeating the same comment line by line) that [foo/bar.md] is equivalent to [foo/bar.md](foo/bar.md) and in many places we could prefer the implicit notation for readability and maintainability.

This would be great, but sadly, as mentioned meanwhile in #12232 (comment), I found that this is not supported at least by Firefox and Chrome/Chromium.

The other general note that I hope we will be able to address is that it seems git (well, the github ui at least, I haven't checked out this PR locally yet to examine more closely) seems to be losing track of some of the renames and instead treating them as o"old file was deleted, here is a new file". This is bad to track changes/blame in the documentation (which is often important in navigating how the project evolved and when features have been added, changed, deprecated, etc.).
IIRC our resident git guru @mspncp recently faced similar problems and of course he found a solution to provide git with enough hints that it was able to track file history/renames correctly. @mspncp can you guide us with your magic once more?

I think that in this case git (and the GitHub pages) does the right thing already.
For instance, git log -p shows things like

diff --git a/NOTES.ANDROID b/NOTES-Android.md
similarity index 100%
rename from NOTES.ANDROID
rename to NOTES-Android.md

@DDvO DDvO mentioned this pull request Jun 24, 2020
@DDvO DDvO force-pushed the rename-NOTES-etc branch from ad0f375 to 70691b9 Compare June 29, 2020 17:14
@DDvO
Copy link
Contributor Author

DDvO commented Jun 29, 2020

While you're correct things, there's this at line 2934:

   configuration in one of the `Configurations/*.conf~ files (in

It should probably be:

   configuration in one of the `Configurations/*.conf` files (in

Oops, thanks, fixed.

Strange that mdl does not report such an imbalanced use of "`".

I just went though the rest of CHANGES.md and found many occurrences of "`xyz'"

and changed them to "xyz".

@DDvO DDvO force-pushed the rename-NOTES-etc branch from 70691b9 to b3d82b0 Compare June 29, 2020 17:19
@levitte
Copy link
Member

levitte commented Jun 29, 2020

Strange that mdl does not report such an imbalanced use of "`".

Not at all, you are allowed to have multiline inline code blocks

@DDvO DDvO force-pushed the rename-NOTES-etc branch from b3d82b0 to f404615 Compare June 29, 2020 17:22
@DDvO
Copy link
Contributor Author

DDvO commented Jun 29, 2020

Strange that mdl does not report such an imbalanced use of "`".

Not at all, you are allowed to have multiline inline code blocks

Yes, but I would expect that the number of backticks in a file should still be even.

However, there seems to be an implicit (redendering) rule that
the effect of a backtick stretches at most to the end of its paragraph.

@DDvO
Copy link
Contributor Author

DDvO commented Jun 29, 2020

Similarly, there's this line:

  * Make `openssl version' output lines consistent.

where the ' should be converted to a `

Done.

@DDvO DDvO force-pushed the rename-NOTES-etc branch 2 times, most recently from 6db55d1 to 5bd9a29 Compare July 2, 2020 10:19
@DDvO
Copy link
Contributor Author

DDvO commented Jul 2, 2020

Rebased this mostly for kicking Travis after it had timed out on two runs last time.

@DDvO DDvO force-pushed the rename-NOTES-etc branch from 5bd9a29 to 1ba8e30 Compare July 3, 2020 06:42
@DDvO
Copy link
Contributor Author

DDvO commented Jul 3, 2020

I had to handle merge conflicts again.
Can we please finalize this soon?

@t-j-h
Copy link
Member

t-j-h commented Jul 3, 2020

Hopefully @levitte can add his approval and we can get this in ... it is nice work!

@t-j-h t-j-h added approval: done This pull request has the required number of approvals and removed approval: otc review pending labels Jul 3, 2020
@DDvO
Copy link
Contributor Author

DDvO commented Jul 3, 2020

Hopefully @levitte can add his approval and we can get this in ... it is nice work!

Thanks @t-j-h!

@levitte (and also @richsalz and @romen) had already given various good comments, which I addressed,
and it appears to me he simply did not notice that or had no time to check on this.
In any case your approval will be sufficient.

@t-j-h
Copy link
Member

t-j-h commented Jul 3, 2020

Understood. The approval you require is there. I'm just hoping that @levitte can use the 24 hour delay before merge to also indicate his approval as well given you addressed all of his comments and he did a detailed review.

@openssl-machine
Copy link
Collaborator

24 hours has passed since 'approval: done' was set, but as this PR has been updated in that time the label 'approval: ready to merge' is not being automatically set. Please review the updates and set the label manually.

@DDvO DDvO force-pushed the rename-NOTES-etc branch from 1ba8e30 to 62e4c25 Compare July 5, 2020 09:32
openssl-machine pushed a commit that referenced this pull request Jul 5, 2020
exclude_rule 'MD023' # Headers must start at the beginning of the line
exclude_rule 'MD026' # Trailing punctuation in header

Reviewed-by: Tim Hudson <[email protected]>
(Merged from #12109)
openssl-machine pushed a commit that referenced this pull request Jul 5, 2020
openssl-machine pushed a commit that referenced this pull request Jul 5, 2020
@DDvO
Copy link
Contributor Author

DDvO commented Jul 5, 2020

Partly squashed, merged - thanks!

@DDvO DDvO closed this Jul 5, 2020
@levitte
Copy link
Member

levitte commented Jul 5, 2020

Well, it still seems weird to me that INSTALL.md contains quite thorough details about all aspects of configuration, building and installation, but that the testing details are thrown off to the side, so to say... I'm not sure I'll understand the purpose. But again, I seem to be a minority, so I'll accept this outcome.

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

Labels

approval: done This pull request has the required number of approvals branch: master Applies to master branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants