OpenSDE Framework (without history before r20070)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

272 lines
10 KiB

  1. # --- SDE-COPYRIGHT-NOTE-BEGIN ---
  2. # This copyright note is auto-generated by ./scripts/Create-CopyPatch.
  3. #
  4. # Filename: lib/sde-config/config.hlp
  5. # Copyright (C) 2006 - 2008 The OpenSDE Project
  6. # Copyright (C) 2004 - 2006 The T2 SDE Project
  7. # Copyright (C) 1998 - 2003 Clifford Wolf
  8. #
  9. # More information can be found in the files COPYING and README.
  10. #
  11. # This program is free software; you can redistribute it and/or modify
  12. # it under the terms of the GNU General Public License as published by
  13. # the Free Software Foundation; version 2 of the License. A copy of the
  14. # GNU General Public License can be found in the file COPYING.
  15. # --- SDE-COPYRIGHT-NOTE-END ---
  16. COMMENT_ARCHCPUOPT
  17. In this section you are able to select the architecture, the CPU and
  18. whether you are cross-building/porting to another architecture.
  19. COMMENT_TARGET
  20. In this section you can select which distribution target you would like
  21. to use.
  22. COMMENT_LICENSE
  23. This distribution may contain software that is not publicly
  24. distributable. Please check the following to testify that you
  25. are aware of this fact.
  26. SDECFG_LICENSE_ISSUE
  27. The user of the T2-SDE is responsible for himself to verify
  28. that packages that carry a limitation for re-distribution
  29. are not redistributed in any form (e.g. ISOs).
  30. The developers of the T2-SDE deny any responsibility for
  31. mis-use of these packages.
  32. COMMENT_BUILD_SYS_CONF
  33. Here you can set some basic options for our beautifull distribution
  34. build system.
  35. SDECFG_ARCH
  36. This options controls the target architecture like alpha, ia64, mips,
  37. ppc, sparc or x86.
  38. SDECFG_CROSSBUILD
  39. This option needs to be selected to perform a cross-build to another
  40. architecture.
  41. SDECFG_TARGET
  42. Please select the Target you want to build. Here's a short overview:
  43. - Boot-, Install- and Rescue-System:
  44. The boot-system. You need this if you want to install the system
  45. you built with CD or floppy-disk.
  46. - Desktop T2:
  47. Intended for use on workstations / desktops.
  48. - Diet LibC based T2:
  49. A distribution using Diet LibC instead of GLibC. DietLibC is
  50. a light-weight C-Library useful for embedded systems and other
  51. low-memory devices.
  52. - Generic T2:
  53. A generic, all-purpose distribution that has simply everything.
  54. - Minimal T2:
  55. A basic system that has only minimally more than a LFS.
  56. - Reference-Build for creating *.cache files:
  57. This target is for internal use only. It's purpose is to create
  58. package/*/*/*.cache files which are used to validate a package
  59. and consolidate its various information.
  60. - T2 Router:
  61. This is a _very_ minimal system with only routing-capabilities.
  62. SDECFG_PARALLEL_MAX
  63. This option specifes the amount of parallel build jobs that are tried
  64. to be kept active. This option is used by make and scons - and should
  65. also be defined when you use distcc to perform distributed builds.
  66. SDECFG_CONTINUE_ON_ERROR_AFTER
  67. The build will continue after a package build error only on an stage
  68. greater than the value selected
  69. SDECFG_RETRY_BROKEN
  70. This options controls whether the Build-System should try to build a
  71. package that has not built flawlessly during the last build.
  72. SDECFG_ALWAYS_CLEAN
  73. When a package built flawlessly then the temporary directory which was
  74. used for building is deleted. Select this options if you also want this
  75. cleanup for packages with build error. (This safes disk-space but makes
  76. debugging hard ...)
  77. SDECFG_XTRACE
  78. Please check here if you want additional (debug)-output in the build
  79. log-files.
  80. SDECFG_SRC_TMPFS
  81. Check here if you want package buids to use tmpfs instead of the regular
  82. filesystem on which T2 resides.
  83. SDECFG_SRC_TMPFS_OPT
  84. Please enter the tmpfs mount options here. For example:
  85. size=800M,nr_inodes=100k
  86. will mount an 800 Megabyte tmp-filesystem with 100,000 inodes.
  87. size=4G,nr_inodes=500k
  88. will mount a 4 Gigabyte tmp-filesystem with 500,000 inodes.
  89. Please make sure that the filesystem is big enough to hold
  90. - package-sources (unpacked)
  91. - compile-time binaries
  92. - and the binary package
  93. The filesystem size also must not be so big as to hog all your RAM or
  94. else your system might crash or start swapping.
  95. SDECFG_SRC_TMPFS_LOG
  96. Please enter the path to the tmpfs-logfile.
  97. SDECFG_EXPERT
  98. This button will enable a lot of additional configuration options.
  99. Some of these will make small changes to what the system will look
  100. like while others will have a huge impact on performance, stability
  101. and usability of the final system.
  102. Don't touch these if you don't know what you are doing.
  103. YOU HAVE BEEN WARNED!
  104. SDECFG_PKGFILE_TYPE
  105. The option allows to control the binary package format to be created.
  106. The default is to create an ordenary .tar.bz2 - but tar.gz or .gem
  107. are also among the options.
  108. SDECFG_PKGFILE_VER
  109. If selected the package version number will be added to the binary
  110. package filenme.
  111. SDECFG_PKGSEL
  112. If selected you can modify the package list for the build.
  113. MENU_PKGSEL_RULES
  114. Here you can modify the package list for the build. You have the
  115. choice between enable, disable or complete removal. A disabled
  116. package can still be reenabled by a target, while a removed one
  117. can not be selected by a target.
  118. Use "X <pattern>" to enable packages
  119. Use "O <pattern>" to disable packages
  120. Use "- <pattern>" to remove packages
  121. For example:
  122. "- gnome*"
  123. will not build Gnome at all.
  124. SDECFG_SHOW_PKGLIST
  125. This will display the complete, current package list.
  126. SDECFG_CONFOPT_FILE:0
  127. Here you can specify additional parameters passed to every ./configure
  128. script.
  129. Use "--with-option" to enable a feature
  130. Use "--without-option" to disable a feature
  131. Use "--option[=value]" to specify a custom option
  132. The Build-Syste will always check whether the configure script supports
  133. the options before the options is really passed as argument.
  134. COMMENT_FLIST
  135. Please see the help for the choice-menu.
  136. SDECFG_FLIST
  137. This help is taken from Rolling ROCK Issue #2 2003 and updated for T2
  138. The T2 build scripts auto-detect which files are created by a package
  139. build and use this information to create the package file-list. There
  140. are three techniques which can be used to auto-detect this file list
  141. * flist-wrapper
  142. The flist-wrapper is the recommended way of doing it. It's an "elf
  143. preload library". This is a library which is loaded _before_ the
  144. c-library and so can overwrite functions of the c library. The
  145. flist-wrapper lib is overwriting all functions which can be used
  146. to create files and is writing the filenames to a log file before
  147. running the original c library function.
  148. This log file is used to create the package file list after the
  149. build has been completed. The problem with the flist-wrapper lib is
  150. that it doesn't work with statically built binaries or with non
  151. glibc c libraries. In such environments (e.g. when building a
  152. dietlibc based system), other techniques - such as those described
  153. below - must be used for creating the file list.
  154. * strace
  155. This one is rather easy: The whole build is running in a process-
  156. tree which is monitored by strace. The log file created by strace is
  157. later used to create the package file list. However: this does only
  158. work on architectures which do have an strace command - which is not
  159. the case for all architectures the Linux kernel and glibc have been
  160. ported to.
  161. * find
  162. This one is rather ugly (but sometimes the only alternative): When
  163. the build is started, a 'timestamp-file' is created. After the build
  164. has been completed, the find program is used to find all files which
  165. are newer than the 'timestamp-file'. This is really slow now and has
  166. the disadvantage that nothing else than the build process may create
  167. or modify files while the build is running. This should only be used
  168. if no other system for creating the file list can be used.
  169. SDECFG_USE_CROSSCC
  170. This option controls whether to bootstrap a new, clean and up-to-date
  171. toolchain to bootstrap the target system - even for native (non cross)
  172. builds. This is needed when the host and target compiler or C library
  173. differ in the ABI. THIS IS STRONGLY RECOMMENDED!
  174. SDECFG_DO_REBUILD_STAGE
  175. This options controls whether to rebuild all packages in the final
  176. rebuild-stage.
  177. Each and every package is rebuilt in Stage 9 once more and only then
  178. are the binary-packages created. This has the advantage that
  179. circular dependencies are resolved, but it also almost doubles the
  180. build time.
  181. In former times this was recommended - but nowadays this is only a
  182. paranoia thing.
  183. SDECFG_DO_CHECK
  184. This options enables to run a make check / test target for packages
  185. with support for this. This can be used as extended quality assurance
  186. to make sure the resulting binaries work correct.
  187. SDECFG_OPT
  188. With this option, the type of optimisation can be selected.
  189. SDECFG_DEBUG
  190. Enable this option if you want to have debug symbols in your binaries.
  191. SDECFG_LIMITCXX
  192. Check here if you want to disable the C++ exceptions run-time type
  193. identification. This can make the C++ binaries about 25% smaller,
  194. but any C++ sources using exceptions or rtti, for example QT/KDE,
  195. will fail to compile. If you don't know, don't touch.
  196. SDECFG_MULTILIB
  197. Enable installing several versions of the same library.
  198. SDECFG_LD_AS_NEEDED
  199. Enabling this option will instruct the linker to only mark the shared
  200. objections as needed in the relevant ELF section that are referenced
  201. by the executable generated. This does often reduce the dependencies
  202. of a binary quite a lot and can help speeding up application start up
  203. time.
  204. Currently this feature is considered expermental and thus disabled by
  205. default.
  206. SDECFG_DISABLE_NLS
  207. Please check here if you do not want to use Native Language Support.
  208. SDECFG_CREATE_CACHE
  209. Please check here if you want to create *.cache files after a build
  210. has completed. This is the same as a reference build.
  211. SDECFG_PARANOIA_CHECK
  212. Please check here if you want to run sanity checks before building.
  213. THIS IS STRONGLY RECOMMENDED!
  214. SDECFG_IDCKSUM
  215. Please check here if you want to use a checksum instead of the long
  216. explanatory SDECFG-ID.