[Gmp-commit] /var/hg/www: Add documentation lines.

mercurial at gmplib.org mercurial at gmplib.org
Thu Feb 28 15:44:33 CET 2013


details:   /var/hg/www/rev/b9790110f24f
changeset: 38:b9790110f24f
user:      Torbjorn Granlund <tege at gmplib.org>
date:      Thu Feb 28 15:44:29 2013 +0100
description:
Add documentation lines.

diffstat:

 devel/gmp-func-list.txt |  271 ++++++++++++++++++++++++-----------------------
 1 files changed, 140 insertions(+), 131 deletions(-)

diffs (truncated from 434 to 300 lines):

diff -r 399598ff13fa -r b9790110f24f devel/gmp-func-list.txt
--- a/devel/gmp-func-list.txt	Thu Feb 28 15:23:36 2013 +0100
+++ b/devel/gmp-func-list.txt	Thu Feb 28 15:44:29 2013 +0100
@@ -1,71 +1,80 @@
-__gmp_0                                           priv
+# The first entry is a global-scope GMP name.
+# At column 40 "doc" means name is mentioned in gmp.texi
+# At column 44 "decl" means name is mentioned in gmp.h
+# At column 50 there is a suggestion, "PRIV", "ALLOW", "PUB"
+# PRIV = hide completely (visibility hidden)
+# ALLOW = Allow naughty users to call, keep undocumented
+# PUB = document, put in gmp.h
+# Caution: there are surely errors here with doc and decl,
+# since they were made with a mindless script.
+__gmp_0                                           PRIV
 __gmp_allocate_func                             
 __gmp_asprintf                          doc decl
-__gmp_asprintf_final                              priv
-__gmp_asprintf_funs                               priv
-__gmp_asprintf_memory                             priv
-__gmp_asprintf_reps                               priv
-__gmp_assert_fail                                 priv
-__gmp_assert_header                               priv
-__gmp_binvert_limb_table                          priv
+__gmp_asprintf_final                              PRIV
+__gmp_asprintf_funs                               PRIV
+__gmp_asprintf_memory                             PRIV
+__gmp_asprintf_reps                               PRIV
+__gmp_assert_fail                                 PRIV
+__gmp_assert_header                               PRIV
+__gmp_binvert_limb_table                          PRIV
 __gmp_bits_per_limb                     doc decl
 __gmp_default_allocate                          
 __gmp_default_fp_limb_precision                 
 __gmp_default_free                              
 __gmp_default_reallocate                        
-__gmp_digit_value_tab                             priv
-__gmp_divide_by_zero                              priv
-__gmp_doprnt                                      priv
-__gmp_doprnt_integer                              priv
-__gmp_doprnt_mpf2                                 priv
-__gmp_doscan                                      priv
+__gmp_digit_value_tab                             PRIV
+__gmp_divide_by_zero                              PRIV
+__gmp_doprnt                                      PRIV
+__gmp_doprnt_integer                              PRIV
+__gmp_doprnt_mpf2                                 PRIV
+__gmp_doscan                                      PRIV
 __gmp_errno                             doc decl
-__gmp_exception                                   priv
-__gmp_extract_double                              priv
-__gmp_fac2cnt_table                               priv
-__gmp_fib_table                                   priv
+__gmp_exception                                   PRIV
+__gmp_extract_double                              PRIV
+__gmp_fac2cnt_table                               PRIV
+__gmp_fib_table                                   PRIV
 __gmp_fprintf                           doc decl
-__gmp_fprintf_funs                                priv
+__gmp_fprintf_funs                                PRIV
 __gmp_free_func                                 
 __gmp_fscanf                            doc decl
-__gmp_fscanf_funs                                 priv
+__gmp_fscanf_funs                                 PRIV
 __gmp_get_memory_functions              doc decl
 __gmp_init_primesieve                           
-__gmp_invalid_operation                           priv
-__gmp_jacobi_table                                priv
-__gmp_junk                                        priv
-__gmp_limbroots_table                             priv
-__gmp_mt_recalc_buffer                            priv
+__gmp_invalid_operation                           PRIV
+__gmp_jacobi_table                                PRIV
+__gmp_junk                                        PRIV
+__gmp_limbroots_table                             PRIV
+__gmp_mt_recalc_buffer                            PRIV
 __gmp_nextprime                                 
-__gmp_odd2fac_table                               priv
-__gmp_oddfac_table                                priv
+__gmp_odd2fac_table                               PRIV
+__gmp_oddfac_table                                PRIV
 __gmp_primesieve                                
 __gmp_printf                            doc decl
 __gmp_randclear                         doc decl
-__gmp_randclear_mt                                priv
-__gmp_randget_mt                                  priv
+__gmp_randclear_mt                                PRIV
+__gmp_randget_mt                                  PRIV
 __gmp_randinit                          doc decl
 __gmp_randinit_default                  doc decl
 __gmp_randinit_lc_2exp                  doc decl
 __gmp_randinit_lc_2exp_size             doc decl
 __gmp_randinit_mt                       doc decl
-__gmp_randinit_mt_noseed                          priv
+__gmp_randinit_mt_noseed                          PRIV
 __gmp_randinit_set                      doc decl
-__gmp_randiset_mt                                 priv
-__gmp_rands                                       priv
-__gmp_rands_initialized                           priv
+__gmp_randiset_mt                                 PRIV
+__gmp_rands                                       PRIV
+__gmp_rands_initialized                           PRIV
 __gmp_randseed                          doc decl
 __gmp_randseed_ui                       doc decl
 __gmp_reallocate_func                           
 __gmp_scanf                             doc decl
 __gmp_set_memory_functions              doc decl
 __gmp_snprintf                          doc decl
-__gmp_snprintf_funs                               priv
+__gmp_snprintf_funs                               PRIV
 __gmp_sprintf                           doc decl
-__gmp_sprintf_funs                                priv
-__gmp_sqrt_of_negative                            priv
+__gmp_sprintf_funs                                PRIV
+__gmp_sqrt_of_negative                            PRIV
 __gmp_sscanf                            doc decl
-__gmp_sscanf_funs                                 priv
+__gmp_sscanf_funs                                 PRIV
 __gmp_tmp_reentrant_alloc                       
 __gmp_tmp_reentrant_free                        
 __gmp_urandomb_ui                       doc decl
@@ -92,7 +101,7 @@
 __gmpf_div                              doc decl
 __gmpf_div_2exp                         doc decl
 __gmpf_div_ui                           doc decl
-__gmpf_dump                                 decl
+__gmpf_dump                                 decl  PUB
 __gmpf_eq                               doc decl
 __gmpf_fits_sint_p                      doc decl
 __gmpf_fits_slong_p                     doc decl
@@ -148,24 +157,24 @@
 __gmpf_urandomb                         doc decl
 __gmpn_add                              doc decl
 __gmpn_add_1                            doc decl
-__gmpn_add_err1_n                                 priv
-__gmpn_add_err2_n                                 priv
-__gmpn_add_err3_n                                 priv
+__gmpn_add_err1_n                                 PRIV
+__gmpn_add_err2_n                                 PRIV
+__gmpn_add_err3_n                                 PRIV
 __gmpn_add_n                            doc decl
 __gmpn_add_n_sub_n                              
-__gmpn_add_nc                                     priv
-__gmpn_addaddmul_1msb0                            priv
-__gmpn_addcnd_n                                   pub
-__gmpn_addlsh1_n                                  priv
-__gmpn_addlsh2_n                                  priv
-__gmpn_addlsh_n                                   priv
+__gmpn_add_nc                                     PRIV
+__gmpn_addaddmul_1msb0                            PRIV
+__gmpn_addcnd_n                                   ALLOW
+__gmpn_addlsh1_n                                  PRIV
+__gmpn_addlsh2_n                                  PRIV
+__gmpn_addlsh_n                                   PRIV
 __gmpn_addmul_1                         doc decl
-__gmpn_addmul_2                                   priv
+__gmpn_addmul_2                                   PRIV
 __gmpn_and_n                            doc decl
 __gmpn_andn_n                           doc decl
-__gmpn_bases                                      priv
+__gmpn_bases                                      PRIV
 __gmpn_bc_mulmod_bnm1                           
-__gmpn_bc_set_str                                 priv
+__gmpn_bc_set_str                                 PRIV
 __gmpn_bdiv_dbm1c                               
 __gmpn_bdiv_q                                   
 __gmpn_bdiv_q_1                                 
@@ -183,7 +192,7 @@
 __gmpn_com                              doc decl
 __gmpn_copyd                            doc decl
 __gmpn_copyi                            doc decl
-__gmpn_dc_set_str                                 priv
+__gmpn_dc_set_str                                 PRIV
 __gmpn_dcpi1_bdiv_q                             
 __gmpn_dcpi1_bdiv_q_n                           
 __gmpn_dcpi1_bdiv_q_n_itch                      
@@ -208,17 +217,17 @@
 __gmpn_divrem                           doc decl
 __gmpn_divrem_1                         doc decl
 __gmpn_divrem_2                             decl
-__gmpn_dump                                     
-__gmpn_fft_best_k                                 priv
-__gmpn_fft_next_size                              priv
+__gmpn_dump                                       PUB
+__gmpn_fft_best_k                                 PRIV
+__gmpn_fft_next_size                              PRIV
 __gmpn_fib2_ui                                  
 __gmpn_gcd                              doc decl
 __gmpn_gcd_1                            doc decl
-__gmpn_gcd_subdiv_step                            priv
+__gmpn_gcd_subdiv_step                            PRIV
 __gmpn_gcdext                           doc decl
 __gmpn_gcdext_1                             decl
-__gmpn_gcdext_hook                                priv
-__gmpn_gcdext_lehmer_n                            priv
+__gmpn_gcdext_hook                                PRIV
+__gmpn_gcdext_lehmer_n                            PRIV
 __gmpn_get_d                                    
 __gmpn_get_str                          doc decl
 __gmpn_hamdist                          doc decl
@@ -229,18 +238,18 @@
 __gmpn_hgcd_appr_itch                           
 __gmpn_hgcd_itch                                
 __gmpn_hgcd_jacobi                              
-__gmpn_hgcd_matrix_adjust                         priv
-__gmpn_hgcd_matrix_init                           priv
-__gmpn_hgcd_matrix_mul                            priv
-__gmpn_hgcd_matrix_mul_1                          priv
-__gmpn_hgcd_matrix_update_q                       priv
-__gmpn_hgcd_mul_matrix1_vector                    priv
+__gmpn_hgcd_matrix_adjust                         PRIV
+__gmpn_hgcd_matrix_init                           PRIV
+__gmpn_hgcd_matrix_mul                            PRIV
+__gmpn_hgcd_matrix_mul_1                          PRIV
+__gmpn_hgcd_matrix_update_q                       PRIV
+__gmpn_hgcd_mul_matrix1_vector                    PRIV
 __gmpn_hgcd_reduce                              
 __gmpn_hgcd_reduce_itch                         
 __gmpn_hgcd_step                                
 __gmpn_invert                                   
 __gmpn_invert_limb                              
-__gmpn_invert_limb_table                          priv
+__gmpn_invert_limb_table                          PRIV
 __gmpn_invertappr                               
 __gmpn_ior_n                            doc decl
 __gmpn_iorn_n                           doc decl
@@ -249,10 +258,10 @@
 __gmpn_jacobi_n                                 
 __gmpn_lshift                           doc decl
 __gmpn_lshiftc                                  
-__gmpn_matrix22_mul                               priv
-__gmpn_matrix22_mul1_inverse_vector               priv
-__gmpn_matrix22_mul_itch                          priv
-__gmpn_matrix22_mul_strassen                      priv
+__gmpn_matrix22_mul                               PRIV
+__gmpn_matrix22_mul1_inverse_vector               PRIV
+__gmpn_matrix22_mul_itch                          PRIV
+__gmpn_matrix22_mul_strassen                      PRIV
 __gmpn_mod_1                            doc decl
 __gmpn_mod_1_1p                                 
 __gmpn_mod_1_1p_cps                             
@@ -272,15 +281,15 @@
 __gmpn_mu_div_q                                 
 __gmpn_mu_div_q_itch                            
 __gmpn_mu_div_qr                                
-__gmpn_mu_div_qr_choose_in                        priv
+__gmpn_mu_div_qr_choose_in                        PRIV
 __gmpn_mu_div_qr_itch                           
 __gmpn_mu_divappr_q                             
-__gmpn_mu_divappr_q_choose_in                     priv
+__gmpn_mu_divappr_q_choose_in                     PRIV
 __gmpn_mu_divappr_q_itch                        
 __gmpn_mul                              doc decl
 __gmpn_mul_1                            doc decl
-__gmpn_mul_1c                                     priv
-__gmpn_mul_2                                      priv
+__gmpn_mul_1c                                     PRIV
+__gmpn_mul_2                                      PRIV
 __gmpn_mul_basecase                             
 __gmpn_mul_fft                                  
 __gmpn_mul_n                            doc decl
@@ -290,12 +299,12 @@
 __gmpn_mulmid_basecase                          
 __gmpn_mulmid_n                                 
 __gmpn_mulmod_bnm1                              
-__gmpn_mulmod_bnm1_next_size                      priv
+__gmpn_mulmod_bnm1_next_size                      PRIV
 __gmpn_nand_n                           doc decl
 __gmpn_neg                              doc decl
-__gmpn_ni_invertappr                              priv
+__gmpn_ni_invertappr                              PRIV
 __gmpn_nior_n                           doc decl
-__gmpn_nussbaumer_mul                             priv
+__gmpn_nussbaumer_mul                             PRIV
 __gmpn_perfect_power_p                      decl
 __gmpn_perfect_square_p                 doc decl
 __gmpn_pi1_bdiv_q_1                             
@@ -312,18 +321,18 @@
 __gmpn_preinv_mu_divappr_q                      
 __gmpn_random                           doc decl
 __gmpn_random2                          doc decl
-__gmpn_redc_1                                     pub
-__gmpn_redc_2                                     pub
-__gmpn_redc_n                                     pub
+__gmpn_redc_1                                     ALLOW
+__gmpn_redc_2                                     ALLOW
+__gmpn_redc_n                                     ALLOW
 __gmpn_remove                                   
-__gmpn_rootrem                                    pub
-__gmpn_rsblsh1_n                                  priv
-__gmpn_rsblsh2_n                                  priv
-__gmpn_rsblsh_n                                   priv
-__gmpn_rsh1add_n                                  priv
-__gmpn_rsh1add_nc                                 priv
-__gmpn_rsh1sub_n                                  priv
-__gmpn_rsh1sub_nc                                 priv
+__gmpn_rootrem                                    ALLOW
+__gmpn_rsblsh1_n                                  PRIV
+__gmpn_rsblsh2_n                                  PRIV
+__gmpn_rsblsh_n                                   PRIV


More information about the gmp-commit mailing list