lkml.org 
[lkml]   [2019]   [Apr]   [26]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    /
    Date
    From
    SubjectRe: [PATCH v2 25/79] docs: convert docs to ReST and rename to *.rst
    Hi Mark,

    Em Thu, 25 Apr 2019 19:07:58 +0100
    Mark Brown <broonie@kernel.org> escreveu:

    > On Mon, Apr 22, 2019 at 10:27:14AM -0300, Mauro Carvalho Chehab wrote:
    > > Convert the PM documents to ReST, in order to allow them to
    > > build with Sphinx.
    >
    > This is massively CCed covering a large range of subsystems and is patch
    > 25 of a 79 patch series so I've no context for what's going on here or
    > why...

    There are two goals of this series:

    1) to prepare for placing the new *.rst files under Documentation/ into an
    index file, being part of one of the books. Most of the stuff covered
    on this series either fit at the system admin guide or at the
    Kernel API documentation book;

    2) to ensure that, if some edition on a file would cause warnings at
    Sphinx build, someone will notice and submit a followup patch.

    You can see more details at patch 00/79:
    https://lore.kernel.org/lkml/20190422115110.26443b44@coco.lan/

    In order to do that, this series has one patch per Documentation/*
    sub-directory. This specific one is for the documents under
    Documentation/power/ [1].

    [1] btw, the title of this specific patch should be, instead:
    docs: power: convert docs to ReST and rename to *.rst

    The series is long because I'm trying to cover a significant part
    of the documentation files. In any case, except if an eventual
    conflict might rise on some file, this patch is independent from
    all other files, and should be safe to apply directly via the
    subsystem git tree.

    I'm working on a follow-up patch series that should be adding the
    power/index.rst file into another index file - probably at
    Documentation/index.rst[1]. As such patch will be adding a lot of other
    index files, the best would be to merge it via the docs tree, in
    order to avoid conflicts.


    [1] such patch will be removing the ":orphan:" meta-tag from it
    (that basically tells the build system to not produce warnings if
    the file is not directly or indirectly referenced by the main
    index file).

    Thanks,
    Mauro

    \
     
     \ /
      Last update: 2019-04-26 11:47    [W:4.612 / U:0.008 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site