New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Feature/doc (only crypt.tex + changes) #54
Conversation
In crypt.tex (add SHA512/t documentation) it says: "The other hashes such as the SHA-1, SHA-2 (that includes SHA-512, SHA-512/384, SHA-384, SHA-512/256, SHA-256 and SHA-224) and TIGER-192 are still considered secure for all purposes you would normally use a hash for." IMO SHA-1 should be removed from this list. According to NIST, SHA-1 is being depreciated and in some cases even disallowed. See http://csrc.nist.gov/publications/nistpubs/800-57/sp800-57_part1_rev3_general.pdf, Table 4, page 67. For the EU's position see http://www.ecrypt.eu.org/documents/D.SPA.20.pdf, Section 10.2, page 50. Other sources corroborate. |
Re: update changes document Consider changing "the necessary stuff to easier include libtomcrypt in a foreign language like python" to "the necessary stuff to more easily call libtomcrypt from a dynamic language like Python". ...although I do appreciate the humor. ;-) |
Although I have not went through the changes in @sjaeckel if you are not quite happy with the doc update in this PR I vote at least for cherry-picking the changes to all other files except |
I think it'd be fine to pick all changes besides My original plan was to merge this branch right before tagging the first RC. |
part of feature/doc changes from #54
a0cf14d
to
b7a4a2f
Compare
As agreed, now in this PR only crypt.tex + changes the rest is merged into develop. |
b7a4a2f
to
1bb7c43
Compare
Changes Unknown when pulling 1bb7c43 on feature/doc into ** on develop**. |
Changes Unknown when pulling 8516777 on feature/doc into ** on develop**. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The changes (doc additions) here are IMO OK. Except that there are still some undocumented areas.
I propose merging this PR to develop + creating a new issue (not PR) like "Polish documentation" with a checklist like the one in the main post of this PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
\begin{figure}[h]
puts it "approximately here". a couple of the figures (ECC Key Strength and Built--In Software Hashes, specifically) are moved out of place.
\begin{figure}[H]
(requires \usepackage{float}
) puts them in the right place. I also tried [h!]
and [ht!]
but [H]
was the only way to keep the ECC Key Strength in the correct location.
include changes proposed by @buggywhip fix typos [skip ci]
@buggywhip is right [skip ci]
Change-Id: I2830ea3c04fd0410cc12137be41e6c511c4a47fe
* remove crypt.pdf from repo * ignore generated PDF's * make refman.pdf generation silent
we'll address that in #197 |
How are people supposed to read the documentation if you've removed |
Also, looking at the last release (https://github.com/libtom/libtomcrypt/blob/b234e6b4cafba8f8cd08036f0d34661f5f700b64/doc/crypt.pdf), is there no documentation for LibTomMath / TomsFastMath? EDIT: Never mind, found it: http://www.gtoal.com/src/mobi/clit18/libtommath-0.41/bn.pdf |
@stuartpb please download the tarballs of the latest release, not development snapshot, there's the pdf included. See www.libtom.net for direct links. This also applies to ltm and tfm. As they are separate libraries they have their own documentation. EDIT: Please use the appropriate documentation to the version you're using, not some ancient pdf you found in the tubes. |
No description provided.