Skip to content

Commit c737feb

Browse files
Ozaqclaude
andcommitted
Fix doc review findings
Users following the info.rst example would get an error because --config is not a valid flag; fix to --config-file. The ecbuild URL in requirements.rst was empty. The install command passed both --prefix and -DCMAKE_INSTALL_PREFIX, which contradict each other and confuse newcomers; drop the redundant CMake variable. The CLI index table listed "grib2fdb" but the binary is grib2fdb5; align the table so users can find the tool. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 4c977ec commit c737feb

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

docs/fdb/cli_tools/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ General Purpose Tools
6060
- Delete FDB databases and the data they contain.
6161
* - :doc:`fdb write <write>`
6262
- Insert data into the FDB, creating databases as needed.
63-
* - :doc:`grib2fdb <grib2fdb>`
63+
* - :doc:`grib2fdb5 <grib2fdb>`
6464
- Insert GRIB data into the FDB (legacy tool).
6565

6666
Special Purpose Tools

docs/fdb/cli_tools/info.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,5 @@ Get location of FDB schema file in an easily parsable form:
6060
Get location of current FDB configuration file in an easily parsable form:
6161
::
6262
63-
% fdb info --config
63+
% fdb info --config-file
6464
<path>/testcases/fdb5/fdb5_simple.yaml

docs/fdb/content/installation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Now proceed with installation as follows:
2222
cd $builddir
2323

2424
# 2. Run CMake
25-
ecbuild --prefix=$installdir -- -DCMAKE_INSTALL_PREFIX=</path/to/installations> $srcdir
25+
ecbuild --prefix=$installdir -- $srcdir
2626
2727
# 3. Compile / Install
2828
make -j10

docs/fdb/content/requirements.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ Runtime dependencies:
1111
Build dependencies:
1212

1313
:CMake: For use and installation see http://www.cmake.org/
14-
:ecbuild: ECMWF library of CMake macros ()
14+
:ecbuild: ECMWF library of CMake macros (https://github.com/ecmwf/ecbuild)

0 commit comments

Comments
 (0)