From c9a886c396e7fc064b3b0dc4e807dff7d28afb1f Mon Sep 17 00:00:00 2001
From: Dirk Wetter
Date: Sat, 15 Nov 2025 13:31:42 +0100
Subject: [PATCH] Update docs after riing only swicth
see #2945
---
doc/testssl.1 | 10 ++++++++--
doc/testssl.1.html | 6 +++++-
2 files changed, 13 insertions(+), 3 deletions(-)
diff --git a/doc/testssl.1 b/doc/testssl.1
index 52dd0f7..f864770 100644
--- a/doc/testssl.1
+++ b/doc/testssl.1
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pandoc 3.8.1
+.\" Automatically generated by Pandoc 3.8.2.1
.\"
.TH "" "" "" ""
.SS NAME
@@ -436,6 +436,10 @@ Internally they will be added during runtime to all CA stores.
This is (only) useful for internal hosts whose certificates are issued
by internal CAs.
Alternatively ADDTL_CA_FILES is the environment variable for this.
+.PP
+\f[CR]\-\-rating\-only\f[R] makes testssl.sh do the bare minimum to
+allow rating to succeed.
+See RATING for more
.SS SINGLE CHECK OPTIONS
Any single check switch supplied as an argument prevents testssl.sh from
doing a default run.
@@ -1258,7 +1262,9 @@ set_grade_warning \(dqDocumentation is always right\(dq
When implementing a new check (be it vulnerability or not) that sets
grade caps, the \f[CR]set_rating_state()\f[R] has to be updated
(i.e.\ the \f[CR]$do_mycheck\f[R] variable\-name has to be added to the
-loop, and \f[CR]$nr_enabled\f[R] if\-statement has to be incremented)
+loop, and \f[CR]$nr_enabled\f[R] if\-statement has to be incremented),
+and the \f[CR]\-\-rating\-only\f[R] switch statement needs to have
+\f[CR]$do_mycheck=true\f[R] added
.PP
The \f[CR]set_rating_state()\f[R] automatically disables rating, if all
the required checks are \f[I]not\f[R] enabled.
diff --git a/doc/testssl.1.html b/doc/testssl.1.html
index 3b581e8..8f1fa60 100644
--- a/doc/testssl.1.html
+++ b/doc/testssl.1.html
@@ -413,6 +413,8 @@
hosts whose certificates are issued by internal CAs.
Alternatively ADDTL_CA_FILES is the environment variable for
this.
+ --rating-only makes testssl.sh do the bare
+ minimum to allow rating to succeed. See RATING for more
SINGLE CHECK OPTIONS
Any single check switch supplied as an argument prevents
testssl.sh from doing a default run. It just takes this and if
@@ -1089,7 +1091,9 @@
that sets grade caps, the set_rating_state() has to
be updated (i.e. the $do_mycheck variable-name has
to be added to the loop, and $nr_enabled
- if-statement has to be incremented)
+ if-statement has to be incremented), and the
+ --rating-only switch statement needs to have
+ $do_mycheck=true added
The set_rating_state() automatically disables
rating, if all the required checks are not enabled.
This is to prevent giving out a misleading or wrong grade.