lkml.org 
[lkml]   [2018]   [Jul]   [24]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
From
Subject[PATCH net-next 0/2] docs: net: Convert netdev-FAQ to RST
Date
Jon,

Is it ok for this to go through Dave's tree? Patch one touches a
line in Documentation/networking/index.rst Patch two depends on patch
one so it needs to go through the same tree please.


Dave (and Jon),

Kernel docs are prefer restructured text (RST) format. In doing the
conversion I tried a bunch of different ways to break it up to ease
review. Nothing I tried worked since so many of the changes touch so
many lines. In the end I did the whole conversion as a single patch and
listed in the patch commit log each type of change that was made.

Also, with these conversions I'm finding it difficult to split the
changes into separate patches and still keep the tree sane after each
patch.

In an effort to catch mistakes I did the conversion over three days -
there is only so many times you can read a docs file in one day without
your eyes starting to bleed.

Any tips and/or suggestions on making this and future conversions easier
to review much appreciated. If changes are not widespread it seems to
be better to split the file rename into a separate patch then make the
changes after that. (For this one it didn't help.)


thanks,
Tobin.

Tobin C. Harding (2):
docs: Add rest label the_canonical_path_format
docs: net: Convert netdev-FAQ to restructured text

Documentation/networking/index.rst | 1 +
Documentation/networking/netdev-FAQ.rst | 259 +++++++++++++++++++
Documentation/networking/netdev-FAQ.txt | 244 -----------------
Documentation/process/submitting-patches.rst | 1 +
4 files changed, 261 insertions(+), 244 deletions(-)
create mode 100644 Documentation/networking/netdev-FAQ.rst
delete mode 100644 Documentation/networking/netdev-FAQ.txt

--
2.17.1

\
 
 \ /
  Last update: 2018-07-25 04:51    [W:0.118 / U:1.088 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site