Document disabling tests and examples in INSTALL.md #1918
Conversation
spacey-sooty
force-pushed
the
allow-disabling-tests-and-examples
branch
from
6b50276 to
2f2e557
Compare
When you have gtsam as a dependency in CMake these would get built. This doesn't make sense and increases build times, allowing them to be disabled fixes this. Signed-off-by: Jade Turner <spacey-sooty@proton.me>
spacey-sooty
force-pushed
the
allow-disabling-tests-and-examples
branch
from
2f2e557 to
ddd95f4
Compare
|
I think there was already a flag for building examples or not. Also, that flag shows the naming convention for compile time flags :-) |
|
Hi @spacey-sooty. You can set the following CMake variables to OFF to disable building tests and examples. GTSAM_BUILD_EXAMPLES_ALWAYS=OFF
GTSAM_BUILD_TESTS=OFFI agree that building examples takes a long time, so I have them disabled myself when compiling. |
I couldn't find this at all when searching through the documentation. Mentioning in there would be good. |
|
Yeah I agree. We have a lot of work to do wrt the docs. :) |
|
@spacey-sooty would you be willing to update this PR to instead make it a docs update with the flags above? I can approve and merge it then. |
This reverts commit ddd95f4.
|
Where would I find the docs in the repo? |
|
I would recommend adding it to the INSTALL.md file since it has other notes about CMake flags. |
Signed-off-by: Jade Turner <spacey-sooty@proton.me>
|
@varunagrawal I've pushed a new commit documenting it, my IDE has also caught some unused whitespace and fixed that but I can revert that if needed |
spacey-sooty
changed the title
|
Thank you so much! |
When you have gtsam as a dependency in CMake these would get built. This doesn't make sense and increases build times, allowing them to be disabled fixes this.