[CMake] Manual version vs CMake version

[Mateusz Loskot]

Philip Lowman wrote:
> On Fri, Feb 5, 2010 at 4:31 PM, Mateusz Loskot <mateusz at loskot.net> wrote:
>> Bill Hoffman wrote:
>>> Eric Noulard wrote:
>>>
>>>> That's true, may be the site could indicate that the doc is for latest
>>>> 2.6.x serie.
>>>> However the most trustfull way to check the doc of your current cmake
>>>> version is the command line.
>>>>
>>>> cmake --help-command if
>>>>
>>>> should give you the doc for the cmake version you are using.
>>>>
>>>> if you want html you can use:
>>>>
>>>> cmake --help-html > cmake-doc.html
>>>>
>>>> then browse the cmake-doc.html file.
>>> Or cmake --version.
>> Yes, all this is true and I've managed to find a solution myself quite
>> easily, but I've posted as from position of an average
>> (read, rather lazy) user who preferes pretty website to read doc
>> than dark console  :-)
> 
> Also, it might not be a bad idea to mention the version number within
> the documentation when features are added, especially if features are
> going to be added during a patch release.
> 
> The same should probably be true of new find modules.

Yes, I also think it would be a good idea, though may be a hassle
for maintainers.

An alternative option would be to link to ChangeLog [1] in first words
of the documentation and emphasise features may be added between patch
releases. For instance, one of entries for 2.6.2 RC4 says:
- Add VERSION compare to if command

[1] http://www.cmake.org/files/v2.6/CMakeChangeLog-2.6.4

Best regards,
-- 
Mateusz Loskot, http://mateusz.loskot.net
Charter Member of OSGeo, http://osgeo.org