[CMake] Documentation request

[Tim Gallagher]

I like the idea of putting "new in #.#.#" when features are added, that would at least be an easy reminder on the documentation page that some things are not universal to 2.8.*. 

I also agree that it's not super clear that back documentation is available on the wiki. If you look at the documentation page, it says things like "Documentation for CMake 2.8", "Documentation for CMake 2.6" and then at the bottom under "Legacy Documentation for CMake" there is a section for CMake 2.4. 

To me that implies that 

A) documentation holds for all versions of 2.8.* or 2.6.* or 2.4.*;
B) there is only documentation for those versions and the wiki would hold other types of information (and if you just go to the main page of the wiki, there is no indication that old versions are documented, I had to search to find it).

So, I understand all to well how time consuming writing documentation is. And if space is an issue, how about the following:

A) Rename the links on the documentation page so that it says it is for the current version, so it would say "Documentation for CMake 2.8.7" when the next is released.
B) Under "Legacy Documentation", put a link to the CMake_Released_Versions page on the wiki to point people to that documentation. 

Does that sounds like a reasonable compromise? We've run into this frequently enough that I thought I'd bring it up, but as I said before, if we're the only ones who keep making these mistakes, then we can deal with it internally.

Tim

----- Original Message -----
From: "Renato Utsch" <renatoutsch at gmail.com>
To: cmake at cmake.org
Sent: Wednesday, December 21, 2011 8:38:27 AM
Subject: Re: [CMake] Documentation request

Yes, but is not so easy to find. It would be easier to have it in the
documentation page (if the page hosts CMake 2.6 or CMake 2.4
documentations, why it doesn't host CMake 2.8.3 documentation? They
should be on the wiki too!), easier to find.

Renato

2011/12/21 Michael Wild <themiwi at gmail.com>:
> As I already said, all the old documentation (back to version 1.6,
> AFAIK) is available on the wiki.
>
> Michael
>
> On 12/21/2011 01:12 PM, Renato Utsch wrote:
>>> You ?
>>> This represents a fair amount of work...
>>> I bet that if no-one did it it is because it's a hUGe task.
>>
>> Sorry, I am not that good with english, I meant as the CMake team with
>> 'you'. But the 'CMake team' could do that with new releases, like,
>> writing this warning with additions in the newer releases.
>>
>> Or, the easier way, to mantain different versions of the documentation
>> at the site. This is not difficult, maybe put the latest doc in the
>> "Documentation" page and down in the "see also" of the documentation a
>> link to the older ones, or maybe everything in the documentation
>> page...
>>
>> Renato
>>
>>
>>
>> 2011/12/21 Eric Noulard <eric.noulard at gmail.com>:
>>> 2011/12/21 Renato Utsch <renatoutsch at gmail.com>:
>>>> I had the same problem a yesterday (or the day before) with the
>>>> string( FIND ) command...
>>>>
>>>> I tried to find the cmake 2.8.4 docs but I couldn't.
>>>
>>> cmake command **itself** is able to spit out its documentation.
>>> So
>>>
>>> cmake --help-command string
>>>
>>> will give you the hopefully up to date doc of the currently used cmake.
>>> In the same way:
>>> cmake --help-full
>>> cmake --help-html
>>>
>>> will give you a doc similar to
>>> http://www.cmake.org/cmake/help/cmake-2-8-docs.html
>>>
>>> but for the currently used cmake.
>>>
>>>>  I think you should do it, or at least to issue a warning (in the documentation) in
>>>> every command that wasn't introduced in CMake 2.8.0...
>>>
>>> You ?
>>> This represents a fair amount of work...
>>> I bet that if no-one did it it is because it's a hUGe task.
>>>
>>> --
>>> Erk
>>> Membre de l'April - « promouvoir et défendre le logiciel libre » -
>>> http://www.april.org
>> --
>>
>> Powered by www.kitware.com
>>
>> Visit other Kitware open-source projects at http://www.kitware.com/opensource/opensource.html
>>
>> Please keep messages on-topic and check the CMake FAQ at: http://www.cmake.org/Wiki/CMake_FAQ
>>
>> Follow this link to subscribe/unsubscribe:
>> http://www.cmake.org/mailman/listinfo/cmake
>
> --
>
> Powered by www.kitware.com
>
> Visit other Kitware open-source projects at http://www.kitware.com/opensource/opensource.html
>
> Please keep messages on-topic and check the CMake FAQ at: http://www.cmake.org/Wiki/CMake_FAQ
>
> Follow this link to subscribe/unsubscribe:
> http://www.cmake.org/mailman/listinfo/cmake
--

Powered by www.kitware.com

Visit other Kitware open-source projects at http://www.kitware.com/opensource/opensource.html

Please keep messages on-topic and check the CMake FAQ at: http://www.cmake.org/Wiki/CMake_FAQ

Follow this link to subscribe/unsubscribe:
http://www.cmake.org/mailman/listinfo/cmake