]> asedeno.scripts.mit.edu Git - linux.git/commit
docs: net: Convert netdev-FAQ to restructured text
authorTobin C. Harding <me@tobin.cc>
Thu, 26 Jul 2018 05:02:25 +0000 (15:02 +1000)
committerDavid S. Miller <davem@davemloft.net>
Fri, 27 Jul 2018 04:27:54 +0000 (21:27 -0700)
commit96398ddf63ff47833bc5f847a6e83778899058b6
tree88d848f10afbc45d87bd033a081ccfa0899d2c76
parentf58252cdc04cc4b2d512b2a3a41e4d9d1dc04e2e
docs: net: Convert netdev-FAQ to restructured text

Preferred kernel docs format is now restructured text.  Convert
netdev-FAQ.txt to restructured text.

 - Add SPDX license identifier.

 - Change file heading 'Information you need to know about netdev' to
  'netdev FAQ' to better suit displayed index (in HTML).

 - Change question/answer layout to suit rst.  Copy format in
   Documentation/bpf/bpf_devel_QA.rst

 - Fix indentation of code snippets

 - If multiple consecutive URLs appear put them in a list (to maintain
  whitespace).

 - Use uniform spelling of 'bug fix' throughout document (not bugfix or
   bug-fix).

 - Add double back ticks to 'net' and 'net-next' when referring to the
   trees.

 - Use rst references for Documentation/ links.

 - Add rst label 'netdev-FAQ' for referencing by other docs files.

 - Remove stale entry from Documentation/networking/00-INDEX

Signed-off-by: Tobin C. Harding <me@tobin.cc>
Signed-off-by: David S. Miller <davem@davemloft.net>
Documentation/networking/00-INDEX
Documentation/networking/index.rst
Documentation/networking/netdev-FAQ.rst [new file with mode: 0644]
Documentation/networking/netdev-FAQ.txt [deleted file]