netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Tobin C. Harding" <me@tobin.cc>
To: "David S. Miller" <davem@davemloft.net>,
	Jonathan Corbet <corbet@lwn.net>
Cc: "Tobin C. Harding" <me@tobin.cc>,
	linux-doc@vger.kernel.org, netdev@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: [PATCH net-next 0/2] docs: net: Convert netdev-FAQ to RST
Date: Wed, 25 Jul 2018 12:50:03 +1000	[thread overview]
Message-ID: <20180725025005.14332-1-me@tobin.cc> (raw)

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

             reply	other threads:[~2018-07-25  2:50 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-07-25  2:50 Tobin C. Harding [this message]
2018-07-25  2:50 ` [PATCH net-next 1/2] docs: Add rest label the_canonical_path_format Tobin C. Harding
2018-07-25 14:36   ` Edward Cree
2018-07-25 22:26     ` Tobin C. Harding
2018-07-25  2:50 ` [PATCH net-next 2/2] docs: net: Convert netdev-FAQ to restructured text Tobin C. Harding
2018-07-25  3:28 ` [PATCH net-next 0/2] docs: net: Convert netdev-FAQ to RST Tobin C. Harding
2018-07-25 14:14   ` Jonathan Corbet
2018-07-25 22:31     ` Tobin C. Harding

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180725025005.14332-1-me@tobin.cc \
    --to=me@tobin.cc \
    --cc=corbet@lwn.net \
    --cc=davem@davemloft.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=netdev@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).