Rename NOTES*, README*, VERSION, HACKING, LICENSE to .md or .txt#12109
Rename NOTES*, README*, VERSION, HACKING, LICENSE to .md or .txt#12109DDvO wants to merge 3 commits intoopenssl:masterfrom
Conversation
richsalz
left a comment
There was a problem hiding this comment.
I got about 25% through this PR.
Did you run make md-nits on your machine before creating this PR?
Thanks @richsalz and @levitte for pointing out various mistakes;
Oh, never heard of that. |
Please be careful what conclusions you draw. |
Good point. For this reason I've added three more rule exceptions, to as this just adds redundancy, wastes space, |
|
I'm done with all changes due to the reviews, and |
|
I didn't mean link references. Some markdown processors, when you would otherwise have And while I'm here, just wanted to say that this is amazing work! |
|
I've just rebased this, fixing conflicts with the just merged #12098. |
|
@levitte, since you reviewed this and in my view all requested changes are done, |
|
Travis failures are unrelated. |
The sane alternative to disabling the bare URL warning is to write urls within |
romen
left a comment
There was a problem hiding this comment.
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?
Thanks @romen.
Pleased to hear!
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.
I think that in this case |
Oops, thanks, fixed. Strange that I just went though the rest of and changed them to " |
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 |
Done. |
6db55d1 to
5bd9a29
Compare
|
Rebased this mostly for kicking Travis after it had timed out on two runs last time. |
|
I had to handle merge conflicts again. |
|
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, |
|
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. |
|
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. |
exclude_rule 'MD023' # Headers must start at the beginning of the line exclude_rule 'MD026' # Trailing punctuation in header
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)
Reviewed-by: Tim Hudson <[email protected]> (Merged from #12109)
Reviewed-by: Tim Hudson <[email protected]> (Merged from #12109)
|
Partly squashed, merged - thanks! |
|
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. |
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.