Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How to deal with autocmake files in user's project ? #8

Closed
miroi opened this issue Jun 22, 2015 · 3 comments
Closed

How to deal with autocmake files in user's project ? #8

miroi opened this issue Jun 22, 2015 · 3 comments

Comments

@miroi
Copy link
Contributor

miroi commented Jun 22, 2015

Hi,
finally I adapted the autocmake for building my simple (github) project.

Should autocmake-user include all autocmake's files into his project's repository ? What is the recommended approach ? The "cmake/" directory and the setup.py script are more-less stable (as "pure" autocmake stuff), only the CMakeLists.txt undergoes heavy changes.

Because all important files are in the "cmake/" directory, maybe on should version only the "cmake/" folder ?

milias@login.grid.umb.sk:~/Work/qch/software/autocmake_devel/sec_quant_F90_autocmake/.git status 
# On branch autocmake
# Untracked files:
#   (use "git add <file>..." to include in what will be committed)
#
#   CMakeLists.txt
#   cmake/
#   setup.py
nothing added to commit but untracked files present (use "git add" to track)
milias@login.grid.umb.sk:~/Work/qch/software/autocmake_devel/sec_quant_F90_autocmake/.
@bast
Copy link
Member

bast commented Jun 22, 2015

What I do is to include/track all generated files. The reason for this is that when
you distribute your code to users/colleagues you probably don't want them to go through
the Autocmake steps but they will run setup.py directly and expect everything to just work (TM).
Ideally the end-user does not have to run any Autocmake scripts.

@miroi
Copy link
Contributor Author

miroi commented Jun 22, 2015

Fine, good approach - versioning all autocmake's generated files and leaning on setup.py only.

Your answer could go into the documentation (into FAQs ?), after that one could close this issue.

@bast
Copy link
Member

bast commented Jun 22, 2015

I agree. This should go to FAQs.

@bast bast closed this as completed in feafd11 Jun 23, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants