Update documentation to commit fffb458

commit fffb458 Merge: 8d1e8da 245919d Author: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> AuthorDate: Tue Jul 30 16:02:53 2024 +0000 Commit: GitHub <[email protected]> CommitDate: Tue Jul 30 16:02:53 2024 +0000 Merge pull request #5803 from Martchus/git-clone-retry Avoid incomplete jobs when Git cloning fails
os-autoinst · Jul 31, 2024 · b0690d6 · b0690d6
1 parent 2f8a606
commit b0690d6
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 23 deletions.
diff --git a/docs/api/testapi.html b/docs/api/testapi.html
@@ -1020,7 +1020,7 @@ <h5 id="_wait_serial">wait_serial</h5>
 </div>
 </div>
 <div class="paragraph">
-<p>Deprecated mode</p>
+<p>Positional mode (not suggested)</p>
 </div>
 <div class="literalblock">
 <div class="content">
@@ -1071,7 +1071,7 @@ <h5 id="_assert_script_run">assert_script_run</h5>
 </div>
 </div>
 <div class="paragraph">
-<p>Deprecated mode</p>
+<p>Positional mode (not suggested)</p>
 </div>
 <div class="literalblock">
 <div class="content">
@@ -1101,7 +1101,7 @@ <h5 id="_script_run">script_run</h5>
 </div>
 </div>
 <div class="paragraph">
-<p>Deprecated mode</p>
+<p>Positional mode (not suggested)</p>
 </div>
 <div class="literalblock">
 <div class="content">
@@ -1277,7 +1277,7 @@ <h5 id="_validate_script_output">validate_script_output</h5>
 </div>
 </div>
 <div class="paragraph">
-<p>Deprecated mode</p>
+<p>Positional mode (not suggested)</p>
 </div>
 <div class="literalblock">
 <div class="content">
@@ -2079,7 +2079,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 2024-07-27 04:47:40 UTC
+Last updated 2024-07-31 04:47:39 UTC
 </div>
 </div>
 </body>

diff --git a/docs/current.pdf b/docs/current.pdf
diff --git a/docs/index.html b/docs/index.html
@@ -9019,16 +9019,14 @@ <h4 id="_schedule_asset_nr_url">SCHEDULE + ASSET_&lt;NR&gt;_URL</h4>
 <div class="sect2">
 <h3 id="_triggering_tests_based_on_an_any_remote_git_refspec_or_open_github_pull_request">Triggering tests based on an any remote Git refspec or open GitHub pull request</h3>
 <div class="paragraph">
-<p>openQA also supports to trigger tests using test code from an open pull
-request on GitHub or any branch or Git refspec. That means that code changes
-that are not yet available on a production instance of openQA can be tested
-safely to ensure the code changes work as expected before merging the code
-into a production repository and branch. This works by setting the
-<code>CASEDIR</code> parameter of os-autoinst to a valid Git repository path including
-an optional branch/refspec specifier. It is also possible to set <code>NEEDLES_DIR</code>
-to a valid Git repository path to use custom needles.
-See
-<a href="https://github.com/os-autoinst/os-autoinst/blob/master/doc/backend_vars.asciidoc" class="bare">https://github.com/os-autoinst/os-autoinst/blob/master/doc/backend_vars.asciidoc</a>
+<p>openQA also supports to trigger tests using test code from a pull request or
+any branch or Git refspec. That means that code changes that are not yet
+available on a production instance of openQA can be tested safely to ensure the
+code changes work as expected before merging the code into a production
+repository and branch. This works by setting the <code>CASEDIR</code> parameter of
+os-autoinst to a valid Git repository path including an optional branch/refspec
+specifier. <code>NEEDLES_DIR</code> can be set in the same way to use custom needles. See
+<a href="https://github.com/os-autoinst/os-autoinst/blob/master/doc/backend_vars.asciidoc">the os-autoinst documentation</a>
 for details.</p>
 </div>
 <div class="admonitionblock note">
@@ -9039,10 +9037,13 @@ <h3 id="_triggering_tests_based_on_an_any_remote_git_refspec_or_open_github_pull
 </td>
 <td class="content">
 <div class="paragraph">
-<p>The openQA worker normally default-initializes <code>CASEDIR</code> and <code>NEEDLES_DIR</code> to
-point to default repositories provided by the openQA instance. This behavior
-interacts with specifying a custom <code>CASEDIR</code> or <code>NEEDLES_DIR</code> in the following
-way:</p>
+<p>The openQA worker initializes <code>CASEDIR</code> and <code>NEEDLES_DIR</code> to point to
+repositories provided by the openQA instance (usually under
+<code>/var/lib/openqa/share/tests</code>).</p>
+</div>
+<div class="paragraph">
+<p>When the variables <code>CASEDIR</code> and <code>NEEDLES_DIR</code> are set, the behavior is as
+follows:</p>
 </div>
 <div class="ulist">
 <ul>
@@ -9093,9 +9094,10 @@ <h3 id="_triggering_tests_based_on_an_any_remote_git_refspec_or_open_github_pull
 </div>
 </div>
 <div class="paragraph">
-<p>Note that customizing <code>CASEDIR</code> does <strong>not</strong> mean needles will be loaded from
-there, even if the repository specified as <code>CASEDIR</code> contains needles. To load
-needles from that repository, it needs to be specified as <code>NEEDLES_DIR</code> as well.</p>
+<p>As noted above, customizing <code>CASEDIR</code> does <strong>not</strong> mean needles will be loaded
+from there, even if the repository specified as <code>CASEDIR</code> contains needles. To
+load needles from that repository, it needs to be specified as <code>NEEDLES_DIR</code> as
+described in the note above.</p>
 </div>
 <div class="paragraph">
 <p>Keep in mind that if <code>PRODUCTDIR</code> is overwritten as well, it might not relate to
@@ -13030,7 +13032,7 @@ <h3 id="_developing_tests_with_container_setup">Developing tests with container
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-07-27 04:44:37 UTC
+Last updated 2024-07-31 04:44:40 UTC
 </div>
 </div>
 </body>