Thread (4 messages) 4 messages, 2 authors, 2019-11-01

Re: [PATCH net] Documentation: netdev-FAQ: make all questions into headings

From: Jonathan Corbet <corbet@lwn.net>
Date: 2019-10-30 08:44:37
Also in: linux-doc

On Tue, 29 Oct 2019 10:12:15 -0700
Jakub Kicinski [off-list ref] wrote:
Make sure all questions are headings. Some questions are
currently on multiple lines, and the continuation lines
appear as part of the answer when rendered. One question
was also missing an underline completely.

Signed-off-by: Jakub Kicinski <redacted>
Reviewed-by: Simon Horman <redacted>
---
 Documentation/networking/netdev-FAQ.rst | 35 +++++++++----------------
 1 file changed, 13 insertions(+), 22 deletions(-)
Thanks for working to improve our documentation!

One quick comment...

[...]
-Q: I see a network patch and I think it should be backported to stable.
------------------------------------------------------------------------
-Q: Should I request it via stable@vger.kernel.org like the references in
-the kernel's Documentation/process/stable-kernel-rules.rst file say?
+Q: I see a network patch and I think it should be backported to stable. Should I request it via stable@vger.kernel.org like the references in the kernel's Documentation/process/stable-kernel-rules.rst file say?
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
I don't think that making these massive heading lines actually improves the
experience - for readers of either the plain-text or formatted docs.  If
you really want to create headings, the heading here should be "Stable
backports" or some such with the question appearing below.  But do the
questions really need to be headings?

Thanks,

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