linux-kernel - [PATCH net-next 0/2] docs: net: Convert netdev-FAQ to RST

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <20180725025005.14332-1-me@tobin.cc>
Date:   Wed, 25 Jul 2018 12:50:03 +1000
From:   "Tobin C. Harding" <me@...in.cc>
To:     "David S. Miller" <davem@...emloft.net>,
        Jonathan Corbet <corbet@....net>
Cc:     "Tobin C. Harding" <me@...in.cc>, linux-doc@...r.kernel.org,
        netdev@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: [PATCH net-next 0/2] docs: net: Convert netdev-FAQ to RST

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