| Message ID | 95eb2a48d0ca3528780ce0dfce64359977fa8cb3.1620744606.git.mchehab+huawei@kernel.org (mailing list archive) |
|---|---|
| State | Not Applicable |
| Delegated to: | Netdev Maintainers |
| Headers | show |
| Series | None | expand |
> -monitoring tools such as ifstat or sar –n DEV [interval] [number of samples] > +monitoring tools such as `ifstat` or `sar -n DEV [interval] [number of samples]` ... > For example: min_rate 1Gbit 3Gbit: Verify bandwidth limit using network > -monitoring tools such as ifstat or sar –n DEV [interval] [number of samples] > +monitoring tools such as ``ifstat`` or ``sar -n DEV [interval] [number of samples]`` Is there a difference between ` and `` ? Does it make sense to be consistent? Andrew
Andrew Lunn <andrew@lunn.ch> writes: >> -monitoring tools such as ifstat or sar –n DEV [interval] [number of samples] >> +monitoring tools such as `ifstat` or `sar -n DEV [interval] [number of samples]` > > ... > >> For example: min_rate 1Gbit 3Gbit: Verify bandwidth limit using network >> -monitoring tools such as ifstat or sar –n DEV [interval] [number of samples] >> +monitoring tools such as ``ifstat`` or ``sar -n DEV [interval] [number of samples]`` > > Is there a difference between ` and `` ? Does it make sense to be > consistent? This is `just weird quotes` This is ``literal text`` set in monospace in processed output. There is a certain tension between those who want to see liberal use of literal-text markup, and those who would rather have less markup in the text overall; certainly, it's better not to go totally nuts with it. jon
On Tue, May 11, 2021 at 12:24:52PM -0600, Jonathan Corbet wrote: > Andrew Lunn <andrew@lunn.ch> writes: > > >> -monitoring tools such as ifstat or sar –n DEV [interval] [number of samples] > >> +monitoring tools such as `ifstat` or `sar -n DEV [interval] [number of samples]` > > > > ... > > > >> For example: min_rate 1Gbit 3Gbit: Verify bandwidth limit using network > >> -monitoring tools such as ifstat or sar –n DEV [interval] [number of samples] > >> +monitoring tools such as ``ifstat`` or ``sar -n DEV [interval] [number of samples]`` > > > > Is there a difference between ` and `` ? Does it make sense to be > > consistent? > > This is `just weird quotes` umm ... `this` is supposed to be "interpreted text" https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#inline-markup Maybe we don't actually interpret it. > This is ``literal text`` set in monospace in processed output. > > There is a certain tension between those who want to see liberal use of > literal-text markup, and those who would rather have less markup in the > text overall; certainly, it's better not to go totally nuts with it. I really appreciate the work you did to reduce the amount of markup that's needed!
Em Tue, 11 May 2021 19:48:18 +0100 Matthew Wilcox <willy@infradead.org> escreveu: > On Tue, May 11, 2021 at 12:24:52PM -0600, Jonathan Corbet wrote: > > Andrew Lunn <andrew@lunn.ch> writes: > > > > >> -monitoring tools such as ifstat or sar –n DEV [interval] [number of samples] > > >> +monitoring tools such as `ifstat` or `sar -n DEV [interval] [number of samples]` > > > > > > ... > > > > > >> For example: min_rate 1Gbit 3Gbit: Verify bandwidth limit using network > > >> -monitoring tools such as ifstat or sar –n DEV [interval] [number of samples] > > >> +monitoring tools such as ``ifstat`` or ``sar -n DEV [interval] [number of samples]`` > > > > > > Is there a difference between ` and `` ? Does it make sense to be > > > consistent? > > > > This is `just weird quotes` Gah, sorry for that! I sent a wrong version of this patch... i40e.rst should also be using: monitoring tools such as ``ifstat`` or ``sar -n DEV [interval] [number of samples]`` I'll fix it on the next spin. > > umm ... `this` is supposed to be "interpreted text" > https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#inline-markup > > Maybe we don't actually interpret it. Well, if we use it as something like :ref:`foo`, it is then interpreted ;-) using `foo` on Sphinx produces, in practice, the same effect as ``foo`` (at least on the initial versions): it also sets the font to monospace and stops parsing other markups inside the `interpreted text` string. I remember that, at the very beginning, I did some ReST conversions using `foo`. Then, I realized that this actually wrong, from the definition PoV, and started using ``foo``. > > > This is ``literal text`` set in monospace in processed output. > > > > There is a certain tension between those who want to see liberal use of > > literal-text markup, and those who would rather have less markup in the > > text overall; certainly, it's better not to go totally nuts with it. > > I really appreciate the work you did to reduce the amount of > markup that's needed! In the specific case of using things like: ``command -n``, I would put it on a literal block, either like the proposed path, or as: monitoring tools such as:: ifstat or:: sar -n DEV [interval] [number of samples] ifstat is there using the same monospaced font just for consistency purposes. See, if you use just: sar -n The Sphinx output could convert the hyphen to a dash. Btw, if there was two hyphens, like: "ifstat --help" This would be converted into "ifstat –help", using the EN DASH UTF-8 character. So, I strongly recommend that programs (specially when followed by arguments) to always use a literal block markup. Thanks, Mauro
diff --git a/Documentation/networking/device_drivers/ethernet/intel/i40e.rst b/Documentation/networking/device_drivers/ethernet/intel/i40e.rst index 8a9b18573688..2d3f6bd969a2 100644 --- a/Documentation/networking/device_drivers/ethernet/intel/i40e.rst +++ b/Documentation/networking/device_drivers/ethernet/intel/i40e.rst @@ -173,7 +173,7 @@ Director rule is added from ethtool (Sideband filter), ATR is turned off by the driver. To re-enable ATR, the sideband can be disabled with the ethtool -K option. For example:: - ethtool –K [adapter] ntuple [off|on] + ethtool -K [adapter] ntuple [off|on] If sideband is re-enabled after ATR is re-enabled, ATR remains enabled until a TCP-IP flow is added. When all TCP-IP sideband rules are deleted, ATR is @@ -688,7 +688,7 @@ shaper bw_rlimit: for each tc, sets minimum and maximum bandwidth rates. Totals must be equal or less than port speed. For example: min_rate 1Gbit 3Gbit: Verify bandwidth limit using network -monitoring tools such as ifstat or sar –n DEV [interval] [number of samples] +monitoring tools such as `ifstat` or `sar -n DEV [interval] [number of samples]` 2. Enable HW TC offload on interface:: diff --git a/Documentation/networking/device_drivers/ethernet/intel/iavf.rst b/Documentation/networking/device_drivers/ethernet/intel/iavf.rst index 52e037b11c97..25330b7b5168 100644 --- a/Documentation/networking/device_drivers/ethernet/intel/iavf.rst +++ b/Documentation/networking/device_drivers/ethernet/intel/iavf.rst @@ -179,7 +179,7 @@ shaper bw_rlimit: for each tc, sets minimum and maximum bandwidth rates. Totals must be equal or less than port speed. For example: min_rate 1Gbit 3Gbit: Verify bandwidth limit using network -monitoring tools such as ifstat or sar –n DEV [interval] [number of samples] +monitoring tools such as ``ifstat`` or ``sar -n DEV [interval] [number of samples]`` NOTE: Setting up channels via ethtool (ethtool -L) is not supported when the
Probably because the original file was pre-processed by some tool, both i40e.rst and iavf.rst files are using this character: - U+2013 ('–'): EN DASH meaning an hyphen when calling a command line application, which is obviously wrong. So, replace them by an hyphen, ensuring that it will be properly displayed as literals when building the documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> --- .../networking/device_drivers/ethernet/intel/i40e.rst | 4 ++-- .../networking/device_drivers/ethernet/intel/iavf.rst | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-)