-
-
Notifications
You must be signed in to change notification settings - Fork 295
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
grass7 manual: document --config parameters #532
Conversation
Adding missing `grass --config <option>` documentation Adresses #405 (review)
Actually, fixes #405 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
lib/init/grass7.html
Outdated
<li><b>build</b>: (e.g., <tt>./configure --with-cxx --enable-largefile --with-proj [...]</tt>)</li> | ||
<li><b>compiler</b>: (e.g., <tt>gcc</tt>)</li> | ||
<li><b>date</b>: (e.g., <tt>Tue Mar 31 20:34:57 2020 +0200</tt>)</li> | ||
<li><b>path</b>: (e.g., <tt>/usr/lib64/grass78</tt>)</li> | ||
<li><b>revision</b>: (e.g., <tt>745ee7ec9</tt>)</li> | ||
<li><b>svn_revision</b>: (e.g., <tt>062bffc8</tt>)</li> | ||
<li><b>version</b>: (e.g., <tt>7.9.dev</tt>)</li> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wait, I actually assumed in my previous comment that the answer is that this is WIP. I do get the same info from running the command, but I don't think people will guess what svn_revision
refers to. I'm not sure what it is now without checking the code.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We may mark svn_revision
here as deprecated.
It refers to VERSIONNUMBER
:
Line 2023 in b74dfd2
elif arg == 'svn_revision': |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@landam suggested libgis_revision
(but only in GRASS 8), see #405 (comment)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
VERSIONNUMBER which actually refers to ...? Whole include directory, i.e., the whole C/C++ API/ABI I guess. The other candidates I can think of are gis.h, libgrass_gis.so source code, or GRASS version.
We can add the new name now. We just have to keep the old one as @landam suggests.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@wenzeslaus I think adding a new config option libgis_revision
should be part of a different PR since Python code is involved.
If you rebase your branch to the latest master, your checks will work again (but it is not needed for this PR). |
Done and fine! |
* grass7 manual: document --config parameters Adding missing `grass --config <option>` documentation Adresses #405 (review) * fix double white space * fix version for consistency
Adding missing
grass --config <option>
documentationAdresses #405 (review)