Add examples to build system #9
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Register examples as executables that are `EXCLUDED_FROM_ALL` (not built by default). * Add meta-target `examples` for building all examples. * Fix includes for all examples.
Add instructions for building examples.
|
Nice improvement, looks good. Thanks @peanutfun. I have checked it works fine. I have merged it as it is. |
|
I agree with your suggestions:
I have implemented it in PR #14 . |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Add the example source files as executables to the build system. This way, they can be easily built by executing
Why was this PR suggested?
The examples would so far need to be compiled with commands to the compiler after installing GiNaCDE. Since they are part of the repository, it improves usability if they are included in the build system. This way, users do not need to install GiNaCDE to build and execute (and possibly also modify) the examples.
Open questions
The
examples/folder also contains the output of the example executables. This can cause some issues as files that are produced by the code in a repository are often forgotten when updating the code. For example, the example files have been recently updated in aeeb00a, with some files being renamed, but the old files have not been removed. Once the examples are part of the regular build system, it might be enough to just keep one single output file in the repository as an example. All other example output files can be easily recreated locally by running all the examples.I needed to update the includes from
<GiNaCDE/GiNaCDE.h>to<GiNaCDE.h>for building the examples. This is against the instructions of the currentREADME.md, but in line with the pkg-config include directory settings, see my comment in Support and advertise usage in downstream build systems #8.Related issues
openjournals/joss-reviews#3885