commit be103d67264032cd8aec8c4b95604c4298b849ae
parent 9b90b5eb45fbe7016666364686d50e6d95dd7ddf
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Tue, 5 Sep 2023 16:40:29 +0200
Small update of the les2htcp.1 man page
Add a cross-reference to the htrdr manual page. Note that as this man
page is not installed in mandoc's default search path, it issues a
warning and returns 1 when checking file compliance. This generated an
error at the Makefile invocation when invoking the lint target. This
commit corrects this problem by accepting all mandoc return codes less
than or equal to 1, which corresponds to "at least one violation of the
base system convention or style suggestion has occurred, but no warning
or error" (extract from the mandoc manual "EXIT STATUS").
Diffstat:
2 files changed, 5 insertions(+), 3 deletions(-)
diff --git a/Makefile b/Makefile
@@ -138,8 +138,8 @@ lint:
shellcheck -o all src/dump_netcdf_data.sh
shellcheck -o all src/dump_netcdf_desc.sh
shellcheck -o all src/test_htcp_load_from_file.sh
- mandoc -Tlint -Wall les2htcp.1
- mandoc -Tlint -Wall htcp.5
+ mandoc -Tlint -Wall les2htcp.1 || [ $$? -le 1 ]
+ mandoc -Tlint -Wall htcp.5 || [ $$? -le 1 ]
################################################################################
# Tests
diff --git a/les2htcp.1 b/les2htcp.1
@@ -160,6 +160,7 @@ option to disable file conversion:
.Pp
.Dl les2htcp -c -i clouds.nc -q
.Sh SEE ALSO
+.Xr htrdr 1
.Xr sysconf 3 ,
.Xr htcp 5
.Sh STANDARDS
@@ -171,4 +172,5 @@ netCDF4/HDF5 file format.
.Sh HISTORY
.Nm
has been developed to generate cloud properties as input to the
-htrdr program.
+.Xr htrdr 1
+program.
