Deploying to gh-pages from @ 9477d71 🚀

SonarSource · Sep 25, 2023 · 4608779 · 4608779
1 parent 7979b7e
commit 4608779
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 39 deletions.
diff --git a/rules/S6570/default-description.html b/rules/S6570/default-description.html
@@ -18,65 +18,61 @@ <h2 id="_why_is_this_an_issue">Why is this an issue?</h2>
 <div class="sect2">
 <h3 id="_what_is_the_potential_impact">What is the potential impact?</h3>
 <div class="paragraph">
-<p>This issue can lead to bugs if the variable contains sensitive characters, which may not be interpreted correctly.</p>
+<p>This issue can lead to bugs if the variable contains sensitive characters, which may be interpreted incorrectly and thus lead to undesired behavior.</p>
 </div>
 </div>
 </div>
 </div>
 <div class="sect1">
-<h2 id="_how_to_fix_it">How to fix it</h2>
+<h2 id="_how_can_i_fix_it">How can I fix it?</h2>
 <div class="sectionbody">
 <div class="paragraph">
-<p>Add the missing double quotes to this variable.</p>
+<p>Surround variable reference with double quotes.</p>
 </div>
 <div class="sect2">
 <h3 id="_code_examples">Code examples</h3>
 <div class="sect3">
 <h4 id="_noncompliant_code_example">Noncompliant code example</h4>
 <div class="paragraph">
-<p>Demonstration of pathname expansion using the <code>echo</code> command:</p>
+<p>This example demonstrates pathname expansion using the <code>echo</code> command:</p>
 </div>
 <div class="listingblock">
 <div class="content">
-<pre class="highlight"><code class="language-docker" data-lang="docker">RUN test="command t*.sh"
-RUN echo $test</code></pre>
+<pre class="highlight"><code class="language-docker" data-lang="docker">RUN test="command t*.sh" &amp;&amp; echo $test</code></pre>
 </div>
 </div>
 <div class="paragraph">
-<p>This will print <code>"command temp1.sh temp2.sh"</code>, as <code>*</code> is substituted to matching files in the current folder.
-In this example the folder contains the files <code>temp1.sh</code> and <code>temp2.sh</code>.</p>
+<p>Suppose this code is executed in a directory that contains two files: <code>temp1.sh</code> and <code>temp2.sh</code>. This code will print <code>"command temp1.sh temp2.sh"</code>,
+as <code>*</code> is substituted with matching files in the current folder.</p>
 </div>
 <div class="paragraph">
-<p>Demonstration of word splitting using the <code>echo</code> command:</p>
+<p>This example demonstrates word splitting using the <code>echo</code> command:</p>
 </div>
 <div class="listingblock">
 <div class="content">
-<pre class="highlight"><code class="language-docker" data-lang="docker">RUN test=" Hello World "
-RUN echo $test</code></pre>
+<pre class="highlight"><code class="language-docker" data-lang="docker">RUN test=" Hello World " &amp;&amp; echo $test</code></pre>
 </div>
 </div>
 <div class="paragraph">
-<p>This will print <code>"Hello World"</code>, omitting the leading and trailing whitespaces.</p>
+<p>This code will print <code>"Hello World"</code>, omitting the leading and trailing whitespaces.</p>
 </div>
 </div>
 <div class="sect3">
 <h4 id="_compliant_solution">Compliant solution</h4>
 <div class="paragraph">
-<p>Demonstration of pathname expansion using the <code>echo</code> command, which will print <code>"command t*.sh"</code> as intended:</p>
+<p>This example demonstrates pathname expansion using the <code>echo</code> command, which will print <code>"command t*.sh"</code> as intended:</p>
 </div>
 <div class="listingblock">
 <div class="content">
-<pre class="highlight"><code class="language-docker" data-lang="docker">RUN test="command t*.sh"
-RUN echo "$test"</code></pre>
+<pre class="highlight"><code class="language-docker" data-lang="docker">RUN test="command t*.sh" &amp;&amp; echo "$test"</code></pre>
 </div>
 </div>
 <div class="paragraph">
-<p>Demonstration of word splitting using the <code>echo</code> command, which will print <code>" Hello World "</code> as intended:</p>
+<p>This example demonstrates word splitting using the <code>echo</code> command, which will print <code>" Hello World "</code> as intended:</p>
 </div>
 <div class="listingblock">
 <div class="content">
-<pre class="highlight"><code class="language-docker" data-lang="docker">RUN test=" Hello World "
-RUN echo "$test"</code></pre>
+<pre class="highlight"><code class="language-docker" data-lang="docker">RUN test=" Hello World " &amp;&amp; echo "$test"</code></pre>
 </div>
 </div>
 </div>
@@ -111,7 +107,7 @@ <h2 id="_implementation_specification">Implementation Specification</h2>
 <div class="sect2">
 <h3 id="_message">Message</h3>
 <div class="paragraph">
-<p>Add the missing double quotes to this variable, as it can lead to unexpected behaviour.</p>
+<p>Surround this variable with double quotes; otherwise, it can lead to unexpected behavior.</p>
 </div>
 </div>
 <div class="sect2">

diff --git a/rules/S6570/docker-description.html b/rules/S6570/docker-description.html
@@ -18,65 +18,61 @@ <h2 id="_why_is_this_an_issue">Why is this an issue?</h2>
 <div class="sect2">
 <h3 id="_what_is_the_potential_impact">What is the potential impact?</h3>
 <div class="paragraph">
-<p>This issue can lead to bugs if the variable contains sensitive characters, which may not be interpreted correctly.</p>
+<p>This issue can lead to bugs if the variable contains sensitive characters, which may be interpreted incorrectly and thus lead to undesired behavior.</p>
 </div>
 </div>
 </div>
 </div>
 <div class="sect1">
-<h2 id="_how_to_fix_it">How to fix it</h2>
+<h2 id="_how_can_i_fix_it">How can I fix it?</h2>
 <div class="sectionbody">
 <div class="paragraph">
-<p>Add the missing double quotes to this variable.</p>
+<p>Surround variable reference with double quotes.</p>
 </div>
 <div class="sect2">
 <h3 id="_code_examples">Code examples</h3>
 <div class="sect3">
 <h4 id="_noncompliant_code_example">Noncompliant code example</h4>
 <div class="paragraph">
-<p>Demonstration of pathname expansion using the <code>echo</code> command:</p>
+<p>This example demonstrates pathname expansion using the <code>echo</code> command:</p>
 </div>
 <div class="listingblock">
 <div class="content">
-<pre class="highlight"><code class="language-docker" data-lang="docker">RUN test="command t*.sh"
-RUN echo $test</code></pre>
+<pre class="highlight"><code class="language-docker" data-lang="docker">RUN test="command t*.sh" &amp;&amp; echo $test</code></pre>
 </div>
 </div>
 <div class="paragraph">
-<p>This will print <code>"command temp1.sh temp2.sh"</code>, as <code>*</code> is substituted to matching files in the current folder.
-In this example the folder contains the files <code>temp1.sh</code> and <code>temp2.sh</code>.</p>
+<p>Suppose this code is executed in a directory that contains two files: <code>temp1.sh</code> and <code>temp2.sh</code>. This code will print <code>"command temp1.sh temp2.sh"</code>,
+as <code>*</code> is substituted with matching files in the current folder.</p>
 </div>
 <div class="paragraph">
-<p>Demonstration of word splitting using the <code>echo</code> command:</p>
+<p>This example demonstrates word splitting using the <code>echo</code> command:</p>
 </div>
 <div class="listingblock">
 <div class="content">
-<pre class="highlight"><code class="language-docker" data-lang="docker">RUN test=" Hello World "
-RUN echo $test</code></pre>
+<pre class="highlight"><code class="language-docker" data-lang="docker">RUN test=" Hello World " &amp;&amp; echo $test</code></pre>
 </div>
 </div>
 <div class="paragraph">
-<p>This will print <code>"Hello World"</code>, omitting the leading and trailing whitespaces.</p>
+<p>This code will print <code>"Hello World"</code>, omitting the leading and trailing whitespaces.</p>
 </div>
 </div>
 <div class="sect3">
 <h4 id="_compliant_solution">Compliant solution</h4>
 <div class="paragraph">
-<p>Demonstration of pathname expansion using the <code>echo</code> command, which will print <code>"command t*.sh"</code> as intended:</p>
+<p>This example demonstrates pathname expansion using the <code>echo</code> command, which will print <code>"command t*.sh"</code> as intended:</p>
 </div>
 <div class="listingblock">
 <div class="content">
-<pre class="highlight"><code class="language-docker" data-lang="docker">RUN test="command t*.sh"
-RUN echo "$test"</code></pre>
+<pre class="highlight"><code class="language-docker" data-lang="docker">RUN test="command t*.sh" &amp;&amp; echo "$test"</code></pre>
 </div>
 </div>
 <div class="paragraph">
-<p>Demonstration of word splitting using the <code>echo</code> command, which will print <code>" Hello World "</code> as intended:</p>
+<p>This example demonstrates word splitting using the <code>echo</code> command, which will print <code>" Hello World "</code> as intended:</p>
 </div>
 <div class="listingblock">
 <div class="content">
-<pre class="highlight"><code class="language-docker" data-lang="docker">RUN test=" Hello World "
-RUN echo "$test"</code></pre>
+<pre class="highlight"><code class="language-docker" data-lang="docker">RUN test=" Hello World " &amp;&amp; echo "$test"</code></pre>
 </div>
 </div>
 </div>
@@ -111,7 +107,7 @@ <h2 id="_implementation_specification">Implementation Specification</h2>
 <div class="sect2">
 <h3 id="_message">Message</h3>
 <div class="paragraph">
-<p>Add the missing double quotes to this variable, as it can lead to unexpected behaviour.</p>
+<p>Surround this variable with double quotes; otherwise, it can lead to unexpected behavior.</p>
 </div>
 </div>
 <div class="sect2">

diff --git a/rules/rule-index.json b/rules/rule-index.json