Update documentation to commit 0130cfb

commit 0130cfb
Merge: 90cbb53 b08b00c
Author:     mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
AuthorDate: Thu Nov 16 17:38:09 2023 +0000
Commit:     GitHub <[email protected]>
CommitDate: Thu Nov 16 17:38:09 2023 +0000

    Merge pull request os-autoinst#5360 from josegomezr/obs_rsync_ssh_auth

    Add support for SSH Authentication to ObsRsync Plugin

docs/api/testapi.html

@@ -2078,7 +2078,7 @@ <h5 id="_backend_get_wait_still_screen_on_here_doc_input">backend_get_wait_still
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2023-10-24 02:26:16 UTC
+Last updated 2023-11-17 02:26:28 UTC
 </div>
 </div>
 </body>

docs/index.html

@@ -676,14 +676,19 @@ <h1>openQA Documentation</h1>
 <li><a href="#_meaning_of_the_different_colors">Meaning of the different colors</a></li>
 </ul>
 </li>
-<li><a href="#_bug_references_and_labels">Bug references and labels</a>
+<li><a href="#_bug_references_labels_and_flags">Bug references, labels and flags</a>
 <ul class="sectlevel3">
 <li><a href="#_bug_references">Bug references</a></li>
 <li><a href="#_labels">Labels</a>
 <ul class="sectlevel4">
 <li><a href="#_overwrite_result_of_job">Overwrite result of job</a></li>
 </ul>
 </li>
+<li><a href="#_flags">Flags</a>
+<ul class="sectlevel4">
+<li><a href="#_flagcarryover">flag:carryover</a></li>
+</ul>
+</li>
 </ul>
 </li>
 <li><a href="#_distinguish_product_and_test_issues_bugref_gh708">Distinguish product and test issues bugref gh#708</a></li>
@@ -2311,17 +2316,12 @@ <h3 id="_tlsssl">TLS/SSL</h3>
 <div class="sect2">
 <h3 id="database">Database</h3>
 <div class="paragraph">
-<p>Since version <em>4.5.1512500474.437cc1c7</em> of openQA, PostgreSQL is used as the
-database.</p>
-</div>
-<div class="paragraph">
-<p>To configure access to the database in openQA, edit <code>/etc/openqa/database.ini</code>
-and change the settings in the <code>[production]</code> section.</p>
-</div>
-<div class="paragraph">
-<p>The <code>dsn</code> value format technically depends on the database type and is
-documented for PostgreSQL at
-<a href="https://metacpan.org/pod/DBD::Pg#DBI-Class-Methods">DBD::Pg</a></p>
+<p>openQA uses PostgreSQL as database. By default, a database with name <code>openqa</code>
+and <code>geekotest</code> user as owner is used. An automatic setup of a freshly
+installed PostgreSQL instance can be done using <a href="https://github.com/os-autoinst/openQA/blob/master/script/setup-db">this script</a>.
+The database connection can be configured in <code>/etc/openqa/database.ini</code>
+(normally the <code>[production]</code> section is relevant). More info about the <code>dsn</code>
+value format can be found in the <a href="https://metacpan.org/pod/DBD::Pg#DBI-Class-Methods">DBD::Pg documentation</a>.</p>
 </div>
 <div class="sect3">
 <h4 id="_example_for_connecting_to_local_postgresql_database">Example for connecting to local PostgreSQL database</h4>
@@ -4508,7 +4508,7 @@ <h4 id="_meaning_of_the_different_colors">Meaning of the different colors</h4>
 </div>
 </div>
 <div class="sect2">
-<h3 id="_bug_references_and_labels">Bug references and labels</h3>
+<h3 id="_bug_references_labels_and_flags">Bug references, labels and flags</h3>
 <div class="sect3">
 <h4 id="_bug_references">Bug references</h4>
 <div class="paragraph">
@@ -4518,7 +4518,9 @@ <h4 id="_bug_references">Bug references</h4>
 shortened automatically. A bug reference is rendered as link and a bug icon
 is displayed for the job in various places as shown in the figure below.
 A comment containing a bug reference will also be
-<a href="#carry-over">carried over</a> to reduce manual review work.</p>
+<a href="#carry-over">carried over</a> to reduce manual review work.
+Refer to the Flags section below for other ways to trigger automated comment
+carryover.</p>
 </div>
 <div class="admonitionblock warning">
 <table>
@@ -4616,13 +4618,27 @@ <h5 id="_overwrite_result_of_job">Overwrite result of job</h5>
 <td class="content">
 <code>force_result</code>-labels are evaluated when when a comment is
 <a href="#carry-over">carried over</a>. However, the carry over will
-only happen when the comment <strong>also</strong> contains a bug reference.
+only happen when the comment <strong>also</strong> contains a bug reference or <code>flag:carryover</code>.
 </td>
 </tr>
 </table>
 </div>
 </div>
 </div>
+<div class="sect3">
+<h4 id="_flags">Flags</h4>
+<div class="paragraph">
+<p>Currently there is only one flag for job comments supported.</p>
+</div>
+<div class="sect4">
+<h5 id="_flagcarryover">flag:carryover</h5>
+<div class="paragraph">
+<p>Adding <code>flag:carryover</code> to a comment, will result in this comment being
+<a href="#carry-over">carried over</a> to a new job failing for
+the same reason, without a bugref required.</p>
+</div>
+</div>
+</div>
 </div>
 <div class="sect2">
 <h3 id="_distinguish_product_and_test_issues_bugref_gh708">Distinguish product and test issues bugref <a href="https://github.com/os-autoinst/openQA/pull/708">gh#708</a></h3>
@@ -4899,7 +4915,9 @@ <h3 id="carry-over">Carry over of bug references from previous jobs in same scen
 <p>Many test failures within the same scenario might be due to the same reason.
 To avoid human reviewers having to add the same bug references again and
 again, bug references are carried over from previous failures in the same
-scenario if a job fails. This idea is inspired by the
+scenario if a job fails. The same behaviour can be achieved by adding
+<code>flag:carryover</code> to a comment.
+This idea is inspired by the
 <a href="https://wiki.jenkins-ci.org/display/JENKINS/Claim+plugin">Claim plugin</a> for
 Jenkins.</p>
 </div>
@@ -12388,7 +12406,7 @@ <h3 id="_developing_tests_with_container_setup">Developing tests with container
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2023-10-24 02:23:10 UTC
+Last updated 2023-11-17 02:23:20 UTC
 </div>
 </div>
 </body>