Refactor test code to remove duplication is a TODO.
[p5sagit/p5-mst-13.2.git] / Porting / Glossary
index 488f28f..f267d40 100644 (file)
@@ -112,13 +112,13 @@ archlibexp (archlib.U):
        This variable is the same as the archlib variable, but is
        filename expanded at configuration time, for convenient use.
 
-archname64 (use64bits.U):
-       This variable is used for the 64-bitness part of $archname.
-
 archname (archname.U):
        This variable is a short name to characterize the current
        architecture.  It is used mainly to construct the default archlib.
 
+archname64 (use64bits.U):
+       This variable is used for the 64-bitness part of $archname.
+
 archobjs (Unix.U):
        This variable defines any additional objects that must be linked
        in with the program on this architecture.  On unix, it is usually
@@ -244,10 +244,6 @@ cf_time (cf_who.U):
        Holds the output of the "date" command when the configuration file was
        produced. This is used to tag both config.sh and config_h.SH.
 
-charsize (charsize.U):
-       This variable contains the value of the CHARSIZE symbol, which
-       indicates to the C program how many bytes there are in a character.
-
 chgrp (Loc.U):
        This variable is defined but not used by Configure.
        The value is a plain '' and is not useful.
@@ -406,38 +402,38 @@ d_atoll (atoll.U):
        This variable conditionally defines the HAS_ATOLL symbol, which
        indicates to the C program that the atoll() routine is available.
 
-d_attribute_format (d_attribut_format.U):
+d_attribute_format (d_attribut.U):
        This variable conditionally defines HASATTRIBUTE_FORMAT, which
        indicates the C compiler can check for printf-like formats.
 
-d_attribute_malloc (d_attribute_malloc.U):
+d_attribute_malloc (d_attribut.U):
        This variable conditionally defines HASATTRIBUTE_MALLOC, which
        indicates the C compiler can understand functions as having
        malloc-like semantics.
 
-d_attribute_nonnull (d_attribute_nonnull.U):
+d_attribute_nonnull (d_attribut.U):
        This variable conditionally defines HASATTRIBUTE_NONNULL, which
        indicates that the C compiler can know that certain arguments
        must not be NULL, and will check accordingly at compile time.
 
-d_attribute_noreturn (d_attribute_noreturn.U):
+d_attribute_noreturn (d_attribut.U):
        This variable conditionally defines HASATTRIBUTE_NORETURN, which
        indicates that the C compiler can know that certain functions
        are guaranteed never to return.
 
-d_attribute_pure (d_attribute_pure.U):
+d_attribute_pure (d_attribut.U):
        This variable conditionally defines HASATTRIBUTE_PURE, which
        indicates that the C compiler can know that certain functions
        are "pure" functions, meaning that they have no side effects, and
        only rely on function input and/or global data for their results.
 
-d_attribute_unused (d_attribute_unused.U):
+d_attribute_unused (d_attribut.U):
        This variable conditionally defines HASATTRIBUTE_UNUSED, which
        indicates that the C compiler can know that certain variables
        and arguments may not always be used, and to not throw warnings
        if they don't get used.
 
-d_attribute_warn_unused_result (d_attribute_warn_unused_result.U):
+d_attribute_warn_unused_result (d_attribut.U):
        This variable conditionally defines
        HASATTRIBUTE_WARN_UNUSED_RESULT, which indicates that the C
        compiler can know that certain functions have a return values
@@ -482,6 +478,11 @@ d_bzero (d_bzero.U):
        This variable conditionally defines the HAS_BZERO symbol if
        the bzero() routine is available to set memory to 0.
 
+d_c99_variadic_macros (d_c99_variadic.U):
+       This variable conditionally defines the HAS_C99_VARIADIC_MACROS
+       symbol, which indicates to the C program that C99 variadic macros
+       are available.
+
 d_casti32 (d_casti32.U):
        This variable conditionally defines CASTI32, which indicates
        whether the C compiler can cast large floats to 32-bit ints.
@@ -534,6 +535,11 @@ d_copysignl (d_copysignl.U):
        indicates to the C program that the copysignl() routine is available.
        If aintl is also present we can emulate modfl.
 
+d_cplusplus (d_cplusplus.U):
+       This variable conditionally defines the USE_CPLUSPLUS symbol, which
+       indicates that a C++ compiler was used to compiled Perl and will be
+       used to compile extensions.
+
 d_crypt (d_crypt.U):
        This variable conditionally defines the CRYPT symbol, which
        indicates to the C program that the crypt() routine is available
@@ -548,6 +554,10 @@ d_csh (d_csh.U):
        This variable conditionally defines the CSH symbol, which
        indicates to the C program that the C-shell exists.
 
+d_ctermid (d_ctermid.U):
+       This variable conditionally defines CTERMID if ctermid() is
+       available to generate filename for terminal.
+
 d_ctermid_r (d_ctermid_r.U):
        This variable conditionally defines the HAS_CTERMID_R symbol,
        which indicates to the C program that the ctermid_r()
@@ -578,6 +588,11 @@ d_difftime (d_difftime.U):
        This variable conditionally defines the HAS_DIFFTIME symbol, which
        indicates to the C program that the difftime() routine is available.
 
+d_dir_dd_fd (d_dir_dd_fd.U):
+       This variable conditionally defines the HAS_DIR_DD_FD symbol, which
+       indicates that the DIR directory stream type contains a member
+       variable called dd_fd.
+
 d_dirfd (d_dirfd.U):
        This variable conditionally defines the HAS_DIRFD constant,
        which indicates to the C program that dirfd() is available
@@ -824,7 +839,7 @@ d_ftime (d_ftime.U):
        that the ftime() routine exists.  The ftime() routine is basically
        a sub-second accuracy clock.
 
-d_futimes (f_futimes.U):
+d_futimes (d_futimes.U):
        This variable conditionally defines the HAS_FUTIMES symbol, which
        indicates to the C program that the futimes() routine is available.
 
@@ -1011,15 +1026,15 @@ d_getpgid (d_getpgid.U):
        indicates to the C program that the getpgid(pid) function
        is available to get the process group id.
 
+d_getpgrp (d_getpgrp.U):
+       This variable conditionally defines HAS_GETPGRP if getpgrp() is
+       available to get the current process group.
+
 d_getpgrp2 (d_getpgrp2.U):
        This variable conditionally defines the HAS_GETPGRP2 symbol, which
        indicates to the C program that the getpgrp2() (as in DG/UX) routine
        is available to get the current process group.
 
-d_getpgrp (d_getpgrp.U):
-       This variable conditionally defines HAS_GETPGRP if getpgrp() is
-       available to get the current process group.
-
 d_getppid (d_getppid.U):
        This variable conditionally defines the HAS_GETPPID symbol, which
        indicates to the C program that the getppid() routine is available
@@ -1202,6 +1217,11 @@ d_ldbl_dig (d_ldbl_dig.U):
        header files provide LDBL_DIG, which is the number of significant
        digits in a long double precision number.
 
+d_libm_lib_version (d_libm_lib_version.U):
+       This variable conditionally defines the LIBM_LIB_VERSION symbol,
+       which indicates to the C program that math.h defines _LIB_VERSION
+       being available in libm
+
 d_link (d_link.U):
        This variable conditionally defines HAS_LINK if link() is
        available to create hard links.
@@ -1211,6 +1231,10 @@ d_localtime_r (d_localtime_r.U):
        which indicates to the C program that the localtime_r()
        routine is available.
 
+d_localtime_r_needs_tzset (d_localtime_r.U):
+       This variable conditionally defines the LOCALTIME_R_NEEDS_TZSET
+       symbol, which makes us call tzset before localtime_r()
+
 d_locconv (d_locconv.U):
        This variable conditionally defines HAS_LOCALECONV if localeconv() is
        available for numeric and monetary formatting conventions.
@@ -1241,12 +1265,12 @@ d_madvise (d_madvise.U):
        This variable conditionally defines HAS_MADVISE if madvise() is
        available to map a file into memory.
 
-d_malloc_size (d_malloc_size.U):
-       This symbol, if defined, indicates that the malloc_size
+d_malloc_good_size (d_malloc_size.U):
+       This symbol, if defined, indicates that the malloc_good_size
        routine is available for use.
 
-d_malloc_good_size (d_malloc_good_size.U):
-       This symbol, if defined, indicates that the malloc_good_size
+d_malloc_size (d_malloc_size.U):
+       This symbol, if defined, indicates that the malloc_size
        routine is available for use.
 
 d_mblen (d_mblen.U):
@@ -1517,6 +1541,10 @@ d_PRIi64 (quadfio.U):
        This variable conditionally defines the PERL_PRIi64 symbol, which
        indiciates that stdio has a symbol to print 64-bit decimal numbers.
 
+d_printf_format_null (d_attribut.U):
+       This variable conditionally defines PRINTF_FORMAT_NULL_OK, which
+       indicates the C compiler allows printf-like formats to be null.
+
 d_PRIo64 (quadfio.U):
        This variable conditionally defines the PERL_PRIo64 symbol, which
        indiciates that stdio has a symbol to print 64-bit octal numbers.
@@ -1540,6 +1568,10 @@ d_procselfexe (d_procselfexe.U):
        Defined if $procselfexe is symlink to the absolute
        pathname of the executing program.
 
+d_pseudofork (d_vfork.U):
+       This variable conditionally defines the HAS_PSEUDOFORK symbol,
+       which indicates that an emulation of the fork routine is available.
+
 d_pthread_atfork (d_pthread_atfork.U):
        This variable conditionally defines the HAS_PTHREAD_ATFORK symbol,
        which indicates to the C program that the pthread_atfork()
@@ -1600,15 +1632,15 @@ d_random_r (d_random_r.U):
        which indicates to the C program that the random_r()
        routine is available.
 
+d_readdir (d_readdir.U):
+       This variable conditionally defines HAS_READDIR if readdir() is
+       available to read directory entries.
+
 d_readdir64_r (d_readdir64_r.U):
        This variable conditionally defines the HAS_READDIR64_R symbol,
        which indicates to the C program that the readdir64_r()
        routine is available.
 
-d_readdir (d_readdir.U):
-       This variable conditionally defines HAS_READDIR if readdir() is
-       available to read directory entries.
-
 d_readdir_r (d_readdir_r.U):
        This variable conditionally defines the HAS_READDIR_R symbol,
        which indicates to the C program that the readdir_r()
@@ -1787,15 +1819,15 @@ d_setpgid (d_setpgid.U):
        This variable conditionally defines the HAS_SETPGID symbol if the
        setpgid(pid, gpid) function is available to set process group ID.
 
+d_setpgrp (d_setpgrp.U):
+       This variable conditionally defines HAS_SETPGRP if setpgrp() is
+       available to set the current process group.
+
 d_setpgrp2 (d_setpgrp2.U):
        This variable conditionally defines the HAS_SETPGRP2 symbol, which
        indicates to the C program that the setpgrp2() (as in DG/UX) routine
        is available to set the current process group.
 
-d_setpgrp (d_setpgrp.U):
-       This variable conditionally defines HAS_SETPGRP if setpgrp() is
-       available to set the current process group.
-
 d_setprior (d_setprior.U):
        This variable conditionally defines HAS_SETPRIORITY if setpriority()
        is available to set a process's priority.
@@ -1901,6 +1933,11 @@ d_sigaction (d_sigaction.U):
        This variable conditionally defines the HAS_SIGACTION symbol, which
        indicates that the Vr4 sigaction() routine is available.
 
+d_signbit (d_signbit.U):
+       This variable conditionally defines the HAS_SIGNBIT symbol, which
+       indicates to the C program that the signbit() routine is available
+       and safe to use with perl's intern NV type.
+
 d_sigprocmask (d_sigprocmask.U):
        This variable conditionally defines HAS_SIGPROCMASK
        if sigprocmask() is available to examine or change the signal mask
@@ -1916,6 +1953,11 @@ d_sitearch (sitearch.U):
        of architecture-dependent library files for $package.  If
        $sitearch is the same as $archlib, then this is set to undef.
 
+d_snprintf (d_snprintf.U):
+       This variable conditionally defines the HAS_SNPRINTF symbol, which
+       indicates to the C program that the snprintf () library function
+       is available.
+
 d_sockatmark (d_sockatmark.U):
        This variable conditionally defines the HAS_SOCKATMARK symbol, which
        indicates to the C program that the sockatmark() routine is available.
@@ -1941,7 +1983,7 @@ d_socks5_init (d_socks5_init.U):
        This variable conditionally defines the HAS_SOCKS5_INIT symbol, which
        indicates to the C program that the socks5_init() routine is available.
 
-d_sprintf_returns_strlen (d_sprintf_returns_strlen.U):
+d_sprintf_returns_strlen (d_sprintf_len.U):
        This variable defines whether sprintf returns the length of the string
        (as per the ANSI spec). Some C libraries retain compatibility with
        pre-ANSI C and return a pointer to the passed in buffer; for these
@@ -2279,6 +2321,11 @@ d_vprintf (d_vprintf.U):
        indicates to the C program that the vprintf() routine is available
        to printf with a pointer to an argument list.
 
+d_vsnprintf (d_snprintf.U):
+       This variable conditionally defines the HAS_VSNPRINTF symbol, which
+       indicates to the C program that the vsnprintf () library function
+       is available.
+
 d_wait4 (d_wait4.U):
        This variable conditionally defines the HAS_WAIT4 symbol, which
        indicates the wait4() routine is available.
@@ -3141,6 +3188,11 @@ inc_version_list (inc_version_list.U):
        site_perl directory was introduced in 5.005, so that is the
        lowest possible value.
 
+       This list includes architecture-dependent directories back to
+       version $api_versionstring (e.g. 5.5.640) and
+       architecture-independent directories all the way back to
+       5.005.
+
 inc_version_list_init (inc_version_list.U):
        This variable holds the same list as inc_version_list, but
        each item is enclosed in double quotes and separated by commas,
@@ -3155,6 +3207,14 @@ inews (Loc.U):
        This variable is defined but not used by Configure.
        The value is a plain '' and is not useful.
 
+initialinstalllocation (bin.U):
+       When userelocatableinc is true, this variable holds the location
+       that make install should copy the perl binary to, with all the
+       run-time relocatable paths calculated from this at install time.
+       When used, it is initialised to the original value of binexp, and
+       then binexp is set to '.../', as the other binaries are found
+       relative to the perl binary.
+
 installarchlib (archlib.U):
        This variable is really the same as archlibexp but may differ on
        those systems using AFS. For extra portability, only this variable
@@ -3520,6 +3580,18 @@ mad (mad.U):
        This variable indicates that the Misc Attribute Definition code is to
        be compiled.
 
+madlyh (mad.U):
+       If the Misc Attribute Decoration is to be compiled, this variable is
+       set to the name of the extra header files to be used, else it is ''
+
+madlyobj (mad.U):
+       If the Misc Attribute Decoration is to be compiled, this variable is
+       set to the name of the extra object files to be used, else it is ''
+
+madlysrc (mad.U):
+       If the Misc Attribute Decoration is to be compiled, this variable is
+       set to the name of the extra C source files to be used, else it is ''
+
 mail (Loc.U):
        This variable is defined but not used by Configure.
        The value is a plain '' and is not useful.
@@ -3829,14 +3901,44 @@ path_sep (Unix.U):
        This is an old synonym for p_ in Head.U, the character
        used to separate elements in the command shell search PATH.
 
+perl (Loc.U):
+       This variable is defined but not used by Configure.
+       The value is a plain '' and is not useful.
+
 perl5 (perl5.U):
        This variable contains the full path (if any) to a previously
        installed perl5.005 or later suitable for running the script
        to determine inc_version_list.
 
-perl (Loc.U):
-       This variable is defined but not used by Configure.
-       The value is a plain '' and is not useful.
+PERL_API_REVISION (patchlevel.h):
+       This number describes the earliest compatible PERL_REVISION of
+       Perl ("compatibility" here being defined as sufficient binary/API
+       compatibility to run XS code built with the older version).
+       Normally this does not change across maintenance releases.
+       Please read the comment in patchlevel.h.
+
+PERL_API_SUBVERSION (patchlevel.h):
+       This number describes the earliest compatible PERL_SUBVERSION of
+       Perl ("compatibility" here being defined as sufficient binary/API
+       compatibility to run XS code built with the older version).
+       Normally this does not change across maintenance releases.
+       Please read the comment in patchlevel.h.
+
+PERL_API_VERSION (patchlevel.h):
+       This number describes the earliest compatible PERL_VERSION of
+       Perl ("compatibility" here being defined as sufficient binary/API
+       compatibility to run XS code built with the older version).
+       Normally this does not change across maintenance releases.
+       Please read the comment in patchlevel.h.
+
+PERL_CONFIG_SH (Oldsyms.U):
+       This is set to 'true' in config.sh so that a shell script
+       sourcing config.sh can tell if it has been sourced already.
+
+PERL_PATCHLEVEL (Oldsyms.U):
+       This symbol reflects the patchlevel, if available. Will usually
+       come from the .patch file, which is available when the perl
+       source tree was fetched with rsync.
 
 perl_patchlevel (patchlevel.U):
        This is the Perl patch level, a numeric change identifier,
@@ -4000,6 +4102,10 @@ rm (Loc.U):
        full pathname (if any) of the rm program.  After Configure runs,
        the value is reset to a plain "rm" and is not useful.
 
+rm_try (Unix.U):
+       This is a cleanup variable for try test programs.
+       Internal Configure use only.
+
 rmail (Loc.U):
        This variable is defined but not used by Configure.
        The value is a plain '' and is not useful.
@@ -4649,7 +4755,7 @@ uquadtype (quadtype.U):
 use5005threads (usethreads.U):
        This variable conditionally defines the USE_5005THREADS symbol,
        and indicates that Perl should be built to use the 5.005-based
-       threading implementation.
+       threading implementation. Only valid up to 5.8.x.
 
 use64bitall (use64bits.U):
        This variable conditionally defines the USE_64_BIT_ALL symbol,
@@ -4746,7 +4852,7 @@ usereentrant (usethreads.U):
        meaningful if usethreads is set and is very experimental, it is
        not even prompted for.
 
-userelocatableinc (XXX.U):
+userelocatableinc (bin.U):
        This variable is set to true to indicate that perl should relocate
        @INC entries at runtime based on the path to the perl binary.
        Any @INC paths starting ".../" are relocated relative to the directory
@@ -4764,6 +4870,11 @@ useshrplib (libperl.U):
        This variable is set to 'true' if the user wishes
        to build a shared libperl, and 'false' otherwise.
 
+usesitecustomize (d_sitecustomize.U):
+       This variable is set to true when the user requires a mechanism that
+       allows the sysadmin to add entries to @INC at runtime.  This variable
+       being set, makes perl run '$sitelib/sitecustomize.pl' at startup.
+
 usesocks (usesocks.U):
        This variable conditionally defines the USE_SOCKS symbol,
        and indicates that Perl should be built to use SOCKS.