aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKoni Marti <koni.marti@gmail.com>2023-11-24 16:02:56 +0100
committerRobin Jarry <robin@jarry.cc>2023-12-30 15:42:09 +0100
commit60c1c7347ad88ad00fc0809acd10ddd31243acd3 (patch)
tree7c438a21c61f62ff1cb08450b06bb8bbd25dc2af
parentf75d4b7bb615df6c20546961870672c0f1680999 (diff)
downloadaerc-60c1c7347ad88ad00fc0809acd10ddd31243acd3.tar.gz
contrib: fix check-docs for subcommands
Fix check-docs linter for subcommands, i.e. where spaces are between the root command and the subcommands such as in ":patch init". Signed-off-by: Koni Marti <koni.marti@gmail.com> Acked-by: Robin Jarry <robin@jarry.cc>
-rwxr-xr-xcontrib/check-docs6
-rw-r--r--doc/aerc-jmap.5.scd6
-rw-r--r--doc/aerc-tutorial.7.scd2
3 files changed, 7 insertions, 7 deletions
diff --git a/contrib/check-docs b/contrib/check-docs
index dd783a82..bcc63213 100755
--- a/contrib/check-docs
+++ b/contrib/check-docs
@@ -5,7 +5,7 @@ trap "rm -f $tmp" EXIT
global_fail=0
-cmd_scd_sed='s/^\*:([a-z][a-z-]*)\*.*/\1/p'
+cmd_scd_sed='s/^\*:([a-z][a-z -]*)\*.*/\1/p'
cmd_go_sed='/^func ([[:alnum:]][[:alnum:]]*) Aliases() \[\]string {$/{n;
s/", "/ /g;
s/.*return \[\]string{"\(.*\)"}/\1/p
@@ -17,7 +17,7 @@ if echo . | grep --color . >/dev/null 2>&1; then
fi
fail=0
-sed -nre "$cmd_scd_sed" doc/*.scd > "$tmp"
+sed -nre "$cmd_scd_sed" doc/*.scd | tr ' ' '\n' > "$tmp"
for f in $(find commands -type f -name '*.go'); do
for cmd in $(sed -ne "$cmd_go_sed" "$f"); do
if ! grep -qFx "$cmd" "$tmp"; then
@@ -35,7 +35,7 @@ fi
fail=0
sed -ne "$cmd_go_sed" $(find commands -type f -name '*.go') | tr ' ' '\n' > "$tmp"
for f in doc/*.scd; do
- for cmd in $(sed -nre "$cmd_scd_sed" "$f"); do
+ for cmd in $(sed -nre "$cmd_scd_sed" "$f" | tr ' ' '\n' | sed '/^-/d;/^$/d'); do
if ! grep -qFx "$cmd" "$tmp"; then
grep -Hn $grep_color "^\\*:$cmd\\*" "$f"
fail=$((fail+1))
diff --git a/doc/aerc-jmap.5.scd b/doc/aerc-jmap.5.scd
index 77183a91..a420f345 100644
--- a/doc/aerc-jmap.5.scd
+++ b/doc/aerc-jmap.5.scd
@@ -92,9 +92,9 @@ are available:
virtual folder. The name of that folder can be configured via the
*all-mail* setting.
- *:archive flat* may still be used to effectively "tag" messages with the
+ *:archive* _flat_ may still be used to effectively "tag" messages with the
hidden _Archive_ mailbox so that they appear in the *all-mail* virtual
- folder. When the *all-mail* virtual folder is selected, *:archive flat*
+ folder. When the *all-mail* virtual folder is selected, *:archive* _flat_
should not be used and will have no effect. The messages will be grayed
out but will never be refreshed until aerc is restarted.
@@ -135,7 +135,7 @@ same thing than *:tag -<selected_folder>*.
*:mv <foo>* is a compound of *:delete* and *:mv* and can be seen as an alias of
*:tag -<selected_folder> +<foo>*.
-*:archive flat* is an alias for *:tag -<selected_folder> +<archive>*.
+*:archive* _flat_ is an alias for *:tag -<selected_folder> +<archive>*.
# SEE ALSO
diff --git a/doc/aerc-tutorial.7.scd b/doc/aerc-tutorial.7.scd
index 3c777d36..bffa39ff 100644
--- a/doc/aerc-tutorial.7.scd
+++ b/doc/aerc-tutorial.7.scd
@@ -8,7 +8,7 @@ aerc-tutorial - tutorial for *aerc*(1)
Welcome to aerc! This tutorial will guide you through your first steps in using
the client. This tutorial is a man page - you can read it again later with
-*:help tutorial* from aerc, or *man aerc-tutorial* from your terminal.
+*:help* _tutorial_ from aerc, or *man aerc-tutorial* from your terminal.
First, let's introduce some basic keybindings. For convention, we'll use *<C-p>*
to represent _Ctrl+p_, which matches the convention used for writing keybindings