1
0
mirror of https://github.com/torvalds/linux.git synced 2024-12-20 01:52:13 +00:00
linux/Documentation/networking/index.rst
Tobin C. Harding 96398ddf63 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>
2018-07-26 21:27:54 -07:00

30 lines
333 B
ReStructuredText

Linux Networking Documentation
==============================
Contents:
.. toctree::
:maxdepth: 2
netdev-FAQ
af_xdp
batman-adv
can
dpaa2/index
e100
e1000
kapi
z8530book
msg_zerocopy
failover
net_failover
alias
bridge
.. only:: subproject
Indices
=======
* :ref:`genindex`