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.

Sign up for GitHub

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

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c985e9d
grass7 manual: document --config parameters
neteler Apr 21, 2020
bfd4abc
fix double white space
neteler Apr 21, 2020
e53dac7
fix version for consistency
neteler Apr 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 22 additions & 6 deletions lib/init/grass7.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ <h3>Flags:</h3>
(<em><a href="wxGUI.html">wxGUI</a></em>) should be used

<dt><b>--config</b>
<dd> Prints GRASS configuration parameters (options: arch, build, compiler, path, revision)
<dd> Prints GRASS configuration parameters (options: arch, build, compiler, date, path, revision, svn_revision, version)

<dt><b>--exec EXECUTABLE</b>
<dd> Execute GRASS module or script. The provided executable will be executed in a GRASS GIS non-interactive session.
Expand Down Expand Up @@ -110,6 +110,23 @@ <h2>DESCRIPTION</h2>
these checks fail then <em>grass79</em> will automatically switch back
to the text user interface mode.

<h2>FLAGS</h2>

The flag <b>--config option</b> prints GRASS GIS configuration and
version parameters, with the options:

<ul>
<li><b>arch</b>: system architecture (e.g., <tt>x86_64-pc-linux-gnu</tt>)</li>
<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>
neteler marked this conversation as resolved.
Show resolved Hide resolved
<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:

grass/lib/init/grass.py

Line 2023 in b74dfd2

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.

</ul>


<h2>SAMPLE DATA</h2>

The GRASS GIS project provides several free sample geospatial datasets
Expand Down Expand Up @@ -461,11 +478,10 @@ <h2>SEE ALSO</h2>
List of <a href="variables.html">GRASS environment variables</a>

<p>
<a href="http://grass.osgeo.org">GRASS GIS Web site</a><br>
<a href="http://grass.osgeo.org/wiki/">GRASS GIS User Wiki</a><br>
<a href="http://trac.osgeo.org/grass/">GRASS GIS Bug Tracker</a><br>
neteler marked this conversation as resolved.
Show resolved Hide resolved
<a href="http://grass.osgeo.org/programming7/">GRASS GIS 7 Programmer's
Manual</a>
<a href="https://grass.osgeo.org">GRASS GIS Web site</a><br>
<a href="https://grasswiki.osgeo.org/wiki/">GRASS GIS User Wiki</a><br>
<a href="https://github.com/OSGeo/grass/issues">GRASS GIS Bug Tracker</a><br>
<a href="https://grass.osgeo.org/programming7/">GRASS GIS 7 Programmer's Manual</a>

<h2>AUTHORS (of this page)</h2>

Expand Down