Skip to content

Add doc checking to helper.pl #135

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Feb 11, 2019
Merged

Add doc checking to helper.pl #135

merged 1 commit into from
Feb 11, 2019

Conversation

@karel-m
Copy link
Member

@karel-m karel-m commented Dec 8, 2018 •
edited
Loading

As suggested in another PR I have added a check whether all macros and functions from tommath.h are documented in doc/bn.tex.

Current status:

$ ./helper.pl -d
[missing_doc_for_function] mp_2expt
[missing_doc_for_function] mp_abs
[missing_doc_for_function] mp_addmod
[missing_doc_for_function] mp_clamp
[missing_doc_for_function] mp_cnt_lsb
[missing_doc_for_function] mp_complement
[missing_doc_for_function] mp_copy
[missing_doc_for_function] mp_count_bits
[missing_doc_for_function] mp_div_3
[missing_doc_for_function] mp_dr_is_modulus
[missing_doc_for_function] mp_exch
[missing_doc_for_function] mp_export
[missing_doc_for_function] mp_fread
[missing_doc_for_function] mp_fwrite
[missing_doc_for_function] mp_get_double
[missing_doc_for_function] mp_import
[missing_doc_for_function] mp_is_square
[missing_doc_for_function] mp_mod_2d
[missing_doc_for_function] mp_mulmod
[missing_doc_for_function] mp_n_root_ex
[missing_doc_for_function] mp_rand
[missing_doc_for_function] mp_read_signed_bin
[missing_doc_for_function] mp_reduce_2k_l
[missing_doc_for_function] mp_reduce_2k_setup_l
[missing_doc_for_function] mp_reduce_is_2k
[missing_doc_for_function] mp_reduce_is_2k_l
[missing_doc_for_function] mp_set_double
[missing_doc_for_function] mp_signed_bin_size
[missing_doc_for_function] mp_sqrmod
[missing_doc_for_function] mp_sqrt
[missing_doc_for_function] mp_submod
[missing_doc_for_function] mp_tc_and
[missing_doc_for_function] mp_tc_div_2d
[missing_doc_for_function] mp_tc_or
[missing_doc_for_function] mp_tc_xor
[missing_doc_for_function] mp_to_signed_bin
[missing_doc_for_function] mp_to_signed_bin_n
[missing_doc_for_function] mp_to_unsigned_bin_n
[missing_doc_for_function] mp_toradix_n
[missing_doc_for_function] mp_zero
[missing_doc_for_macro] mp_iseven
[missing_doc_for_macro] mp_isneg
[missing_doc_for_macro] mp_isodd
[missing_doc_for_macro] mp_iszero
[missing_doc_for_macro] mp_mag_size
[missing_doc_for_macro] mp_raw_size
[missing_doc_for_macro] mp_read_mag
[missing_doc_for_macro] mp_read_raw
[missing_doc_for_macro] mp_tobinary
[missing_doc_for_macro] mp_todecimal
[missing_doc_for_macro] mp_tohex
[missing_doc_for_macro] mp_tomag
[missing_doc_for_macro] mp_tooctal
[missing_doc_for_macro] mp_toraw
check_doc:       FAIL 54

@sjaeckel
Copy link
Member

sjaeckel commented Dec 9, 2018

damn, that's more work than I expected :-D

@karel-m karel-m force-pushed the pr/helper-pl-doc-check branch from 3351dd9 to 7b0508e Compare December 9, 2018 22:20
@czurnieden czurnieden mentioned this pull request Dec 9, 2018
Merged
@czurnieden
Copy link
Contributor

czurnieden commented Dec 9, 2018

damn, that's more work than I expected :-D

No, it isn't, @sjaeckel ;-)

Thought I did everything correct, but I didn't. Obviously. As expected ;-)
So if someone want's to plug it out of #136 : you're welcome.

Not all the findings were implemented, some of them are more or less internal (private) functions, I think. Add them nevertheless?

@karel-m karel-m force-pushed the pr/helper-pl-doc-check branch from 7b0508e to 57b7863 Compare December 25, 2018 17:09
@karel-m
Copy link
Member Author

karel-m commented Dec 25, 2018

After rebasing on current develop

$ ./helper.pl -d
[missing_doc_for_function] mp_complement
[missing_doc_for_function] mp_dr_is_modulus
[missing_doc_for_function] mp_get_double
[missing_doc_for_function] mp_mod_2d
[missing_doc_for_function] mp_mulmod
[missing_doc_for_function] mp_n_root_ex
[missing_doc_for_function] mp_reduce_2k_l
[missing_doc_for_function] mp_reduce_2k_setup_l
[missing_doc_for_function] mp_reduce_is_2k
[missing_doc_for_function] mp_reduce_is_2k_l
[missing_doc_for_function] mp_set_double
[missing_doc_for_function] mp_sqrmod
[missing_doc_for_function] mp_submod
[missing_doc_for_function] mp_to_signed_bin_n
check_doc:       FAIL 14

@sjaeckel
Copy link
Member

sjaeckel commented Dec 25, 2018

That's why I'd leave this PR until after the release ;-)

@sjaeckel sjaeckel added this to the next milestone Dec 26, 2018
@minad minad self-requested a review February 10, 2019 22:40
minad
minad approved these changes Feb 10, 2019
View reviewed changes
Copy link
Member

@minad minad left a comment

Choose a reason for hiding this comment

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

Good idea and obviously much needed to keep docs in sync!

@karel-m karel-m force-pushed the pr/helper-pl-doc-check branch from 57b7863 to d224791 Compare February 11, 2019 13:12
@minad
Copy link
Member

minad commented Feb 11, 2019

@karel-m Is this ready to merge?

sjaeckel
sjaeckel approved these changes Feb 11, 2019
View reviewed changes
Copy link
Member

@sjaeckel sjaeckel left a comment

Choose a reason for hiding this comment

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

IMO ready to merge after another rebase on top of develop

@karel-m karel-m force-pushed the pr/helper-pl-doc-check branch from d224791 to 667ce28 Compare February 11, 2019 14:45
@karel-m
Copy link
Member Author

karel-m commented Feb 11, 2019

After rebasing there are still these issues:

$ ./helper.pl -d
[missing_doc_for_function] mp_complement
[missing_doc_for_function] mp_dr_is_modulus
[missing_doc_for_function] mp_get_double
[missing_doc_for_function] mp_mulmod
[missing_doc_for_function] mp_n_root_ex
[missing_doc_for_function] mp_reduce_2k_l
[missing_doc_for_function] mp_reduce_2k_setup_l
[missing_doc_for_function] mp_reduce_is_2k
[missing_doc_for_function] mp_reduce_is_2k_l
[missing_doc_for_function] mp_set_double
[missing_doc_for_function] mp_sqrmod
[missing_doc_for_function] mp_submod
[missing_doc_for_function] mp_to_signed_bin_n
check_doc:       FAIL 13

@sjaeckel
Copy link
Member

sjaeckel commented Feb 11, 2019 •
edited
Loading

After rebasing there are still these issues:

We should open another PR which adds a travis target to always run this check where those errors must then be fixed

@sjaeckel sjaeckel merged commit 6e760c2 into develop Feb 11, 2019
@sjaeckel sjaeckel deleted the pr/helper-pl-doc-check branch February 11, 2019 14:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@minad minad minad approved these changes

@sjaeckel sjaeckel sjaeckel approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

v1.2.0

Development

Successfully merging this pull request may close these issues.

5 participants

@karel-m @sjaeckel @czurnieden @minad