Skip to content
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

Merged
merged 3 commits into from
Apr 26, 2020
Merged

grass7 manual: document --config parameters #532

merged 3 commits into from
Apr 26, 2020

Conversation

neteler
Copy link
Member

@neteler neteler commented Apr 21, 2020

Adding missing grass --config <option> documentation

Adresses #405 (review)

Adding missing `grass --config <option>` documentation

Adresses #405 (review)
@neteler neteler added enhancement New feature or request backport_needed labels Apr 21, 2020
@neteler neteler added this to the 7.8.3 milestone Apr 21, 2020
@neteler
Copy link
Member Author

neteler commented Apr 21, 2020

Actually, fixes #405

Copy link
Member

@ninsbl ninsbl left a 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 Show resolved Hide resolved
lib/init/grass7.html Outdated Show resolved Hide resolved
Comment on lines 120 to 126
<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>
Copy link
Member

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.

Copy link
Member Author

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:

elif arg == 'svn_revision':

Copy link
Member Author

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)

Copy link
Member

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.

Copy link
Member Author

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.

@wenzeslaus
Copy link
Member

If you rebase your branch to the latest master, your checks will work again (but it is not needed for this PR).

lib/init/grass7.html Outdated Show resolved Hide resolved
@landam landam requested a review from wenzeslaus April 25, 2020 12:40
@neteler
Copy link
Member Author

neteler commented Apr 25, 2020

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!
I'd rather merge now, code change wishes may go into a separate PR.

@neteler neteler merged commit dadcbaf into OSGeo:master Apr 26, 2020
@neteler neteler deleted the grass7_man_config_doc branch April 26, 2020 16:08
neteler added a commit that referenced this pull request Apr 26, 2020
* grass7 manual: document --config parameters

Adding missing `grass --config <option>` documentation

Adresses #405 (review)

* fix double white space

* fix version for consistency
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants