From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: SeongJae Park <sj38.park@gmail.com>
Cc: corbet@lwn.net, minchan@kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH 01/12] Documentation/HOWTO: Mark subsection in rst format
Date: Fri, 21 Oct 2016 13:45:22 -0200 [thread overview]
Message-ID: <20161021134522.112a7125@vento.lan> (raw)
In-Reply-To: <20161021151957.8127-2-sj38.park@gmail.com>
Em Sat, 22 Oct 2016 00:19:46 +0900
SeongJae Park <sj38.park@gmail.com> escreveu:
> Subsections in HOWTO is not marked in rst format. This commit specifies
> them in rst format.
>
> Signed-off-by: SeongJae Park <sj38.park@gmail.com>
> ---
> Documentation/HOWTO | 15 ++++++++++-----
> 1 file changed, 10 insertions(+), 5 deletions(-)
There are already patches converting HOWTO to ReST applied upstream:
commit 1b49ecf2f3be358882bb97652ba50ae808c0ba8f
Author: Jonathan Corbet <corbet@lwn.net>
Date: Tue Sep 20 18:46:36 2016 -0600
docs: Clean up bare :: lines
Mauro's patch set introduced some bare :: lines; these can be represented
by a double colon at the end of the preceding text line. The result looks
a little less weird and is less verbose.
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
commit f1eebe92c2653e8fc3760577e53befdc9b62ef26
Author: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Date: Mon Sep 19 08:07:59 2016 -0300
Documentation/HOWTO: adjust external link references
- A few link references were missing http://
- Several sites are now redirecting to https protocol. On such
cases, just use the https URL.
NOTE: all URLs were checked and they're pointing to the right places.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
commit 34fed7e7e0e56f885f309e8892a3571400072e37
Author: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Date: Mon Sep 19 08:07:58 2016 -0300
Documentation/HOWTO: improve some markups to make it visually better
Do a series of minor improvements at the ReST output format:
- Instead of using the quote blocks (::) for quotes, use
italics. That looks nicer on epub (and html) output, as
no scroll bar will be added. Also, it will adjust line
breaks on the text automatically.
- Add a missing reference to SubmittingPatches.rst and use
**foo** instead of _foo_.
- use bold for "The Perfect Patch" by removing a newline.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
commit 43fb67a5258c0f3d1d869cb7d72617d87b257c62
Author: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Date: Mon Sep 19 08:07:57 2016 -0300
Documentation/HOWTO: update information about generating documentation
The description there are pre-Sphinx. Update it to cover the
new way.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
There's also a series of patches pending merge that moves it
Documentation/process/howto.rst and add to this book:
https://mchehab.fedorapeople.org/kernel_docs/process/howto.html
Thanks,
Mauro
next prev parent reply other threads:[~2016-10-21 15:45 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-10-21 15:19 [PATCH 00/12] Fix and update HOWTO Korean translation SeongJae Park
2016-10-21 15:19 ` [PATCH 01/12] Documentation/HOWTO: Mark subsection in rst format SeongJae Park
2016-10-21 15:45 ` Mauro Carvalho Chehab [this message]
2016-10-21 16:42 ` SeongJae Park
2016-10-21 17:25 ` Mauro Carvalho Chehab
2016-10-21 17:57 ` SeongJae Park
2016-10-21 15:19 ` [PATCH 02/12] ko_KR/HOWTO: Fix a typo: s/Linux Torvalds/Linus Torvalds SeongJae Park
2016-10-21 15:19 ` [PATCH 03/12] ko_KR/HOWTO: Fix subtitles style SeongJae Park
2016-10-21 15:19 ` [PATCH 04/12] ko_KR/HOWTO: Update obsolete link to bugzilla faq SeongJae Park
2016-10-21 15:19 ` [PATCH 05/12] ko_KR/HOWTO: Convert to ReST notation SeongJae Park
2016-10-21 15:19 ` [PATCH 06/12] ko_KR/HOWTO: Add cross-references to other documents SeongJae Park
2016-10-21 15:19 ` [PATCH 07/12] ko_KR/HOWTO: Update information about generating documentation SeongJae Park
2016-10-21 15:19 ` [PATCH 08/12] ko_KR/HOWTO: Improve some markups to make it visually better SeongJae Park
2016-10-21 15:19 ` [PATCH 09/12] ko_KR/HOWTO: Adjust external link references SeongJae Park
2016-10-21 15:19 ` [PATCH 10/12] ko_KR/HOWTO: Clean up bare :: lines SeongJae Park
2016-10-21 15:19 ` [PATCH 11/12] ko_KR/HOWTO: Add whitespace between URL and text SeongJae Park
2016-10-21 15:19 ` [PATCH 12/12] ko_KR/HOWTO: Mark subsection in rst format SeongJae Park
2016-10-21 20:47 ` [PATCH 00/12] Fix and update HOWTO Korean translation Jonathan Corbet
2016-10-22 1:39 ` SeongJae Park
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=20161021134522.112a7125@vento.lan \
--to=mchehab@s-opensource.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=minchan@kernel.org \
--cc=sj38.park@gmail.com \
/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