* updated ksirk (21.12.1 -> 21.12.2), untested
[t2-trunk.git] / doc / PKG-BUILD-VARS
blobdd0b02273fa0a98d6477c6999bbaf0da836d0e5c
2 Variables used in the package build scripts
3 ===========================================
5 config ........ Name of the active configuration ($base/config/$config/..)
6 extraver ...... version text after the fist whitespace, or $sdever
7 sdever ........ T2 SDE Version (including rel. date for snapshots)
9 pkg ........... base name part of the package we are building 
10 xpkg .......... derived name part of the package we are building
11                 if a package is not pkgfork'd, pkg == xpkg
12 ver ........... package Version (from *.desc - until first whitespace)
13 desc_[A-Z] .... Data from the *.desc file
15 id ............ unique ID for this Build-Pkg invocation
16 arch .......... architecture (subdir name in architecture)
17 target ........ target distribution (subdir name in targets)
18 stagelevel .... stagelevel (0-1 = crossbuild, 2-8 = native, 9 = rebuild)
20 arch_sizeof_long_long .... arch setting from architecture/*/archtest.out
21 arch_sizeof_int .......... arch setting from architecture/*/archtest.out
22 arch_machine ............. arch setting from architecture/*/archtest.out
23 arch_sizeof_char_p ....... arch setting from architecture/*/archtest.out
24 arch_sizeof_long ......... arch setting from architecture/*/archtest.out
25 arch_bigendian ........... arch setting from architecture/*/archtest.out
26 arch_sizeof_short ........ arch setting from architecture/*/archtest.out
27 arch_target .............. arch setting from architecture/*/archtest.out
28 arch_build ............... like 'arch_target' - but for the build host
30 archdir ....... directory containing the package tar files (download/..)
31 confdir ....... directory containing the package build config (package/..)
32 targetdir ..... directory containing the target config (target/...)
33 builddir ...... directory in which the package is build (src.$id)
34 base .......... T2 SDE sources base directory
36 root .......... root directory (usually '/')
37 xroot ......... real root (/R.work/build/... when in chroot mode)
38 prefix ........ install prefix (usually '/usr' or '/opt/...')
39 prefix_auto ... '1' = you may auto-detect a better value for $prefix in *.conf
41 build_logs .... Big build log file ...... (Build-Target only)
42 build_pkgs .... Packagfiles go here ..... (Build-Target only)
43 build_root .... Chroot dir name ......... (Build-Target only)
44 build_toolchain T2 build system data .... (Build-Target only)
46 bindir ........ where the binaries (programs) should be installed
47 sbindir ....... where the system binaries should be installed
48 libdir ........ where the library files should be installed
49 sysconfdir .... where the configuration should be installed (i.e. etc)
50 localstatedir . where the variable data should be installed (i.e. var)
51 datadir ....... where the arch-indep. data should be installed (i.e. share)
52 docdir ........ where the documentation should be installed
53 mandir ........ where the info man pages should be installed
54 infodir ....... where the info files should be installed
55 includedir .... where the header files should be installed
57 autoextract ... '0' = skip automatic untar
58 autopatch ..... '0' = skip automatic patching
59 chownsrcdir ... '0' = don't make a chown to root after extracting the $srctar
60 nocvsinsrcdir . '0' = don't remove CVS and .svn directories in $srcdir
61 srctar ........ filename of source tar file ('auto' = autodetect)
62 srcdir ........ directory in source tar file ('auto' = autodetect)
63 xsrctar ....... filename of source tar file after 'auto' has been processed
64 xsrcdir ....... directory in source tar file after 'auto' has been processed
65 taropt ........ tar options for extracting
67 createprefix .. '0' = skip creation for directory skeleton for $prefix
68 createdocs .... '0' = skip automatic copying of documentation files
69 custmain ...... command to execute instead of 'configure, make, make install'
70 mainfunction .. alternate main function instead of build_this_package()
72 patchfiles .... list of patchfiles found in $confdir
73 patchopt ...... options passed to the patch program
75 runconf ....... set to '0' if you want to skip running configure
76 autogen ....... set to '1' if you want to run the autogen script
77 confopt ....... options for GNU autoconf './configure'
78 extraconfopt .. options which should be appended to $confopt by set_confopt()
79 configprefix .. variable declarations only for GNU autoconf './configure'
80 configscript .. script file name of the GNU autoconf configure script
81 cleanconfopt .. set to '0' if you don't want to remove unsupported options
82 pyscript ...... script to run 'setup.py', python by default.
83 pyconfopt ..... options for 'setup.py' - Python setup scripts
84 plconfopt ..... options for 'Makefile.pl' - Perl setup scripts
86 runxmkmf ...... set to '0' if you want to skip running 'xmkmf'
87 runmkpl ....... set to '0' if you want to skip running 'perl Makefile.PL'
88 runpysetup .... set to '0' if you want to skip running 'python setup.py'
90 makeopt ....... options for 'make' (default = ' ')
91 makeinstopt ... options for 'make install' (default = 'install')
93 crossnative ... has the value 'cross' or 'native'
94 archprefix .... prefix for binutils and compiler binaries (for cross-building)
96 flistdel ...... regex describing files which shouldn't go to package db
97 flistrfilter .. regex describing which lines to ignore in flist rlog
98 flistroot ..... list of top-level directories which should be used for flist
99 flistvalid .... list of directories where the build is allowed to write
101 check_shared ...... Check for files which are shared with other packages
102 check_usrlocal .... Check for files which are installed in usr/local
103 check_badfiles .... Check for files which are registered 'bad files'
105 BUILDCC ....... C compiler for helper apps (usually that's just 'cc')
106 BUILD_CC ...... C compiler for helper apps (must be the same as $BUILDCC)
107 HOSTCC ........ C compiler for helper apps (must be the same as $BUILDCC)
108 HOST_CC ....... C compiler for helper apps (must be the same as $BUILDCC)
110 MAKE .......... make executable name (including -j option according to Config)
111 CC ............ C compiler executable name for target architecture
112 CXX ........... C++ compiler executable name for target architecture
113 STRIP ......... strip executable name for target architecture
114 LD ............ ld executable name for target architecture
115 AR ............ ar executable name for target architecture
116 RANLIB ........ ranlib executable name for target architecture
117 AS ............ as executable name for target architecture
118 GASP .......... gasp executable name for target architecture
119 NM ............ nm executable name for target architecture
121 CC_WRAPPER_* ...... configuration for C compiler wrapper
122 CXX_WRAPPER_* ..... configuration for C++ compiler wrapper
123 KCC_WRAPPER_* ..... configuration for Kernel C compiler wrapper
124 F77_WRAPPER_* ..... configuration for Fortran 77 compiler wrapper
125 STRIP_WRAPPER_* ... configuration for strip wrapper
127 SDECFG_* ...... configuration from 'Config' file