Make default block_len a multiple of blake2 blocksize and tidy docs. #195
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ize. Note the md4sum blocksize is 64, so using 128 ensures it is an integer multiple of the strongsum blocksize for both kinds of strongsum. This makes calculating both blake2b and md4sum strongsums a tiny bit faster, since they don't need to add a padded tail block when finalizing the sum.
Add suggestion of strong_len=20 as a good compromize between safety against attacks and signature size. Add suggestion to use rs_sig_size() and argument defaults to rs_sig_file().
Change the titles and refer to the api's as "Streaming API", "Callback API" and "Whole-file API". Add instructions about using rs_sig_args() and rs_build_hash_table(). Remove instructions about setting job->sig_file_bytes to pre-allocate the signature because this is not publicly exposed... the rs_job_t structure is not public.
All other references use '\' as the doxygen escape, so be consistent.
This updates a heap of comments and removes some obsolete settings.
This means we use an updated doxygen to match the updated config.
This reverts commit 5cd40a7. This didn't help. The bionic version of doxygen has a bug and emits even more warnings that the xenial version.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Make the default blocksize a multiple of the 128 byte blake2b block size, which is 2x the md4sum blocksize of 64. This makes calculating both blake2b and md4sum strongsums a tiny bit faster.
Update docs and docstrings to include rs_sig_args() and rs_build_hash_table(). Update TODO and add a heading. Add exported file utils to docs. Remove instructions about setting job->sig_file_bytes to pre-allocate the signature because this is not publicly exposed. Update and tidy format.md for new magic types.
Update doc/Doxyfile.in with
doxygen -u.Update NEWS.md with all additions since v2.3.0 so far.