Em Sat, 22 Oct 2016 00:19:46 +0900
SeongJae Park <sj38.park@xxxxxxxxx> escreveu:
> Subsections in HOWTO is not marked in rst format. This commit specifies
> them in rst format.
>
> Signed-off-by: SeongJae Park <sj38.park@xxxxxxxxx>
> ---
> 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@xxxxxxx>
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@xxxxxxx>
commit f1eebe92c2653e8fc3760577e53befdc9b62ef26
Author: Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx>
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@xxxxxxxxxxxxxxxx>
Signed-off-by: Jonathan Corbet <corbet@xxxxxxx>
commit 34fed7e7e0e56f885f309e8892a3571400072e37
Author: Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx>
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@xxxxxxxxxxxxxxxx>
Signed-off-by: Jonathan Corbet <corbet@xxxxxxx>
commit 43fb67a5258c0f3d1d869cb7d72617d87b257c62
Author: Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx>
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@xxxxxxxxxxxxxxxx>
Signed-off-by: Jonathan Corbet <corbet@xxxxxxx>
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
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
