MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Mention DFHACK_BUILD_ARCH and other settings in Compile.rst

develop
lethosor 2016-10-08 16:57:33 -04:00
parent a5338d2f59
commit d414e60ff0
1 changed files with 31 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/Compile.rst
Unescape Escape View File

@ -33,8 +33,8 @@ To get the latest development code (develop branch), clone as above and then::
**Important note regarding submodule update and changing branches**: **Important note regarding submodule update and changing branches**:
You must run ``git submodule update`` every time you change Git branch, You must run ``git submodule update`` every time you change branches,
for example when switching between master and develop branches and back. such as when switching between the master and develop branches or vice versa.
If a submodule only exists on the newer branch, you also need to run If a submodule only exists on the newer branch, you also need to run
``git submodule update --init``. Failure to do this may result in strange ``git submodule update --init``. Failure to do this may result in strange
build errors or "not a known DF version" errors. build errors or "not a known DF version" errors.
@ -67,8 +67,12 @@ For lots more details on contributing to DFHack, including pull requests, code f
and more, please see `contributing-code`. and more, please see `contributing-code`.
Build types Build settings
=========== ==============
Build type
----------
``cmake`` allows you to pick a build type by changing the ``CMAKE_BUILD_TYPE`` variable:: ``cmake`` allows you to pick a build type by changing the ``CMAKE_BUILD_TYPE`` variable::
cmake .. -DCMAKE_BUILD_TYPE:string=BUILD_TYPE cmake .. -DCMAKE_BUILD_TYPE:string=BUILD_TYPE
@ -78,8 +82,30 @@ Without specifying a build type or 'None', cmake uses the
Valid and useful build types include 'Release', 'Debug' and Valid and useful build types include 'Release', 'Debug' and
'RelWithDebInfo'. 'RelWithDebInfo'.
'Debug' is not available on Windows, use 'RelWithDebInfo' instead. 'Debug' is not available on Windows; use 'RelWithDebInfo' instead.
Target architecture (32-bit vs. 64-bit)
---------------------------------------
Set DFHACK_BUILD_ARCH to either ``32`` or ``64`` to build a 32-bit or 64-bit
version of DFHack (respectively). The default is currently ``32``, but this may
change, so specifying it explicitly is a good idea.
::
cmake .. -DDFHACK_BUILD_ARCH=32
*or*
::
cmake .. -DDFHACK_BUILD_ARCH=64
Other settings
--------------
There are a variety of other settings which you can find in CMakeCache.txt in
your build folder or by running ``ccmake`` (or another CMake GUI). Most
DFHack-specific settings begin with ``BUILD_`` and control which parts of DFHack
are built.
Linux Linux
===== =====