diff options
| author |   Tobin C. Harding <me@tobin.cc> | 2018-07-26 15:02:25 +1000 |
|---|---|---|
| committer |   David S. Miller <davem@davemloft.net> | 2018-07-26 21:27:54 -0700 |
| commit | 96398ddf63ff47833bc5f847a6e83778899058b6 (patch) | |
| tree | 88d848f10afbc45d87bd033a081ccfa0899d2c76 /Documentation/networking/index.rst | |
| parent | docs: Add rest label the_canonical_patch_format (diff) | |
| download | linux-dev-96398ddf63ff47833bc5f847a6e83778899058b6.tar.xz linux-dev-96398ddf63ff47833bc5f847a6e83778899058b6.zip | |
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>
Diffstat (limited to 'Documentation/networking/index.rst')
| -rw-r--r-- | Documentation/networking/index.rst | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/Documentation/networking/index.rst b/Documentation/networking/index.rst index f0ae9b65dfba..884a26145f20 100644 --- a/Documentation/networking/index.rst +++ b/Documentation/networking/index.rst @@ -6,6 +6,7 @@ Contents: .. toctree:: :maxdepth: 2 + netdev-FAQ af_xdp batman-adv can |