16 Jul, 2017

1 commit

  • Pull documentation format standardization from Jonathan Corbet:
    "This series converts a number of top-level documents to the RST format
    without incorporating them into the Sphinx tree. The hope is to bring
    some uniformity to kernel documentation and, perhaps more importantly,
    have our existing docs serve as an example of the desired formatting
    for those that will be added later.

    Mauro has gone through and fixed up a lot of top-level documentation
    files to make them conform to the RST format, but without moving or
    renaming them in any way. This will help when we incorporate the ones
    we want to keep into the Sphinx doctree, but the real purpose is to
    bring a bit of uniformity to our documentation and let the top-level
    docs serve as examples for those writing new ones"

    * tag 'standardize-docs' of git://git.lwn.net/linux: (84 commits)
    docs: kprobes.txt: Fix whitespacing
    tee.txt: standardize document format
    cgroup-v2.txt: standardize document format
    dell_rbu.txt: standardize document format
    zorro.txt: standardize document format
    xz.txt: standardize document format
    xillybus.txt: standardize document format
    vfio.txt: standardize document format
    vfio-mediated-device.txt: standardize document format
    unaligned-memory-access.txt: standardize document format
    this_cpu_ops.txt: standardize document format
    svga.txt: standardize document format
    static-keys.txt: standardize document format
    smsc_ece1099.txt: standardize document format
    SM501.txt: standardize document format
    siphash.txt: standardize document format
    sgi-ioc4.txt: standardize document format
    SAK.txt: standardize document format
    rpmsg.txt: standardize document format
    robust-futexes.txt: standardize document format
    ...

    Linus Torvalds
     

15 Jul, 2017

1 commit

  • Each text file under Documentation follows a different
    format. Some doesn't even have titles!

    Change its representation to follow the adopted standard,
    using ReST markups for it to be parseable by Sphinx.

    This file is using some other markup notation (likely, markdown).
    Convert it to the adopted standard:

    - Adjust the header level markup;
    - Adjust identation for debugfs files and module parameters.

    Signed-off-by: Mauro Carvalho Chehab
    Signed-off-by: Jonathan Corbet

    Mauro Carvalho Chehab
     

06 Jul, 2017

1 commit


05 Jul, 2015

6 commits