yade-dev team mailing list archive

[Jerome Duriez <jerome.duriez@xxxxxxxxx>]

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