From: Randy Dunlap <rdunlap@infradead.org>
To: "Tobin C. Harding" <tobin@kernel.org>,
Michael Ellerman <mpe@ellerman.id.au>
Cc: linux-doc@vger.kernel.org, linuxppc-dev@lists.ozlabs.org,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>
Subject: Re: [PATCH 1/1] docs: powerpc: Convert to RST format
Date: Thu, 7 Feb 2019 14:58:18 -0800 [thread overview]
Message-ID: <2fc7fe53-af80-f3b8-1f17-ff7c2dc2be3c@infradead.org> (raw)
In-Reply-To: <20190207060316.3221-2-tobin@kernel.org>
On 2/6/19 10:03 PM, Tobin C. Harding wrote:
> The PowerPC docs have yet to be converted to RST format. Let's kick it
> off by doing all the files that _don't_ contain ASCII art.
>
> - Add SPDX license identifier to each new RST file.
>
> .. SPDX-License-Identifier: GPL-2.0
>
> - User correct heading adornments.
>
> - Make all lines < 72 characters in width.
>
> - Use correct indentation for code blocks, add syntax highlighting
>
> - Sparingly use double ticks if it makes the files easier to parse
> both in text and on the web.
>
> - Fix any super obvious typos (lean towards not making changes so that
> we don't introduce errors).
>
> Edited as text files (obviously) and formatted as HTML to verify
> rendering, no other formats verified.
>
> Convert docs to RST format, adding license.
>
> Signed-off-by: Tobin C. Harding <tobin@kernel.org>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
thanks.
> ---
> Documentation/index.rst | 1 +
> Documentation/powerpc/DAWR-POWER9.rst | 60 ++++
> Documentation/powerpc/DAWR-POWER9.txt | 58 ---
> Documentation/powerpc/bootwrapper.rst | 140 ++++++++
> Documentation/powerpc/bootwrapper.txt | 141 --------
> Documentation/powerpc/conf.py | 10 +
> Documentation/powerpc/cpu_features.rst | 62 ++++
> Documentation/powerpc/cpu_features.txt | 56 ---
> .../powerpc/eeh-pci-error-recovery.rst | 319 +++++++++++++++++
> .../powerpc/eeh-pci-error-recovery.txt | 334 ------------------
> Documentation/powerpc/index.rst | 21 ++
> Documentation/powerpc/isa-versions.rst | 234 ++++++++----
> Documentation/powerpc/mpc52xx.rst | 52 +++
> Documentation/powerpc/mpc52xx.txt | 39 --
> Documentation/powerpc/pmu-ebb.rst | 148 ++++++++
> Documentation/powerpc/pmu-ebb.txt | 137 -------
> Documentation/powerpc/ptrace.rst | 177 ++++++++++
> Documentation/powerpc/ptrace.txt | 151 --------
> .../{syscall64-abi.txt => syscall64-abi.rst} | 80 +++--
> .../powerpc/transactional_memory.rst | 259 ++++++++++++++
> .../powerpc/transactional_memory.txt | 244 -------------
> 21 files changed, 1460 insertions(+), 1263 deletions(-)
> create mode 100644 Documentation/powerpc/DAWR-POWER9.rst
> delete mode 100644 Documentation/powerpc/DAWR-POWER9.txt
> create mode 100644 Documentation/powerpc/bootwrapper.rst
> delete mode 100644 Documentation/powerpc/bootwrapper.txt
> create mode 100644 Documentation/powerpc/conf.py
> create mode 100644 Documentation/powerpc/cpu_features.rst
> delete mode 100644 Documentation/powerpc/cpu_features.txt
> create mode 100644 Documentation/powerpc/eeh-pci-error-recovery.rst
> delete mode 100644 Documentation/powerpc/eeh-pci-error-recovery.txt
> create mode 100644 Documentation/powerpc/index.rst
> create mode 100644 Documentation/powerpc/mpc52xx.rst
> delete mode 100644 Documentation/powerpc/mpc52xx.txt
> create mode 100644 Documentation/powerpc/pmu-ebb.rst
> delete mode 100644 Documentation/powerpc/pmu-ebb.txt
> create mode 100644 Documentation/powerpc/ptrace.rst
> delete mode 100644 Documentation/powerpc/ptrace.txt
> rename Documentation/powerpc/{syscall64-abi.txt => syscall64-abi.rst} (58%)
> create mode 100644 Documentation/powerpc/transactional_memory.rst
> delete mode 100644 Documentation/powerpc/transactional_memory.txt
--
~Randy
next prev parent reply other threads:[~2019-02-07 23:00 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-02-07 6:03 [PATCH 0/1] Start conversion of PowerPC docs Tobin C. Harding
2019-02-07 6:03 ` [PATCH 1/1] docs: powerpc: Convert to RST format Tobin C. Harding
2019-02-07 22:58 ` Randy Dunlap [this message]
2019-02-08 0:01 ` [PATCH 0/1] Start conversion of PowerPC docs Jonathan Corbet
2019-02-08 3:40 ` Michael Ellerman
2019-02-08 20:00 ` Jonathan Corbet
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=2fc7fe53-af80-f3b8-1f17-ff7c2dc2be3c@infradead.org \
--to=rdunlap@infradead.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linuxppc-dev@lists.ozlabs.org \
--cc=mpe@ellerman.id.au \
--cc=tobin@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).