| Message ID | 20220324164737.21765-2-hdegoede@redhat.com |
|---|---|
| State | Accepted |
| Commit | c5547574797b254ba9c98c7da417bc5de71cd198 |
| Headers | show |
| Series | Documentation/ABI: platform/x86: Sphinx warning fixes | expand |
On Thu, 2022-03-24 at 17:47 +0100, Hans de Goede wrote: > Fix the following warnings from "make htmldocs": > > Documentation/ABI/testing/sysfs-driver-intel_sdsi:2: > WARNING: Unexpected indentation. > WARNING: Block quote ends without a blank line; unexpected unindent. > WARNING: Definition list ends without a blank line; unexpected unindent. > > By turning the error-code table into a proper ReST table. While at it > also fix the error-code table mixing tab and spaces for indentation > (switch to all tabs). Thanks for the fix and for clarifying how to reproduce. David > > Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> > Signed-off-by: Hans de Goede <hdegoede@redhat.com> > --- > .../ABI/testing/sysfs-driver-intel_sdsi | 18 ++++++++++-------- > 1 file changed, 10 insertions(+), 8 deletions(-) > > diff --git a/Documentation/ABI/testing/sysfs-driver-intel_sdsi > b/Documentation/ABI/testing/sysfs-driver-intel_sdsi > index ab122125ff9a..96b92c105ec4 100644 > --- a/Documentation/ABI/testing/sysfs-driver-intel_sdsi > +++ b/Documentation/ABI/testing/sysfs-driver-intel_sdsi > @@ -13,17 +13,19 @@ Description: > Should the operation fail, one of the following error codes > may be returned: > > + ========== ===== > Error Code Cause > - ---------- ----- > - EIO General mailbox failure. Log may indicate > cause. > - EBUSY Mailbox is owned by another agent. > - EPERM SDSI capability is not enabled in hardware. > - EPROTO Failure in mailbox protocol detected by > driver. > + ========== ===== > + EIO General mailbox failure. Log may indicate > cause. > + EBUSY Mailbox is owned by another agent. > + EPERM SDSI capability is not enabled in hardware. > + EPROTO Failure in mailbox protocol detected by > driver. > See log for details. > - EOVERFLOW For provision commands, the size of the data > + EOVERFLOW For provision commands, the size of the data > exceeds what may be written. > - ESPIPE Seeking is not allowed. > - ETIMEDOUT Failure to complete mailbox transaction in time. > + ESPIPE Seeking is not allowed. > + ETIMEDOUT Failure to complete mailbox transaction in time. > + ========== ===== > > What: /sys/bus/auxiliary/devices/intel_vsec.sdsi.X/guid > Date: Feb 2022
diff --git a/Documentation/ABI/testing/sysfs-driver-intel_sdsi b/Documentation/ABI/testing/sysfs-driver-intel_sdsi index ab122125ff9a..96b92c105ec4 100644 --- a/Documentation/ABI/testing/sysfs-driver-intel_sdsi +++ b/Documentation/ABI/testing/sysfs-driver-intel_sdsi @@ -13,17 +13,19 @@ Description: Should the operation fail, one of the following error codes may be returned: + ========== ===== Error Code Cause - ---------- ----- - EIO General mailbox failure. Log may indicate cause. - EBUSY Mailbox is owned by another agent. - EPERM SDSI capability is not enabled in hardware. - EPROTO Failure in mailbox protocol detected by driver. + ========== ===== + EIO General mailbox failure. Log may indicate cause. + EBUSY Mailbox is owned by another agent. + EPERM SDSI capability is not enabled in hardware. + EPROTO Failure in mailbox protocol detected by driver. See log for details. - EOVERFLOW For provision commands, the size of the data + EOVERFLOW For provision commands, the size of the data exceeds what may be written. - ESPIPE Seeking is not allowed. - ETIMEDOUT Failure to complete mailbox transaction in time. + ESPIPE Seeking is not allowed. + ETIMEDOUT Failure to complete mailbox transaction in time. + ========== ===== What: /sys/bus/auxiliary/devices/intel_vsec.sdsi.X/guid Date: Feb 2022
Fix the following warnings from "make htmldocs": Documentation/ABI/testing/sysfs-driver-intel_sdsi:2: WARNING: Unexpected indentation. WARNING: Block quote ends without a blank line; unexpected unindent. WARNING: Definition list ends without a blank line; unexpected unindent. By turning the error-code table into a proper ReST table. While at it also fix the error-code table mixing tab and spaces for indentation (switch to all tabs). Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> Signed-off-by: Hans de Goede <hdegoede@redhat.com> --- .../ABI/testing/sysfs-driver-intel_sdsi | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-)