[v1] docs: Clarify the documentation of the <css> elements

[PATCH] docs: Clarify the documentation of the <css> elements

Posted by Thomas Huth 3 years, 2 months ago

The channel subsystem elements describe a channel in the I/O subsystem
of a s390x machine, and not a normal device (like a disk or network card).
Reword the documentation here to make it this a little bit clearer.

Buglink: https://bugzilla.redhat.com/show_bug.cgi?id=1898074
Signed-off-by: Thomas Huth <thuth@redhat.com>
---
 docs/formatnode.html.in | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/docs/formatnode.html.in b/docs/formatnode.html.in
index 1010a37a3d..8fbd3e6ece 100644
--- a/docs/formatnode.html.in
+++ b/docs/formatnode.html.in
@@ -396,15 +396,15 @@
             </dl>
           </dd>
           <dt><code>css</code></dt>
-          <dd>Describes a Channel SubSystem (CSS) device commonly found on
-          the S390 architecture. Sub-elements include:
+          <dd>Describes a channel in the Channel SubSystem (CSS) commonly found
+          on the S390 architecture. Sub-elements include:
             <dl>
               <dt><code>cssid</code></dt>
               <dd>The channel subsystem identifier.</dd>
               <dt><code>ssid</code></dt>
               <dd>The subchannel-set identifier.</dd>
               <dt><code>devno</code></dt>
-              <dd>The device number.</dd>
+              <dd>The subchannel number.</dd>
               <dt><code>capability</code></dt>
               <dd>
                 This optional element can occur multiple times. If it
-- 
2.27.0

Re: [PATCH] docs: Clarify the documentation of the <css> elements

Posted by Cornelia Huck 3 years, 2 months ago

On Fri, 29 Jan 2021 11:04:44 +0100
Thomas Huth <thuth@redhat.com> wrote:

> The channel subsystem elements describe a channel in the I/O subsystem
> of a s390x machine, and not a normal device (like a disk or network card).
> Reword the documentation here to make it this a little bit clearer.
> 
> Buglink: https://bugzilla.redhat.com/show_bug.cgi?id=1898074
> Signed-off-by: Thomas Huth <thuth@redhat.com>
> ---
>  docs/formatnode.html.in | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/docs/formatnode.html.in b/docs/formatnode.html.in
> index 1010a37a3d..8fbd3e6ece 100644
> --- a/docs/formatnode.html.in
> +++ b/docs/formatnode.html.in
> @@ -396,15 +396,15 @@
>              </dl>
>            </dd>
>            <dt><code>css</code></dt>
> -          <dd>Describes a Channel SubSystem (CSS) device commonly found on
> -          the S390 architecture. Sub-elements include:
> +          <dd>Describes a channel in the Channel SubSystem (CSS) commonly found

s/channel/subchannel/, to be a bit nitpicky?

> +          on the S390 architecture. Sub-elements include:
>              <dl>
>                <dt><code>cssid</code></dt>
>                <dd>The channel subsystem identifier.</dd>
>                <dt><code>ssid</code></dt>
>                <dd>The subchannel-set identifier.</dd>
>                <dt><code>devno</code></dt>
> -              <dd>The device number.</dd>
> +              <dd>The subchannel number.</dd>
>                <dt><code>capability</code></dt>
>                <dd>
>                  This optional element can occur multiple times. If it

Re: [PATCH] docs: Clarify the documentation of the <css> elements

Posted by Boris Fiuczynski 3 years, 2 months ago

On 1/29/21 11:04 AM, Thomas Huth wrote:
> The channel subsystem elements describe a channel in the I/O subsystem
> of a s390x machine, and not a normal device (like a disk or network card).
> Reword the documentation here to make it this a little bit clearer.
> 
> Buglink: https://bugzilla.redhat.com/show_bug.cgi?id=1898074
> Signed-off-by: Thomas Huth <thuth@redhat.com>
> ---
>   docs/formatnode.html.in | 6 +++---
>   1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/docs/formatnode.html.in b/docs/formatnode.html.in
> index 1010a37a3d..8fbd3e6ece 100644
> --- a/docs/formatnode.html.in
> +++ b/docs/formatnode.html.in
> @@ -396,15 +396,15 @@
>               </dl>
>             </dd>
>             <dt><code>css</code></dt>
> -          <dd>Describes a Channel SubSystem (CSS) device commonly found on
> -          the S390 architecture. Sub-elements include:
> +          <dd>Describes a channel in the Channel SubSystem (CSS) commonly found
> +          on the S390 architecture. Sub-elements include:
>               <dl>
>                 <dt><code>cssid</code></dt>
>                 <dd>The channel subsystem identifier.</dd>
>                 <dt><code>ssid</code></dt>
>                 <dd>The subchannel-set identifier.</dd>
>                 <dt><code>devno</code></dt>
> -              <dd>The device number.</dd>
> +              <dd>The subchannel number.</dd>
>                 <dt><code>capability</code></dt>
>                 <dd>
>                   This optional element can occur multiple times. If it
> 

With Connie's additional nitpicked 'sub' :)
Reviewed-by: Boris Fiuczynski <fiuczy@linux.ibm.com>

-- 
Mit freundlichen Grüßen/Kind regards
    Boris Fiuczynski

IBM Deutschland Research & Development GmbH
Vorsitzender des Aufsichtsrats: Gregor Pillen
Geschäftsführung: Dirk Wittkopp
Sitz der Gesellschaft: Böblingen
Registergericht: Amtsgericht Stuttgart, HRB 243294