Skip to content

Commit 8773d4a

Browse files
committed
perlapi: Some elements are documented in INSTALL
This adds =for apidoc lines to INSTALL for use by autodoc.pl
1 parent cef3b6d commit 8773d4a

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

INSTALL

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -504,6 +504,10 @@ to be, with the one believed to be most secure at release time being PERL_HASH_F
504504
PERL_HASH_FUNC_SIPHASH13
505505
PERL_HASH_FUNC_ZAPHOD32
506506

507+
=for apidoc Amnh;||PERL_HASH_FUNC_SIPHASH
508+
=for apidoc_item ||PERL_HASH_FUNC_SIPHASH13
509+
=for apidoc_item ||PERL_HASH_FUNC_ZAPHOD32
510+
507511
In addition, these, (or custom hash functions), may be "fronted" by the
508512
SBOX32 hash function for keys under a chosen size. This hash function is
509513
special in that it has proven theoretical security properties, and is very
@@ -520,6 +524,8 @@ with something like this
520524

521525
-Accflags='-DPERL_HASH_USE_SBOX32_ALSO=0'
522526

527+
=for apidoc Amnh||PERL_HASH_USE_SBOX32_ALSO
528+
523529
or alternatively you can use the simple define C<PERL_HASH_NO_SBOX32> like this:
524530

525531
-Accflags='-DPERL_HASH_NO_SBOX32'
@@ -531,6 +537,8 @@ this:
531537

532538
-Accflags='-DSBOX_MAX_LEN=128'
533539

540+
=for apidoc Amn|U32|SBOX32_MAX_LEN
541+
534542
As of Perl 5.18 the order returned by keys(), values(), and each() is
535543
non-deterministic and distinct per hash, and the insert order for
536544
colliding keys is randomized as well, and perl allows for controlling this
@@ -549,6 +557,10 @@ or
549557

550558
-Accflags='-DPERL_PERTURB_KEYS_DETERMINISTIC'
551559

560+
=for apidoc Amnh;||PERL_PERTURB_KEYS_DETERMINISTIC
561+
=for apidoc_item ||PERL_PERTURB_KEYS_DISABLED
562+
=for apidoc_item ||PERL_PERTURB_KEYS_RANDOM
563+
552564
Since Perl 5.18 the seed used for the hash function is randomly selected
553565
at process start, which can be overridden by specifying a seed by setting
554566
the PERL_HASH_SEED environment variable. Be aware that
@@ -567,6 +579,8 @@ seed with the define C<NO_HASH_SEED> by providing to Configure
567579

568580
-Accflags='-DNO_HASH_SEED'
569581

582+
=for apidoc Amnh||NO_HASH_SEED
583+
570584
Note that if you do this you should modify the code in hv_func.h to specify
571585
your own key. In the future this define may be renamed and replaced with one
572586
that requires you to specify the key to use.
@@ -604,6 +618,8 @@ settings.
604618

605619
=item PERL_MAX_NESTED_EVAL_BEGIN_BLOCKS_DEFAULT
606620

621+
=for apidoc Amnh||PERL_MAX_NESTED_EVAL_BEGIN_BLOCKS_DEFAULT
622+
607623
This define is used to control the default maximum number of nested
608624
eval/BEGIN statements, and in this context require should be
609625
understood to be a special form of eval so this means require/BEGIN
@@ -911,6 +927,8 @@ installation, perhaps in a strange place:
911927

912928
=item APPLLIB_EXP
913929

930+
=for apidoc Amnh||APPLLIB_EXP
931+
914932
There is one other way of adding paths to @INC at perl build time, and
915933
that is by setting the APPLLIB_EXP C pre-processor token to a colon-
916934
separated list of directories, like this
@@ -1385,6 +1403,8 @@ default is set.
13851403

13861404
=item -DPERL_POLLUTE_MALLOC
13871405

1406+
=for apidoc Amnh||PERL_POLLUTE_MALLOC
1407+
13881408
NOTE: This flag is enabled automatically on some platforms if you just
13891409
run Configure to accept all the defaults.
13901410

@@ -1404,6 +1424,8 @@ versions.
14041424

14051425
=item -DPERL_DEBUGGING_MSTATS
14061426

1427+
=for apidoc Amnh||PERL_DEBUGGING_MSTATS
1428+
14071429
This flag enables debugging mstats, which is required to use the
14081430
Devel::Peek::mstat() function. You cannot enable this unless you are
14091431
using Perl's malloc, so a typical Configure command would be

0 commit comments

Comments
 (0)