Skip to content

Commit

Permalink
Document setting <Project>_SHOW_GIT_COMMIT_PARENTS_DEFAULT in users/m…
Browse files Browse the repository at this point in the history
…aintainers guide (TriBITSPub#597)
  • Loading branch information
bartlettroscoe committed Jan 24, 2024
1 parent 3bed1f9 commit ba27309
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions tribits/doc/guides/TribitsCoreDetailedReference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ a given TriBITS project are:
* `${PROJECT_NAME}_MUST_FIND_ALL_TPL_LIBS`_
* `${PROJECT_NAME}_REQUIRES_PYTHON`_
* `${PROJECT_NAME}_SET_INSTALL_RPATH`_
* `${PROJECT_NAME}_SHOW_GIT_COMMIT_PARENTS`_
* `${PROJECT_NAME}_SHOW_TEST_START_END_DATE_TIME`_
* `${PROJECT_NAME}_SKIP_INSTALL_PROJECT_CMAKE_CONFIG_FILES`_
* `${PROJECT_NAME}_TEST_CATEGORIES`_
Expand Down Expand Up @@ -651,6 +652,21 @@ These options are described below.
Handling`_).


.. _${PROJECT_NAME}_SHOW_GIT_COMMIT_PARENTS:

**${PROJECT_NAME}_SHOW_GIT_COMMIT_PARENTS**

The cache variable ``${PROJECT_NAME}_SHOW_GIT_COMMIT_PARENTS`` results in
the repo version file showing the parent commits for each repo commit. By
default, this variable is set to ``OFF`` but projects can set to to ``ON``
by default by setting::

set(${PROJECT_NAME}_SHOW_GIT_COMMIT_PARENTS_DEFAULT ON)

in the project's ``ProjectName.cmake`` file. (That way, it will also impact
``cmake -P`` scripts don't configure the project itself to be built.)


.. _${PROJECT_NAME}_SHOW_TEST_START_END_DATE_TIME:

**${PROJECT_NAME}_SHOW_TEST_START_END_DATE_TIME**
Expand Down

0 comments on commit ba27309

Please sign in to comment.