search

LoupVaillant / Monocypher

An easy to use, easy to deploy crypto library
https://monocypher.org
Other
614 stars 80 forks source link

Add HISTORY sections #122

Closed fscoto closed 5 years ago

fscoto commented 5 years ago

These changes make it easier for people who read a newer manual than the one they have. This could happen if a long-term stability Linux distribution ends up packaging Monocypher and backporting security fixes, but developers are reading the manual on the web.

The wording of each first sentence matches OpenBSD's for section 3 HISTORY sections.

fscoto commented 5 years ago

One last nitpick: you mention when each function first appeared, even when that version is below 1.0.0. I thought we could maybe simplify things a bit and consider 1.0.0 like it was the beginning of time? This would leave us 2 obvious alternatives:

* Remove the history section for functions that appeared before (or at) version 1.0.0, and never changed since.

* Or Just mention that those function where "present from the beginning", or "appeared before version 1.0.0".

I think it would be slightly simpler, but I don't know the best practices. (Also, I don't have a strong opinion on the matter, just a slight instinctive preference).

The reason I went back to before 1.0 is because versions before 1.0 are listed on the downloads page. As long as those old versions are there in historical interest. I'm honestly quite undecided now that you brought it up, though I do have a slight preference for being honest and say “appeared before version 1..0.0” rather than removing history.

LoupVaillant commented 5 years ago

OK, let's keep an accurate history. I wasn't sure to begin with, so let's preserve the information for now.