Skip to content

Commit

Permalink
edit FAQs
Browse files Browse the repository at this point in the history
  • Loading branch information
bast committed Jun 23, 2015
1 parent b9694d5 commit 046eeda
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions doc/autocmake-users-faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,16 @@ run ``setup.py`` directly and expect everything to just work (TM).
The update.py script is overwriting my CMakeLists.txt and setup.py, isn't this bad?
-----------------------------------------------------------------------------------

It's not so bad as it first looks. It's a feature. Normally ``CMakeLists.txt``
It's not as bad as it first looks. It's a feature. Normally ``CMakeLists.txt``
and ``setup.py`` should not contain any explicit customization and therefore should not
contain anything that could not be regenerated. In any case you should use
version control so that you can inspect and compare changes introduced to
``CMakeLists.txt`` and ``setup.py`` and possibly revert them. See also the next
remark.


But I need to manually edit and customize CMakeLists.txt and setup.py every time I run update.py
------------------------------------------------------------------------------------------------
But I need to manually edit and customize CMakeLists.txt and setup.py every time I run update.py!?
--------------------------------------------------------------------------------------------------

You typically never need to manually edit and customize ``CMakeLists.txt`` and
``setup.py`` directly. You can introduce customizations in ``autocmake.cfg``
Expand All @@ -43,3 +43,9 @@ and include the latter in ``autocmake.cfg`` using::

[src]
source: https://github.com/scisoft/autocmake/raw/master/modules/src.cmake

If you really don't like to do it this way, you can describe your sources and
targets in a custom module in a local file and include it like this::

[my_sources]
source: custom/my_sources.cmake

0 comments on commit 046eeda

Please sign in to comment.