Configuring Build Options - Revision history

Alexwolf: /* USE_PLUGIN_* */

2013-01-27T18:09:02Z

USE_PLUGIN_*

Alexwolf: /* USE_PLUGIN_* */

2013-01-27T07:38:35Z

USE_PLUGIN_*

Daggerstab: /* Make targets */

2012-10-28T15:54:34Z

Make targets

Daggerstab at 15:43, 28 October 2012

2012-10-28T15:43:26Z

Daggerstab: copyediting

2012-10-28T15:28:11Z

copyediting

Alexwolf: /* Introduction */

2012-08-11T11:24:44Z

Introduction

Alexwolf: /* Introduction */

2012-08-11T11:23:54Z

Introduction

Alexwolf at 11:12, 11 August 2012

2012-08-11T11:12:42Z

Alexwolf: /* ENABLE_STRATOSCRIPT_COMPAT */

2012-08-11T11:11:17Z

ENABLE_STRATOSCRIPT_COMPAT

Alexwolf at 10:45, 11 August 2012

2012-08-11T10:45:42Z

@@ Line 132: / Line 132: @@
 ;USE_PLUGIN_EXOPLANETS: (Default value: '''1''') The Exoplanets plugin.
 ;USE_PLUGIN_OBSERVABILITY: (Default value: '''1''') The Observability Analysis plugin.
-;USE_PLUGIN_RENDERSTATISTICS: (Default value: '''0''') The Renderer Statistics plugin.
+;USE_PLUGIN_RENDERERSTATISTICS: (Default value: '''0''') The Renderer Statistics plugin.
 ==Make targets==

@@ Line 131: / Line 131: @@
 ;USE_PLUGIN_PULSARS: (Default value: '''1''') The Pulsars plugin.
 ;USE_PLUGIN_EXOPLANETS: (Default value: '''1''') The Exoplanets plugin.
 ==Make targets==

@@ Line 134: / Line 134: @@
 ==Make targets==
-===install===
+Make groups various tasks as "targets". Starting <code>make</code> without any arguments causes make to build the default target - in our case, building Stellarium, its tests, the localization files, etc.
-This option make installation of binaries and related files (installation of program).
-===test===
+To list all possible targets, use the "help" target:
-This option launched tests from test suite.
+ make help
-===macosx_bundle===
+Other useful targets:
-This option make bundle package for Mac OS X.
-===package===
+ make install
 This option make package for Linux.
 [[Category: Development]]
 [[Category: Customization]]

@@ Line 113: / Line 113: @@
 ===USE_PLUGIN_*===
-This option is used to build the desired plugin from source. There will be one entry for each plugin being built. For example to build the Historical Supernovae plugin you need use ''USE_PLUGIN_SUPERNOVAE=1''.
+These options control whether the given plugin is built. For example to build the Historical Supernovae plugin you need use ''USE_PLUGIN_SUPERNOVAE=1''.
-Examples of the current default settings;
+;USE_PLUGIN_HELLOSTELMODULE: (Default value: '''0''') The Hello StelModule example plugin.
+;USE_PLUGIN_ANGLEMEASURE: (Default value: '''1''') The Angle Measure plugin.
-====*_HELLOSTELMODULE====
+;USE_PLUGIN_COMPASSMARKS: (Default value: '''1''') The Compass Marks plugin.
-''Default value'': '''0'''.
+;USE_PLUGIN_SATELLITES: (Default value: '''1''') The Satellites plugin.
+;USE_PLUGIN_TELESCOPECONTROL: (Default value: '''1''') The Telescope Control plugin.
-This option defines that the HelloStelModule plugin should be built.
+;USE_PLUGIN_LOGBOOK: (Default value: '''0''') The Logbook plugin - unfinished, development suspended indefinitely.
+;USE_PLUGIN_OCULARS: (Default value: '''1''') The Oculars plugin.
-====*_ANGLEMEASURE====
+;USE_PLUGIN_SVMT: (Default value: '''0''') The [https://launchpad.net/svmt Survey Monitoring and Visualization Tool], a plug-in for professional astronomers developed separately from Stellarium. (I.e. its code is not in the main repository.)
-''Default value'': '''1'''.
+;USE_PLUGIN_TEXTUSERINTERFACE: (Default value: '''1''') The Text User Interface plugin.
+;USE_PLUGIN_TIMEZONECONFIGURATION: (Default value: '''1''') The Time Zone plugin.
-This option defines that the Angle Measure plugin should be built.
+;USE_PLUGIN_VIRGO: (Default value: '''0''') [https://launchpad.net/virgo VirGO], a plug-in for professional astronomers developed separately from Stellarium. (I.e. its code is not in the main repository.)
+;USE_PLUGIN_SOLARSYSTEMEDITOR: (Default value: '''1''') The Solar System Editor plugin.
-====*_COMPASSMARKS====
+;USE_PLUGIN_SUPERNOVAE: (Default value: '''1''') The Historical Supernovae plugin.
-''Default value'': '''1'''.
+;USE_PLUGIN_QUASARS: (Default value: '''1''') The Quasars plugin.
+;USE_PLUGIN_PULSARS: (Default value: '''1''') The Pulsars plugin.
-This option defines that the Compass Marks plugin should be built.
+;USE_PLUGIN_EXOPLANETS: (Default value: '''1''') The Exoplanets plugin.
-−
-====*_SATELLITES====
-''Default value'': '''1'''.
-−
-This option defines that the Satellites plugin should be built.
-−
-====*_TELESCOPECONTROL====
-''Default value'': '''1'''.
-−
-This option defines that the Telescope Control plugin should be built.
-−
-====*_LOGBOOK====
-''Default value'': '''0'''.
-−
-This option defines that the LogBook plugin should be built.
-−
-====*_OCULARS====
-''Default value'': '''1'''.
-−
-This option defines that the Oculars plugin should be built.
-−
-====*_SVMT====
-''Default value'': '''0'''.
-−
-This option defines that the SVMT plugin should be built. Note: special dependancies and source are required for this option
-−
-====*_TEXTUSERINTERFACE====
-''Default value'': '''1'''.
-−
-This option defines that the Text User Interface plugin should be built.
-−
-====*_TIMEZONECONFIGURATION====
-''Default value'': '''1'''.
-−
-This option defines that the Time Zone Configuration plugin should be built.
-−
-====*_VIRGO====
-''Default value'': '''0'''.
-−
-This option defines that the VirGO plugin should be built. Note: special dependancies and source are required for this option
-−
-====*_SOLARSYSTEMEDITOR====
-''Default value'': '''1'''.
-−
-This option defines that the Solar System Editor plugin should be built.
-−
-====*_SUPERNOVAE====
-''Default value'': '''1'''.
-−
-This option defines that the Historical Supernovae plugin should be built.
-−
-====*_QUASARS====
-''Default value'': '''1'''.
-−
-This option defines that the Quasars plugin should be built.
-−
-====*_PULSARS====
-''Default value'': '''1'''.
-−
-This option defines that the Pulsars plugin should be built.
-−
-====*_EXOPLANETS====
-''Default value'': '''1'''.
-−
-This option defines that the Exoplanets plugin should be built.
 ==Make targets==

@@ Line 1: / Line 1: @@
-==Introduction==
+On all platforms, Stellarium uses a two-step building process:
-First part of this document (Configuring Build Options) is to explain the functions of the CMakeLists.txt file which is used to generate the build environment and the write the instructions to the CMakeCache file. The CMakeCache.txt file is then used as a menu for CMake to generate the executeable file and libraries then prepare a package for distribution. It is a universal file designed to be used with the main operating systems of Windows, Mac OS X, Linux and BSD.
+* <tt>[http://www.cmake.org/ CMake]</tt> processes a set of project files (<tt>CMakeLists.txt</tt>) to generate a set of scripts for <tt>make</tt> (if you are using Qt Creator, it runs CMake when you open the project);
-You can use configuring build options as CLI parameters for CMake. For example next command configure Stellarium for building binary (development edition) for Windows in Release mode which based on revision 5520:
+This page explains the various command-line options that can be passed to <tt>CMake</tt> and <tt>make</tt> to produce different build configurations.
-  cmake -G "MSYS Makefiles" -DCMAKE_INSTALL_PREFIX=C:/stellarium -DCMAKE_BUILD_TYPE=Release -DRELEASE_BUILD=0 -DBZR_REVISION=5520 ../..
-For example next command will be generate the configuration for Windows release package:
+== CMake options ==
-  cmake -G "MSYS Makefiles" -DCMAKE_INSTALL_PREFIX=C:/stellarium -DCMAKE_BUILD_TYPE=Release -DSTELLARIUM_SPLASH=Release ../..
-Second part of this document (Build Options) is to explain the functions for the make command.
+The proper way to change the options is to pass them to CMake on the command line, instead of editing directly the CMakeCache file. This way, the make files will be updated in case there is some hidden dependency on the value of the option you are passing.
-==Configuring Build Options==
+For example, the next command is a first invocation of CMake for Stellarium that configures the build of a development version for Windows in Release mode which based on revision 5520:
-These are the options that can be user set and will be written to the cmakecache.txt file to personalise the software package. The default  file is generated by the cmakelist.txt and written to the build folder. It can be edited with a text editor at any time to make specific changes to the  compiling routine.
+  cmake -G "MSYS Makefiles" -DCMAKE_INSTALL_PREFIX=C:/stellarium -DCMAKE_BUILD_TYPE=Release -DRELEASE_BUILD=0 -DBZR_REVISION=5520 ../..
-Information contained in the cmakecache.txt file will be used to generate the cmake_install.cmake file that will be specific to the users system and set the install parameters for the package generation.
+Qt Creator provides a wrapper around CMake - the CMake Wizard. It is automatically launched when Stellarium's CMakeLists.txt is opened for the first time, and it can be launched at any time from the "Build" -> "Run CMake" menu.
 ===BUILD_FOR_MAEMO===
@@ Line 38: / Line 38: @@
 ''Default value'': '''Debug'''
-====MinSizeRel====
+Possible values:
-This option is enabled in the release mode - binary package with minimized size of package.
+;Release:Release mode - the binary package does not include debug characters and some of the source code is ignored; this mode is the default for users.
 ===CMAKE_INSTALL_PREFIX===
@@ Line 206: / Line 197: @@
 This option defines that the Exoplanets plugin should be built.
-==Build Options==
+==Make targets==
 ===install===

@@ Line 87: / Line 87: @@
 This option set a type of GUI for using in Stellarium.
 ===OPTIMIZE_INTEL_ATOM===
@@ Line 189: / Line 196: @@
 This option defines that the Exoplanets plugin should be built.
 ==Build Options==

← Older revision		Revision as of 11:11, 11 August 2012
Line 80:		Line 80:

	This option enable the StratoScript compatibility mode. If set to 1 many of the old *.sts scripts can be used.		This option enable the StratoScript compatibility mode. If set to 1 many of the old *.sts scripts can be used.
		+
		+	===GUI_MODE===
		+	Possible values: Standard, None, External
		+
		+	''Default value'': '''Standard'''.
		+
		+	This option set a type of GUI for using in Stellarium.

	===OPTIMIZE_INTEL_ATOM===		===OPTIMIZE_INTEL_ATOM===

@@ Line 6: / Line 6: @@
 Information contained in the cmakecache.txt file will be used to generate the cmake_install.cmake file that will be specific to the users system and set the install parameters for the package generation.
 ===CMAKE_BUILD_TYPE===
@@ Line 37: / Line 55: @@
 ===CMAKE_CXX_COMPILER===
 This option sets a custom path to the C++ compiler. For example; if you have installed GCC and Clang; to use the Clang compiler you need use ''CMAKE_CXX_COMPILER=/usr/bin/clang''
 ===ENABLE_NLS===
@@ Line 72: / Line 80: @@
 This option enable the StratoScript compatibility mode. If set to 1 many of the old *.sts scripts can be used.
 ===RELEASE_BUILD===
@@ Line 78: / Line 91: @@
 This option flags the build as an official release.
-===BZR_REVISION===
+===STELLARIUM_SPLASH===
-This option is used together with RELEASE_BUILD option and sets Bazaar's revision for package.
+Possible values: Development, ReleaseCandidate, Release
-===BUILD_STATIC_PLUGINS===
+''Default value'': '''Development'''.
-''Default value'': '''1'''.
-This option defines that plugins should be compiled statically and linked to the main program. ''If this option has value '''1''' then for BUILD_DYNAMIC_PLUGINS should be value '''0'''.''
+This option set the splash screen for Stellarium.
-−
-===BUILD_DYNAMIC_PLUGINS===
-''Default value'': '''0'''.
-−
-This option defines that plugins should be compiled dynamically. ''If this option has value '''1''' then for BUILD_STATIC_PLUGINS should be value '''0'''.''
 ===USE_PLUGIN_*===