Skip to content

Commit 0d41ded

Browse files
committed
perlapi: Some elements are documented in INSTALL
This adds =for apidoc lines to INSTALL for use by autodoc.pl
1 parent 071db1b commit 0d41ded

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
@@ -510,6 +510,10 @@ to be, with the one believed to be most secure at release time being PERL_HASH_F
510510
PERL_HASH_FUNC_SIPHASH13
511511
PERL_HASH_FUNC_ZAPHOD32
512512

513+
=for apidoc Amnh;||PERL_HASH_FUNC_SIPHASH
514+
=for apidoc_item ||PERL_HASH_FUNC_SIPHASH13
515+
=for apidoc_item ||PERL_HASH_FUNC_ZAPHOD32
516+
513517
In addition, these, (or custom hash functions), may be "fronted" by the
514518
SBOX32 hash function for keys under a chosen size. This hash function is
515519
special in that it has proven theoretical security properties, and is very
@@ -526,6 +530,8 @@ with something like this
526530

527531
-Accflags='-DPERL_HASH_USE_SBOX32_ALSO=0'
528532

533+
=for apidoc Amnh||PERL_HASH_USE_SBOX32_ALSO
534+
529535
or alternatively you can use the simple define C<PERL_HASH_NO_SBOX32> like this:
530536

531537
-Accflags='-DPERL_HASH_NO_SBOX32'
@@ -537,6 +543,8 @@ this:
537543

538544
-Accflags='-DSBOX_MAX_LEN=128'
539545

546+
=for apidoc Amn|U32|SBOX32_MAX_LEN
547+
540548
As of Perl 5.18 the order returned by keys(), values(), and each() is
541549
non-deterministic and distinct per hash, and the insert order for
542550
colliding keys is randomized as well, and perl allows for controlling this
@@ -555,6 +563,10 @@ or
555563

556564
-Accflags='-DPERL_PERTURB_KEYS_DETERMINISTIC'
557565

566+
=for apidoc Amnh;||PERL_PERTURB_KEYS_DETERMINISTIC
567+
=for apidoc_item ||PERL_PERTURB_KEYS_DISABLED
568+
=for apidoc_item ||PERL_PERTURB_KEYS_RANDOM
569+
558570
Since Perl 5.18 the seed used for the hash function is randomly selected
559571
at process start, which can be overridden by specifying a seed by setting
560572
the PERL_HASH_SEED environment variable. Be aware that
@@ -573,6 +585,8 @@ seed with the define C<NO_HASH_SEED> by providing to Configure
573585

574586
-Accflags='-DNO_HASH_SEED'
575587

588+
=for apidoc Amnh||NO_HASH_SEED
589+
576590
Note that if you do this you should modify the code in hv_func.h to specify
577591
your own key. In the future this define may be renamed and replaced with one
578592
that requires you to specify the key to use.
@@ -610,6 +624,8 @@ settings.
610624

611625
=item PERL_MAX_NESTED_EVAL_BEGIN_BLOCKS_DEFAULT
612626

627+
=for apidoc Amnh||PERL_MAX_NESTED_EVAL_BEGIN_BLOCKS_DEFAULT
628+
613629
This define is used to control the default maximum number of nested
614630
eval/BEGIN statements, and in this context require should be
615631
understood to be a special form of eval so this means require/BEGIN
@@ -917,6 +933,8 @@ installation, perhaps in a strange place:
917933

918934
=item APPLLIB_EXP
919935

936+
=for apidoc Amnh||APPLLIB_EXP
937+
920938
There is one other way of adding paths to @INC at perl build time, and
921939
that is by setting the APPLLIB_EXP C pre-processor token to a colon-
922940
separated list of directories, like this
@@ -1391,6 +1409,8 @@ default is set.
13911409

13921410
=item -DPERL_POLLUTE_MALLOC
13931411

1412+
=for apidoc Amnh||PERL_POLLUTE_MALLOC
1413+
13941414
NOTE: This flag is enabled automatically on some platforms if you just
13951415
run Configure to accept all the defaults.
13961416

@@ -1410,6 +1430,8 @@ versions.
14101430

14111431
=item -DPERL_DEBUGGING_MSTATS
14121432

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

0 commit comments

Comments
 (0)