Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
CMake
CMake
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,226
    • Issues 3,226
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Merge Requests 15
    • Merge Requests 15
  • CI / CD
    • CI / CD
    • Pipelines
    • Jobs
    • Schedules
  • Operations
    • Operations
    • Incidents
    • Environments
  • Packages & Registries
    • Packages & Registries
    • Container Registry
  • Analytics
    • Analytics
    • CI / CD
    • Repository
    • Value Stream
  • External Wiki
    • External Wiki
  • Members
    • Members
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • CMake
  • CMakeCMake
  • Issues
  • #19715

Closed
Open
Opened Sep 17, 2019 by Paul Dreik@pauldreik4 of 8 tasks completed4/8 tasks

Feature request: add "this feature was added in version xxx"

Hi, just want to start with saying that I think the cmake documentation is great!

I think it could be improved, at least for my use case (writing libraries and programs that others use, whose build environment I can't control).

When trying to follow good cmake practices, one sometimes fall into the trap of using something which isn't available in common older cmake versions. This means I can't use it, unless requiring all downstream users to use a fresh cmake. Sometimes that's perfectly fine, sometimes it isn't. To make that decision, it would be great if the documentation could say when the feature I try to use appears. Otherwise, I have to resort to binary search the documentation page which is not that fun.

A recent example I came across: https://cmake.org/cmake/help/latest/command/add_link_options.html

Ubuntu 18.04 which is very well spread not least on various continuous integration services uses cmake 3.10.2 and add_link_options appeared in 3.13.

If there could be a standard section, like "Appeared in", or "Available since" on the page, that would make it easy to ignore for those who are not interested, and easy to recognize for those who are.

Update with background info, thanks Craig:

  • wiki documentation for older cmake 2.x versions
  • #15222 (closed) from 2014, direct link very similar to this report
  • #15517 (closed) from 2015, direct link
  • #16150 (closed) from 2016
  • ml thread https://cmake.org/pipermail/cmake/2016-November/064492.html
  • ml thread https://cmake.org/pipermail/cmake/2016-April/063306.html

Thanks!

Paul


Tracking of Help/ subfolders for which version information added has been completed (work is spread across multiple MRs):

  • command
  • cpack_gen
  • generator
  • module
  • envvar
  • variable
  • prop_*
  • manual

The following subfolders are deemed not applicable and won't be updated:

  • dev
  • guide
  • include
  • policy
  • release
Edited Dec 03, 2020 by Craig Scott
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information
Assignee
Assign to
None
Milestone
None
Assign milestone
Time tracking
None
Due date
None
Reference: cmake/cmake#19715