Thread (3 messages) 3 messages, 3 authors, 2018-06-18

Re: [PATCH] net: fix e100.rst Documentation build errors

From: Michal Kubecek <hidden>
Date: 2018-06-18 11:44:44
Also in: linux-doc, lkml

On Mon, Jun 18, 2018 at 11:04:51AM +0300, Jani Nikula wrote:
On Sat, 16 Jun 2018, Randy Dunlap [off-list ref] wrote:
quoted
From: Randy Dunlap <redacted>

Fix Documentation build errors in e100.rst.  Several section titles
and the corresponding underlines should not be indented.
Really the content blocks below the titles should not be indented
either. It's not an error, but the end result is probably not what you
want.
Also the indentation of this part:
Rx Descriptors: Number of receive descriptors. A receive descriptor is a data
   structure that describes a receive buffer and its attributes to the network
   controller. The data in the descriptor is used by the controller to write
   data from the controller to host memory. In the 3.x.x driver the valid range
   for this parameter is 64-256. The default value is 256. This parameter can be
   changed using the command::

   ethtool -G eth? rx n

   Where n is the number of desired Rx descriptors.

Tx Descriptors: Number of transmit descriptors. A transmit descriptor is a data
   structure that describes a transmit buffer and its attributes to the network
   controller. The data in the descriptor is used by the controller to read
   data from the host memory to the controller. In the 3.x.x driver the valid
   range for this parameter is 64-256. The default value is 128. This parameter
   can be changed using the command::

   ethtool -G eth? tx n

   Where n is the number of desired Tx descriptors.

Speed/Duplex: The driver auto-negotiates the link speed and duplex settings by
   default. The ethtool utility can be used as follows to force speed/duplex.::

   ethtool -s eth?  autoneg off speed {10|100} duplex {full|half}

   NOTE: setting the speed/duplex to incorrect values will cause the link to
   fail.

Event Log Message Level:  The driver uses the message level flag to log events
   to syslog. The message level can be set at driver load time. It can also be
   set using the command::

   ethtool -s eth? msglvl n
causes

.../Documentation/networking/e100.rst:56: WARNING: Literal block expected; none found.
.../Documentation/networking/e100.rst:67: WARNING: Literal block expected; none found.
.../Documentation/networking/e100.rst:74: WARNING: Literal block expected; none found.
.../Documentation/networking/e100.rst:83: WARNING: Literal block expected; none found.

as the literal block has the same indentation as preceding paragraph
(except for the first line).

Michal Kubecek
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help