From be073f05241d0ba56f72e7bbb8671d27f8660766 Mon Sep 17 00:00:00 2001
From: Bernd Flemisch <bernd@iws.uni-stuttgart.de>
Date: Wed, 18 Sep 2019 15:24:02 +0200
Subject: [PATCH] [bin][doc] add usage messages for README.md-generating
scripts
---
bin/doc/cpp_to_md.sh | 14 ++++++++++++++
bin/doc/merge_cpp_and_md.sh | 18 ++++++++++++++----
2 files changed, 28 insertions(+), 4 deletions(-)
diff --git a/bin/doc/cpp_to_md.sh b/bin/doc/cpp_to_md.sh
index d892584a5b..aa9221440f 100644
--- a/bin/doc/cpp_to_md.sh
+++ b/bin/doc/cpp_to_md.sh
@@ -1,5 +1,19 @@
#!/bin/sh
+# check if help is needed
+if test "$1" = "--help" || test "$1" = "-help" \
+ || test "$1" = "help" || test "$1" = ""; then
+ echo ""
+ echo "USAGE: $0 FILENAME"
+ echo ""
+ echo "The argument should be a C++ header or source file."
+ echo "The file is converted to Markdown and forwarded to stdout."
+ echo "In particular, a C++ comment is converted to its content,"
+ echo "while normal code is put into corresponding Markdown code blocks."
+ echo "Supposed to be called by the script merge_cpp_and_md.sh."
+ exit 0
+fi
+
if [[ ${1: -3} == ".hh" ]]; then
sed '1,/#define/d' $1 >tmpfile
isheader=true
diff --git a/bin/doc/merge_cpp_and_md.sh b/bin/doc/merge_cpp_and_md.sh
index eec5a49f47..7696a889a9 100644
--- a/bin/doc/merge_cpp_and_md.sh
+++ b/bin/doc/merge_cpp_and_md.sh
@@ -1,9 +1,19 @@
#!/bin/sh
-# The arguments should be names of Markdown and/or C++ files.
-# The script loops through all arguments. If a Markdown file is encountered,
-# its content is forwarded to stdout. For another file, a Markdown header
-# stating the filename is printed and the script cpp_to_md.sh is applied.
+# check if help is needed
+if test "$1" = "--help" || test "$1" = "-help" \
+ || test "$1" = "help" || test "$1" = ""; then
+ echo ""
+ echo "USAGE: $0 FILENAME_1 [FILENAME_2 ...]"
+ echo ""
+ echo "The arguments should be names of Markdown and/or C++ files."
+ echo "The script loops through all arguments. If a Markdown file is encountered,"
+ echo "its content is forwarded to stdout. For another file, a Markdown header"
+ echo "stating the filename is printed and the script cpp_to_md.sh is applied."
+ echo "To be used for creating README.mds in the example folder. For example, by"
+ echo "bash $0 intro.md spatialparams.hh problem.hh main.cc results.md >README.md"
+ exit 0
+fi
for filename in "$@"
do
--
GitLab