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

implement remaining review comments from #2517

develop
Myk Taylor 2023-01-06 15:31:50 -08:00
parent 91df585bf8
commit 1a8f60c03b
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
6 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
Unescape Escape View File

@ -7,7 +7,6 @@
# any build folders # any build folders
build*/ build*/
!docs/dev/building/
nix nix
buntu buntu
build/VC2010 build/VC2010

14
docs/dev/building/Compile.rst → docs/dev/compile/Compile.rst
Unescape Escape View File

@ -89,8 +89,8 @@ assistance.
All Platforms All Platforms
============= =============
Before you can compile the code you'll need to configure your build with cmake. Some IDEs can do this, Before you can compile the code you'll need to configure your build with cmake. Some IDEs can do this,
but from command line is the usual way to do this; thought the windows section below points out some but from command line is the usual way to do this; thought the Windows section below points out some
windows batch files that can be used to avoid opening a terminal/command-prompt. Windows batch files that can be used to avoid opening a terminal/command-prompt.
You should seek cmake's documentation online or via ``cmake --help`` to see how the command works. See You should seek cmake's documentation online or via ``cmake --help`` to see how the command works. See
the `build-options` page for help finding the DFHack build options relevant to you. the `build-options` page for help finding the DFHack build options relevant to you.
@ -284,13 +284,13 @@ addition to the normal ``CC`` and ``CXX`` flags above::
export PATH=/usr/local/bin:$PATH export PATH=/usr/local/bin:$PATH
Docker Windows cross compiling from Linux
====== ==================================
.. highlight:: bash .. highlight:: bash
You can use docker to build DFHack for windows. These instructions were developed You can use docker to build DFHack for Windows. These instructions were developed
on a linux host system. on a Linux host system.
.. contents:: .. contents::
:local: :local:
@ -326,7 +326,7 @@ container. Inside the container, run the following commands::
dfhack-make dfhack-make
Inside the ``dfhack-*`` scripts there are several commands that set up the wine Inside the ``dfhack-*`` scripts there are several commands that set up the wine
server. Each invocation of a windows tool will cause wine to run in the container. server. Each invocation of a Windows tool will cause wine to run in the container.
Preloading the wineserver and telling it not to exit will speed configuration and Preloading the wineserver and telling it not to exit will speed configuration and
compilation up considerably (approx. 10x). You can configure and build DFHack compilation up considerably (approx. 10x). You can configure and build DFHack
with regular ``cmake`` and ``ninja`` commands, but your build will go much slower. with regular ``cmake`` and ``ninja`` commands, but your build will go much slower.

0
docs/dev/building/Dependencies.rst → docs/dev/compile/Dependencies.rst
Unescape Escape View File

29
docs/dev/building/Options.rst → docs/dev/compile/Options.rst
Unescape Escape View File

@ -29,13 +29,13 @@ Typical usage may look like::
configuration utility ``ccmake``. configuration utility ``ccmake``.
Generator Generator
--------- =========
For the uninitiated, the generator is what allows cmake to, of course, generate For the uninitiated, the generator is what allows cmake to, of course, generate
visual studio solution & project files, a makefile, or anything else. visual studio solution & project files, a makefile, or anything else.
Your selection of generator comes down to preference and availability. Your selection of generator comes down to preference and availability.
Visual Studio Visual Studio
============= -------------
To generate visual studio project files, you'll need to select a particular version of To generate visual studio project files, you'll need to select a particular version of
visual studio, and match that to your system's generator list viewed with ``cmake --help`` visual studio, and match that to your system's generator list viewed with ``cmake --help``
@ -44,7 +44,7 @@ example::
cmake .. -G "Visual Studio 17 2022" cmake .. -G "Visual Studio 17 2022"
Ninja Ninja
===== -----
The generally preferred build system where available. The generally preferred build system where available.
example:: example::
@ -52,8 +52,8 @@ example::
cmake .. -G Ninja cmake .. -G Ninja
Install Location Install Location
---------------- ================
This of course uses the default cmake variable. This is the location where DFHack will be installed.
Variable: ``CMAKE_INSTALL_PREFIX`` Variable: ``CMAKE_INSTALL_PREFIX``
@ -65,9 +65,9 @@ The path to df will of course depend on your system. If the directory exists it
recommended to use ``~/.dwarffortress`` to avoid permission troubles. recommended to use ``~/.dwarffortress`` to avoid permission troubles.
Build type Build type
---------- ==========
Release/Debug, this is the type of build you want. This controls what information This is the type of build you want. This controls what information about symbols and
about symbols and line numbers the debugger will have available to it. line numbers the debugger will have available to it.
Variable: ``CMAKE_BUILD_TYPE`` Variable: ``CMAKE_BUILD_TYPE``
@ -81,8 +81,9 @@ Options:
* RelWithDebInfo * RelWithDebInfo
Target architecture (32/64-bit) Target architecture (32/64-bit)
--------------------------------------- ===============================
If need 32-bit binaries or are looking to be explicit about building 64-bit. You can set this if you need 32-bit binaries or are looking to be explicit about
building 64-bit.
Variable: ``DFHACK_BUILD_ARCH`` Variable: ``DFHACK_BUILD_ARCH``
@ -96,7 +97,7 @@ Options:
* '64' (default option) * '64' (default option)
Library Library
------- =======
This will only be useful if you're looking to avoid building the library core, as it builds by default. This will only be useful if you're looking to avoid building the library core, as it builds by default.
Variable: ``BUILD_LIBRARY`` Variable: ``BUILD_LIBRARY``
@ -107,7 +108,7 @@ Usage::
cmake .. -DBUILD_LIBRARY=0 cmake .. -DBUILD_LIBRARY=0
Testing Testing
------- =======
Regression testing will be arriving in the future, but for now there are only tests written in lua. Regression testing will be arriving in the future, but for now there are only tests written in lua.
Variables: Variables:
@ -121,7 +122,7 @@ Usage::
cmake .. -DBUILD_TESTS=1 cmake .. -DBUILD_TESTS=1
Plugins Plugins
------- =======
If you're doing plugin development. If you're doing plugin development.
Variable: ``BUILD_PLUGINS`` Variable: ``BUILD_PLUGINS``
@ -134,7 +135,7 @@ Usage::
.. _building-documentation: .. _building-documentation:
Documentation Documentation
------------- =============
If you need to build documentation. Documentation can be built as HTML, and PDF, If you need to build documentation. Documentation can be built as HTML, and PDF,
but there are also plain text files generated for in-game. but there are also plain text files generated for in-game.

6
docs/dev/building/index.rst → docs/dev/compile/index.rst
Unescape Escape View File

@ -9,6 +9,6 @@ Those seeking to compile the source code for DFHack, and or plugins, can refer t
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
/docs/dev/building/Dependencies /docs/dev/compile/Dependencies
/docs/dev/building/Compile /docs/dev/compile/Compile
/docs/dev/building/Options /docs/dev/compile/Options

2
docs/dev/index.rst
Unescape Escape View File

@ -10,7 +10,7 @@ These are pages relevant to people developing for DFHack.
:maxdepth: 1 :maxdepth: 1
/docs/dev/Dev-intro /docs/dev/Dev-intro
/docs/dev/building/index /docs/dev/compile/index
/docs/dev/Contributing /docs/dev/Contributing
/docs/dev/Documentation /docs/dev/Documentation
/docs/api/index /docs/api/index