rename bootstrap to update
This commit is contained in:
@ -9,13 +9,13 @@ Autocmake assembles CMake modules, generates ``CMakeLists.txt`` as well as
|
||||
``setup.py``, which serves as a front-end to ``CMakeLists.txt``. All this is
|
||||
done based on a lightweight ``autocmake.cfg`` file::
|
||||
|
||||
bootstrap.py --update
|
||||
update.py --self
|
||||
|
|
||||
| fetches Autocmake infrastructure
|
||||
v
|
||||
autocmake.cfg
|
||||
|
|
||||
| bootstrap.py
|
||||
| update.py
|
||||
v
|
||||
CMakeLists.txt (and setup.py front-end)
|
||||
|
|
||||
|
@ -3,19 +3,19 @@
|
||||
Bootstrapping a new project
|
||||
===========================
|
||||
|
||||
Download the ``bootstrap.py`` and execute it to fetch other infrastructure files
|
||||
Download the ``update.py`` and execute it to fetch other infrastructure files
|
||||
which will be needed to build the project::
|
||||
|
||||
mkdir cmake # does not have to be called "cmake" - take the name you prefer
|
||||
cd cmake
|
||||
wget https://github.com/scisoft/autocmake/raw/master/bootstrap.py
|
||||
python bootstrap.py --update
|
||||
wget https://github.com/scisoft/autocmake/raw/master/update.py
|
||||
python update.py --self
|
||||
|
||||
This creates (or updates) the following files (an existing ``autocmake.cfg`` is
|
||||
not overwritten by the script)::
|
||||
|
||||
cmake/
|
||||
bootstrap.py # no need to edit
|
||||
update.py # no need to edit
|
||||
autocmake.cfg # edit this file
|
||||
lib/
|
||||
config.py # no need to edit
|
||||
|
@ -3,16 +3,16 @@
|
||||
Generating the CMake infrastructure
|
||||
===================================
|
||||
|
||||
Edit ``autocmake.cfg`` and run the ``bootstrap.py`` script which
|
||||
Edit ``autocmake.cfg`` and run the ``update.py`` script which
|
||||
creates ``CMakeLists.txt`` and ``setup.py`` in the build path::
|
||||
|
||||
python bootstrap.py ..
|
||||
python update.py ..
|
||||
|
||||
The script also copies or downloads CMake modules specified in ``autocmake.cfg`` to a directory
|
||||
called ``modules/``::
|
||||
|
||||
cmake/
|
||||
bootstrap.py
|
||||
update.py
|
||||
autocmake.cfg
|
||||
lib/
|
||||
config.py
|
||||
|
@ -3,7 +3,7 @@
|
||||
Customizing CMake modules
|
||||
=========================
|
||||
|
||||
The ``boostrap.py`` script assembles modules listed in ``autocmake.cfg`` and
|
||||
The ``update.py`` script assembles modules listed in ``autocmake.cfg`` and
|
||||
places them inside ``modules/``. You have at least four options to customize
|
||||
CMake modules:
|
||||
|
||||
@ -13,7 +13,7 @@ Directly inside the generated modules directory
|
||||
|
||||
The CMake modules can be customized directly inside ``modules/`` but this is
|
||||
the least elegant solution since the customizations may be overwritten by the
|
||||
``boostrap.py`` script (use version control).
|
||||
``update.py`` script (use version control).
|
||||
|
||||
|
||||
Adapt local copies of CMake modules
|
||||
|
@ -7,7 +7,7 @@ Autocmake
|
||||
:maxdepth: 2
|
||||
|
||||
about.rst
|
||||
bootstrap.rst
|
||||
update.rst
|
||||
cmakelists.rst
|
||||
customizing-modules.rst
|
||||
updating-modules.rst
|
||||
|
@ -3,13 +3,13 @@
|
||||
Updating CMake modules
|
||||
======================
|
||||
|
||||
To update CMake modules you need to run the ``boostrap.py`` script::
|
||||
To update CMake modules you need to run the ``update.py`` script::
|
||||
|
||||
cd cmake
|
||||
python bootstrap.py ..
|
||||
python update.py ..
|
||||
|
||||
The CMake modules are not fetched or updated at configure time or build time.
|
||||
In other words, if you never re-run ``boostrap.py`` script and never modify the
|
||||
In other words, if you never re-run ``update.py`` script and never modify the
|
||||
CMake module files, then the CMake modules will remain forever frozen.
|
||||
|
||||
|
||||
|
Reference in New Issue
Block a user