Merge pull request #2948 from testssl/ratingdoc_update

Update docs after raiting only switch

Author: drwetter

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.

doc/testssl.1.html

@@ -413,6 +413,8 @@ <h3 id="tuning-options">TUNING OPTIONS</h3>
         hosts whose certificates are issued by internal CAs.
         Alternatively ADDTL_CA_FILES is the environment variable for
         this.</p>
+        <p><code>--rating-only</code> makes testssl.sh do the bare
+        minimum to allow rating to succeed. See RATING for more</p>
         <h3 id="single-check-options">SINGLE CHECK OPTIONS</h3>
         <p>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 @@ <h4 id="implementing-new-grades-caps-or--warnings">Implementing
         that sets grade caps, the <code>set_rating_state()</code> has to
         be updated (i.e. the <code>$do_mycheck</code> variable-name has
         to be added to the loop, and <code>$nr_enabled</code>
-        if-statement has to be incremented)</p>
+        if-statement has to be incremented), and the
+        <code>--rating-only</code> switch statement needs to have
+        <code>$do_mycheck=true</code> added</p>
         <p>The <code>set_rating_state()</code> automatically disables
         rating, if all the required checks are <em>not</em> enabled.
         This is to prevent giving out a misleading or wrong grade.</p>