Skip to content
Snippets Groups Projects

Add a BUILD_COOKBOOK cmake option to control cookbook build targets

Merged Manuel Grizonnet requested to merge add_build_cookbook_option into develop
All threads resolved!

Summary

Add a BUILD_COOKBOOK cmake option to control cookbook build targets

Rationale

In develop branch BUILD_DOCUMENTATION cmake option control the configuration of both Doxygen and Cookbook.

"BUILD_DOCUMENTATION: Build the documentation (Doxygen)." -> Define in an official cmake module (file /usr/share/cmake-3.10/Modules/Documentation.cmake on my system)

Don't think that it is a good idea to use BUILD_DOCUMENTATION to also build to cookbook (different dependencies, different targets)

I've added an advanced option BUILD_COOKBOOOK (off by default) to control the cookbook configuration process.

Should be done also for the software guide to have a similar build process for all the documentation.

Implementation Details

Additional notes

Copyright

The copyright owner is COPYRIGHT OWNER (OR OWNER'S AGENT) and has signed the ORFEO ToolBox Contributor License Agreement.


Check before merging:

  • All discussions are resolved
  • At least 2 :thumbsup: votes from core developers, no :thumbsdown: vote.
  • The feature branch is (reasonably) up-to-date with the base branch
  • Dashboard is green
  • Copyright owner has signed the ORFEO ToolBox Contributor License Agreement

Merge request reports

Approval is optional
Ready to merge by members who can write to the target branch.

Merge details

  • 5 commits and 1 merge commit will be added to develop.
  • Source branch will not be deleted.

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • because BUILD_DOCUMENTATION is marked as advanced. But I can change this. We don't have a clear policy about which cmake option should be marked as advanced IMO.

    I think that @rkanavath made some suggestions in the past about this particular point.

  • Victor Poughon resolved all discussions

    resolved all discussions

  • don't remember old discussion. But I would say use advanced only for variables that does not control build. such as LIBRARYNAMME_LIBRARIES. In this particular case, I don't know what is best for BUILD_COOKBOOK option.

  • Victor Poughon resolved all discussions

    resolved all discussions

  • Victor Poughon added 1 commit

    added 1 commit

    • a41e341a - ENH: BUILD_COOKBOOK cmake not advanced

    Compare with previous version

  • @mgrizonnet is on vacation this week. I removed mark_as_advanced.

  • Victor Poughon mentioned in commit a342884b

    mentioned in commit a342884b

  • Thanks @poughov !!

  • Please register or sign in to reply
    Loading