summaryrefslogtreecommitdiff
path: root/Porting/Glossary
diff options
context:
space:
mode:
Diffstat (limited to 'Porting/Glossary')
-rw-r--r--Porting/Glossary410
1 files changed, 214 insertions, 196 deletions
diff --git a/Porting/Glossary b/Porting/Glossary
index bef7409c73..080a4d8577 100644
--- a/Porting/Glossary
+++ b/Porting/Glossary
@@ -4,33 +4,6 @@ programs (e.g. I_UNISTD) are already described in config_h.SH. [`configpm'
generates pod documentation for Config.pm from this file--please try to keep
the formatting regular.]
-CONFIGDOTSH (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.
-
-Mcc (Loc.U):
- This variable is used internally by Configure to determine the
- full pathname (if any) of the Mcc program. After Configure runs,
- the value is reset to a plain "Mcc" and is not useful.
-
-PERL_APIVERSION (Oldsyms.U):
- This value is manually set in patchlevel.h and is used
- to set the Configure apiversion variable.
-
-PERL_REVISION (Oldsyms.U):
- In a Perl version number such as 5.6.2, this is the 5.
- This value is manually set in patchlevel.h
-
-PERL_SUBVERSION (Oldsyms.U):
- In a Perl version number such as 5.6.2, this is the 2.
- Values greater than 50 represent potentially unstable
- development subversions.
- This value is manually set in patchlevel.h
-
-PERL_VERSION (Oldsyms.U):
- In a Perl version number such as 5.6.2, this is the 6.
- This value is manually set in patchlevel.h
-
_a (Unix.U):
This variable defines the extension used for ordinary libraries.
For unix, it is '.a'. The '.' is included. Other possible
@@ -64,16 +37,49 @@ aphostname (d_gethname.U):
host name. The command is fully qualified by its absolute path, to make
it safe when used by a process with super-user privileges.
-apiversion (patchlevel.U):
- MakeMaker will install add-on modules in a directory with the
- PERL_APIVERSION version number. The value is set manually in
- patchlevel.h. Normally, for maintenance releases, this is
- just something like 5.005 or 5.6 or 5.7. That is, it does not
- include the subversion number and does not change across
- maintenance releases. This is so that add-on extensions can
- be shared across maintenance versions. It is unclear how this
- ought to work for developer versions. If a release breaks
- binary compatibility, this number should be increased.
+api_revision (patchlevel.U):
+ The three variables, api_revision, api_version, and
+ api_subversion, specify the version of the oldest perl binary
+ compatible with the present perl. In a full version string
+ such as '5.6.1', api_revision is the '5'.
+ Prior to 5.5.640, the format was a floating point number,
+ like 5.00563.
+ perl.c:incpush() and lib/lib.pm will automatically search in
+ $sitelib/.. for older directories back to the limit specified
+ by these api_ variables. This is only useful if you have a
+ perl library directory tree structured like the default one.
+ See INSTALL for how this works. The versioned site_perl
+ directory was introduced in 5.005, so that is the lowest
+ possible value. The version list appropriate for the current
+ system is determined in inc_version_list.U.
+ XXX To do: Since compatibility can depend on compile time
+ options (such as bincompat, longlong, etc.) it should
+ (perhaps) be set by Configure, but currently it isn't.
+ Currently, we read a hard-wired value from patchlevel.h.
+ Perhaps what we ought to do is take the hard-wired value from
+ patchlevel.h but then modify it if the current Configure
+ options warrant. patchlevel.h then would use an #ifdef guard.
+
+api_subversion (patchlevel.U):
+ The three variables, api_revision, api_version, and
+ api_subversion, specify the version of the oldest perl binary
+ compatible with the present perl. In a full version string
+ such as '5.6.1', api_subversion is the '1'. See api_revision for
+ full details.
+
+api_version (patchlevel.U):
+ The three variables, api_revision, api_version, and
+ api_subversion, specify the version of the oldest perl binary
+ compatible with the present perl. In a full version string
+ such as '5.6.1', api_version is the '6'. See api_revision for
+ full details. As a special case, 5.5.0 is rendered in the
+ old-style as 5.005. (In the 5.005_0x maintenance series,
+ this was the only versioned directory in $sitelib.)
+
+api_versionstring (patchlevel.U):
+ This variable combines api_revision, api_version, and
+ api_subversion in a format such as 5.6.1 (or 5_6_1) suitable
+ for use as a directory name. This is filesystem dependent.
ar (Loc.U):
This variable is used internally by Configure to determine the
@@ -233,6 +239,10 @@ compress (Loc.U):
This variable is defined but not used by Configure.
The value is a plain '' and is not useful.
+CONFIGDOTSH (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.
+
contains (contains.U):
This variable holds the command to do a grep with a proper return
status. On most sane systems it is simply "grep". On insane systems
@@ -258,7 +268,7 @@ cpp_stuff (cpp_stuff.U):
used by the C preprocessor.
cppccsymbols (Cppsym.U):
- The variable contains the symbols defined by the C compiler when
+ The variable contains the symbols defined by the C compiler
when it calls cpp. The symbols defined by the cc alone or cpp
alone are not in this list, see ccsymbols and cppsymbols.
The list is a space-separated list of symbol=value tokens.
@@ -312,64 +322,6 @@ csh (Loc.U):
full pathname (if any) of the csh program. After Configure runs,
the value is reset to a plain "csh" and is not useful.
-d_Gconvert (d_gconvert.U):
- This variable holds what Gconvert is defined as to convert
- floating point numbers into strings. It could be 'gconvert'
- or a more complex macro emulating gconvert with gcvt() or sprintf.
- Possible values are:
- d_Gconvert='gconvert((x),(n),(t),(b))'
- d_Gconvert='gcvt((x),(n),(b))'
- d_Gconvert='sprintf((b),"%.*g",(n),(x))'
-
-d_PRIEldbl (longdblfio.U):
- This variable conditionally defines the PERL_PRIfldlbl symbol, which
- indiciates that stdio has a symbol to print long doubles.
-
-d_PRIFldbl (longdblfio.U):
- This variable conditionally defines the PERL_PRIfldlbl symbol, which
- indiciates that stdio has a symbol to print long doubles.
-
-d_PRIGldbl (longdblfio.U):
- This variable conditionally defines the PERL_PRIfldlbl symbol, which
- indiciates that stdio has a symbol to print long doubles.
-
-d_PRIX64 (quadfio.U):
- This variable conditionally defines the PERL_PRIX64 symbol, which
- indiciates that stdio has a symbol to print 64-bit hExADECimAl numbers.
-
-d_PRId64 (quadfio.U):
- This variable conditionally defines the PERL_PRId64 symbol, which
- indiciates that stdio has a symbol to print 64-bit decimal numbers.
-
-d_PRIeldbl (longdblfio.U):
- This variable conditionally defines the PERL_PRIfldlbl symbol, which
- indiciates that stdio has a symbol to print long doubles.
-
-d_PRIfldbl (longdblfio.U):
- This variable conditionally defines the PERL_PRIfldlbl symbol, which
- indiciates that stdio has a symbol to print long doubles.
-
-d_PRIgldbl (longdblfio.U):
- This variable conditionally defines the PERL_PRIfldlbl symbol, which
- indiciates that stdio has a symbol to print long doubles.
-
-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_PRIo64 (quadfio.U):
- This variable conditionally defines the PERL_PRIo64 symbol, which
- indiciates that stdio has a symbol to print 64-bit octal numbers.
-
-d_PRIu64 (quadfio.U):
- This variable conditionally defines the PERL_PRIu64 symbol, which
- indiciates that stdio has a symbol to print 64-bit unsigned decimal
- numbers.
-
-d_PRIx64 (quadfio.U):
- This variable conditionally defines the PERL_PRIx64 symbol, which
- indiciates that stdio has a symbol to print 64-bit hexadecimal numbers.
-
d_access (d_access.U):
This variable conditionally defines HAS_ACCESS if the access() system
call is available to check for access permissions using real IDs.
@@ -648,6 +600,15 @@ d_ftime (d_ftime.U):
that the ftime() routine exists. The ftime() routine is basically
a sub-second accuracy clock.
+d_Gconvert (d_gconvert.U):
+ This variable holds what Gconvert is defined as to convert
+ floating point numbers into strings. It could be 'gconvert'
+ or a more complex macro emulating gconvert with gcvt() or sprintf.
+ Possible values are:
+ d_Gconvert='gconvert((x),(n),(t),(b))'
+ d_Gconvert='gcvt((x),(n),(b))'
+ d_Gconvert='sprintf((b),"%.*g",(n),(x))'
+
d_getgrent (d_getgrent.U):
This variable conditionally defines the HAS_GETGRENT symbol, which
indicates to the C program that the getgrent() routine is available
@@ -1034,6 +995,55 @@ d_portable (d_portable.U):
indicates to the C program that it should not assume that it is
running on the machine it was compiled on.
+d_PRId64 (quadfio.U):
+ This variable conditionally defines the PERL_PRId64 symbol, which
+ indiciates that stdio has a symbol to print 64-bit decimal numbers.
+
+d_PRIeldbl (longdblfio.U):
+ This variable conditionally defines the PERL_PRIfldlbl symbol, which
+ indiciates that stdio has a symbol to print long doubles.
+
+d_PRIEldbl (longdblfio.U):
+ This variable conditionally defines the PERL_PRIfldlbl symbol, which
+ indiciates that stdio has a symbol to print long doubles.
+
+d_PRIfldbl (longdblfio.U):
+ This variable conditionally defines the PERL_PRIfldlbl symbol, which
+ indiciates that stdio has a symbol to print long doubles.
+
+d_PRIFldbl (longdblfio.U):
+ This variable conditionally defines the PERL_PRIfldlbl symbol, which
+ indiciates that stdio has a symbol to print long doubles.
+
+d_PRIgldbl (longdblfio.U):
+ This variable conditionally defines the PERL_PRIfldlbl symbol, which
+ indiciates that stdio has a symbol to print long doubles.
+
+d_PRIGldbl (longdblfio.U):
+ This variable conditionally defines the PERL_PRIfldlbl symbol, which
+ indiciates that stdio has a symbol to print long doubles.
+
+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_PRIo64 (quadfio.U):
+ This variable conditionally defines the PERL_PRIo64 symbol, which
+ indiciates that stdio has a symbol to print 64-bit octal numbers.
+
+d_PRIu64 (quadfio.U):
+ This variable conditionally defines the PERL_PRIu64 symbol, which
+ indiciates that stdio has a symbol to print 64-bit unsigned decimal
+ numbers.
+
+d_PRIx64 (quadfio.U):
+ This variable conditionally defines the PERL_PRIx64 symbol, which
+ indiciates that stdio has a symbol to print 64-bit hexadecimal numbers.
+
+d_PRIX64 (quadfio.U):
+ This variable conditionally defines the PERL_PRIX64 symbol, which
+ indiciates that stdio has a symbol to print 64-bit hExADECimAl numbers.
+
d_pthread_yield (d_pthread_y.U):
This variable conditionally defines the HAS_PTHREAD_YIELD
symbol if the pthread_yield routine is available to yield
@@ -1071,6 +1081,10 @@ d_pwquota (i_pwd.U):
This variable conditionally defines PWQUOTA, which indicates
that struct passwd contains pw_quota.
+d_qgcvt (d_qgcvt.U):
+ This variable conditionally defines the HAS_QGCVT symbol, which
+ indicates to the C program that the qgcvt() routine is available.
+
d_quad (quadtype.U):
This variable, if defined, tells that there's a 64-bit integer type,
quadtype.
@@ -1388,15 +1402,23 @@ d_strtol (d_strtol.U):
indicates to the C program that the strtol() routine is available
to provide better numeric string conversion than atoi() and friends.
+d_strtold (d_strtold.U):
+ This variable conditionally defines the HAS_STRTOLD symbol, which
+ indicates to the C program that the strtold() routine is available.
+
d_strtoul (d_strtoul.U):
This variable conditionally defines the HAS_STRTOUL symbol, which
indicates to the C program that the strtoul() routine is available
to provide conversion of strings to unsigned long.
-d_strtoull (strtoull.U):
+d_strtoull (d_strtoull.U):
This variable conditionally defines the HAS_STRTOULL symbol, which
indicates to the C program that the strtoull() routine is available.
+d_strtouq (d_strtouq.U):
+ This variable conditionally defines the HAS_STRTOUQ symbol, which
+ indicates to the C program that the strtouq() routine is available.
+
d_strxfrm (d_strxfrm.U):
This variable conditionally defines HAS_STRXFRM if strxfrm() is
available to transform strings.
@@ -1634,10 +1656,6 @@ extensions (Extensions.U):
and is typically used to test whether a particular extesion
is available.
-fflushNULL (fflushall.U):
- This symbol, if defined, tells that fflush(NULL) does flush
- all pending stdio output.
-
fflushall (fflushall.U):
This symbol, if defined, tells that to flush
all pending stdio output one must loop through all
@@ -1645,10 +1663,13 @@ fflushall (fflushall.U):
Note that if fflushNULL is defined, fflushall will not
even be probed for and will be left undefined.
+fflushNULL (fflushall.U):
+ This symbol, if defined, tells that fflush(NULL) does flush
+ all pending stdio output.
+
find (Loc.U):
- This variable is used internally by Configure to determine the
- full pathname (if any) of the find program. After Configure runs,
- the value is reset to a plain "find" and is not useful.
+ This variable is defined but not used by Configure.
+ The value is a plain '' and is not useful.
firstmakefile (Unix.U):
This variable defines the first file searched by make. On unix,
@@ -2097,6 +2118,15 @@ ignore_versioned_solibs (libs.U):
libraries (libfoo.so.x.y) are to be ignored (because they
cannot be linked against).
+inc_version_list (inc_version_list.U):
+ This variable specifies the list of subdirectories in over
+ which perl.c:incpush() and lib/lib.pm will automatically
+ search when adding directories to @INC. This is only useful
+ if you have a perl library directory tree structured like the
+ default one. See INSTALL for how this works. The versioned
+ site_perl directory was introduced in 5.005, so that is the
+ lowest possible value.
+
incpath (usrinc.U):
This variable must preceed the normal include path to get hte
right one, as in "$incpath/usr/include" or "$incpath/usr/lib".
@@ -2279,9 +2309,8 @@ libswanted (Myinit.U):
ahead of ucb or bsd libraries for SVR4.
line (Loc.U):
- This variable is used internally by Configure to determine the
- full pathname (if any) of the line program. After Configure runs,
- the value is reset to a plain "line" and is not useful.
+ This variable is defined but not used by Configure.
+ The value is a plain '' and is not useful.
lint (Loc.U):
This variable is defined but not used by Configure.
@@ -2419,6 +2448,11 @@ man3ext (man3dir.U):
have: one of 'n', 'l', or '3'. The Makefile must supply the '.'.
See man3dir.
+Mcc (Loc.U):
+ This variable is used internally by Configure to determine the
+ full pathname (if any) of the Mcc program. After Configure runs,
+ the value is reset to a plain "Mcc" and is not useful.
+
medium (models.U):
This variable contains a flag which will tell the C compiler and loader
to produce a program running with a medium memory model. If the
@@ -2595,6 +2629,8 @@ passcat (nis.U):
patchlevel (patchlevel.U):
The patchlevel level of this package.
The value of patchlevel comes from the patchlevel.h file.
+ In a version number such as 5.6.1, this is the "6".
+ In patchlevel.h, this is referred to as the "PERL_VERSION".
path_sep (Unix.U):
This is an old synonym for p_ in Head.U, the character
@@ -2605,6 +2641,20 @@ perl (Loc.U):
full pathname (if any) of the perl program. After Configure runs,
the value is reset to a plain "perl" and is not useful.
+PERL_REVISION (Oldsyms.U):
+ In a Perl version number such as 5.6.2, this is the 5.
+ This value is manually set in patchlevel.h
+
+PERL_SUBVERSION (Oldsyms.U):
+ In a Perl version number such as 5.6.2, this is the 2.
+ Values greater than 50 represent potentially unstable
+ development subversions.
+ This value is manually set in patchlevel.h
+
+PERL_VERSION (Oldsyms.U):
+ In a Perl version number such as 5.6.2, this is the 6.
+ This value is manually set in patchlevel.h
+
perladmin (perladmin.U):
Electronic mail address of the perl5 administrator.
@@ -2633,21 +2683,6 @@ plibpth (libpth.U):
Its value is prepend to libpth. This variable takes care of special
machines, like the mips. Usually, it should be empty.
-pm_apiversion (xs_apiversion.U):
- This variable contains the version of the oldest perl
- compatible with the present perl. (That is, pure perl modules
- written for $pm_apiversion will still work for the current
- version). perl.c:incpush() and lib/lib.pm will automatically
- search in $sitelib for older directories across major versions
- back to pm_apiversion. This is only useful if you have a perl
- library directory tree structured like the default one. The
- versioned site_perl library was introduced in 5.005, so that's
- the default setting for this variable. It's hard to imagine
- it changing before Perl6. It is included here for symmetry
- with xs_apiveprsion -- the searching algorithms will
- (presumably) be similar.
- See the INSTALL file for how this works.
-
pmake (Loc.U):
This variable is defined but not used by Configure.
The value is a plain '' and is not useful.
@@ -2731,54 +2766,6 @@ runnm (usenm.U):
nm extraction should be performed or not, according to the value
of usenm and the flags on the Configure command line.
-sPRIEldbl (longdblfio.U):
- This variable, if defined, contains the string used by stdio to
- format long doubles (format 'E') for output.
-
-sPRIFldbl (longdblfio.U):
- This variable, if defined, contains the string used by stdio to
- format long doubles (format 'F') for output.
-
-sPRIGldbl (longdblfio.U):
- This variable, if defined, contains the string used by stdio to
- format long doubles (format 'G') for output.
-
-sPRIX64 (quadfio.U):
- This variable, if defined, contains the string used by stdio to
- format 64-bit hExADECimAl numbers (format 'X') for output.
-
-sPRId64 (quadfio.U):
- This variable, if defined, contains the string used by stdio to
- format 64-bit decimal numbers (format 'd') for output.
-
-sPRIeldbl (longdblfio.U):
- This variable, if defined, contains the string used by stdio to
- format long doubles (format 'e') for output.
-
-sPRIfldbl (longdblfio.U):
- This variable, if defined, contains the string used by stdio to
- format long doubles (format 'f') for output.
-
-sPRIgldbl (longdblfio.U):
- This variable, if defined, contains the string used by stdio to
- format long doubles (format 'g') for output.
-
-sPRIi64 (quadfio.U):
- This variable, if defined, contains the string used by stdio to
- format 64-bit decimal numbers (format 'i') for output.
-
-sPRIo64 (quadfio.U):
- This variable, if defined, contains the string used by stdio to
- format 64-bit octal numbers (format 'o') for output.
-
-sPRIu64 (quadfio.U):
- This variable, if defined, contains the string used by stdio to
- format 64-bit unsigned decimal numbers (format 'u') for output.
-
-sPRIx64 (quadfio.U):
- This variable, if defined, contains the string used by stdio to
- format 64-bit hexadecimal numbers (format 'x') for output.
-
sched_yield (d_pthread_y.U):
This variable defines the way to yield the execution
of the current thread.
@@ -2817,9 +2804,8 @@ selecttype (selecttype.U):
have select(), naturally.
sendmail (Loc.U):
- This variable is used internally by Configure to determine the
- full pathname (if any) of the sendmail program. After Configure runs,
- the value is reset to a plain "sendmail" and is not useful.
+ This variable is defined but not used by Configure.
+ The value is a plain '' and is not useful.
sh (sh.U):
This variable contains the full pathname of the shell used
@@ -3001,6 +2987,54 @@ split (models.U):
machines that support separation of instruction and data space. It is
up to the Makefile to use this.
+sPRId64 (quadfio.U):
+ This variable, if defined, contains the string used by stdio to
+ format 64-bit decimal numbers (format 'd') for output.
+
+sPRIeldbl (longdblfio.U):
+ This variable, if defined, contains the string used by stdio to
+ format long doubles (format 'e') for output.
+
+sPRIEldbl (longdblfio.U):
+ This variable, if defined, contains the string used by stdio to
+ format long doubles (format 'E') for output.
+
+sPRIfldbl (longdblfio.U):
+ This variable, if defined, contains the string used by stdio to
+ format long doubles (format 'f') for output.
+
+sPRIFldbl (longdblfio.U):
+ This variable, if defined, contains the string used by stdio to
+ format long doubles (format 'F') for output.
+
+sPRIgldbl (longdblfio.U):
+ This variable, if defined, contains the string used by stdio to
+ format long doubles (format 'g') for output.
+
+sPRIGldbl (longdblfio.U):
+ This variable, if defined, contains the string used by stdio to
+ format long doubles (format 'G') for output.
+
+sPRIi64 (quadfio.U):
+ This variable, if defined, contains the string used by stdio to
+ format 64-bit decimal numbers (format 'i') for output.
+
+sPRIo64 (quadfio.U):
+ This variable, if defined, contains the string used by stdio to
+ format 64-bit octal numbers (format 'o') for output.
+
+sPRIu64 (quadfio.U):
+ This variable, if defined, contains the string used by stdio to
+ format 64-bit unsigned decimal numbers (format 'u') for output.
+
+sPRIx64 (quadfio.U):
+ This variable, if defined, contains the string used by stdio to
+ format 64-bit hexadecimal numbers (format 'x') for output.
+
+sPRIX64 (quadfio.U):
+ This variable, if defined, contains the string used by stdio to
+ format 64-bit hExADECimAl numbers (format 'X') for output.
+
src (src.U):
This variable holds the path to the package source. It is up to
the Makefile to use this variable and set VPATH accordingly to
@@ -3076,6 +3110,7 @@ submit (Loc.U):
subversion (patchlevel.U):
The subversion level of this package.
The value of subversion comes from the patchlevel.h file.
+ In a version number such as 5.6.1, this is the "1".
This is unique to perl.
sysman (sysman.U):
@@ -3197,7 +3232,7 @@ use64bits (use64bits.U):
when available.
usedl (dlsrc.U):
- This variable indicates if the the system supports dynamic
+ This variable indicates if the system supports dynamic
loading of some sort. See also dlsrc and dlobj.
useithreads (usethreads.U):
@@ -3347,11 +3382,11 @@ vendorprefixexp (vendorprefix.U):
which the vendor will install add-on packages. Derived from vendorprefix.
version (patchlevel.U):
- The full version number of this package. This combines
- baserev, patchlevel, and subversion to get the full
- version number, including any possible subversions. Care
- is taken to use the C locale in order to get something
- like 5.004 instead of 5,004. This is unique to perl.
+ The full version number of this package, such as 5.6.1 (or 5_6_1).
+ This combines baserev, patchlevel, and subversion to get the
+ full version number, including any possible subversions.
+ This is suitable for use as a directory name, and hence is
+ filesystem dependent.
vi (Loc.U):
This variable is defined but not used by Configure.
@@ -3367,23 +3402,6 @@ xlibpth (libpth.U):
libraries on this platform, for example CPU-specific libraries
(on multi-CPU platforms) may be listed here.
-xs_apiversion (xs_apiversion.U):
- This variable contains the version of the oldest perl binary
- compatible with the present perl. perl.c:incpush() and
- lib/lib.pm will automatically search in $sitearch for older
- directories across major versions back to xs_apiversion.
- This is only useful if you have a perl library directory tree
- structured like the default one.
- See INSTALL for how this works.
- The versioned site_perl directory was introduced in 5.005,
- so that is the lowest possible value.
- Since this can depend on compile time options (such as
- bincompat) it is set by Configure. Other non-default sources
- of potential incompatibility, such as multiplicity, threads,
- debugging, 64bits, sfio, etc., are not checked for currently,
- though in principle we could go snooping around in old
- Config.pm files.
-
zcat (Loc.U):
This variable is defined but not used by Configure.
The value is a plain '' and is not useful.