yade-dev team mailing list archive

[Bruno Chareyre <bruno.chareyre@xxxxxxxxxxxxxxx>]

Hi Jérôme,
It sounds like a good idea to provide a pointer to CMakeLists.txt in 
this paragraph(*) yet there is no reason to remove the current doc, 
better update it.
Removing doc to show people they can read source code is not a very good 
direction in general, 99% of yade users have no interest in discovering 
cmake.
Personally, I'm also frequently going back to the install page (e.g. to 
check the syntax of a particular feature) and I'm happy that the info is 
not more clicks away from the info I need.

Further, the doc is also supposed to produce a self-contained printable 
document. If some content is removed from this document it is clearly a 
regression.

Bruno

(*) e.g. "(an updated list can be retrieved _here_)"

On 09/03/2018 02:51 PM, Jerome Duriez wrote:
> Hi,
>
> In the source installation doc [*] I'm proposing to directly point 
> towards https://github.com/yade/trunk/blob/master/CMakeLists.txt for a 
> list of compilation options, instead of having the paragraph "The 
> following options are available: [...]"
>
> In the current state, there are at least three possible compilation 
> options that are not listed in [*] but that do exist: 
> ENABLE_POTENTIAL_PARTICLES, ENABLE_DEFORM and ENABLE_OAR.
>
> By removing the "The following options are available" § from the 
> sphinx doc, the risk of such a out-of-sync situation would disappear 
> (and it would learn reader of the doc the existence/role of 
> CMakeLists.txt)
>
>
> (And there would only remain the difficulty to keep in-sync the 
> beginning of CMakeLists.txt with the tasks this file actually performs 
> ;-) )
>
>
> Thoughts ?
>
>
> [*] https://yade-dem.org/doc/installation.html#compilation
>
> ------
> Chargé de Recherche / Research Associate
> Irstea, RECOVER
> 3275 route de Cezanne – CS 40061 13182 Aix-en-Provence Cedex 5 FRANCE
> +33 (0)4 42 66 99 21
>
>
> _______________________________________________
> Mailing list: https://launchpad.net/~yade-dev
> Post to     : yade-dev@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~yade-dev
> More help   : https://help.launchpad.net/ListHelp