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.

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