From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
Jonathan Corbet <corbet@lwn.net>,
Markus Heiser <markus.heiser@darmarit.de>,
Jani Nikula <jani.nikula@linux.intel.com>,
LKML <linux-kernel@vger.kernel.org>
Subject: [PATCH 05/17] SubmitChecklist: update kernel-doc task
Date: Wed, 14 Sep 2016 20:05:50 -0300 [thread overview]
Message-ID: <2f78b03e4e88394bb05f7a4b3be3e9ea73925424.1473893776.git.mchehab@s-opensource.com> (raw)
In-Reply-To: <cover.1473893776.git.mchehab@s-opensource.com>
In-Reply-To: <cover.1473893776.git.mchehab@s-opensource.com>
Task 11 (kernel-doc) still mentions usage of make manpages, but
this won't work if the API is documented via Sphinx. So, update
it to use either htmldocs or pdfdocs, with are the documentation
targets that work for all.
While here, add ReST reference to the kernel documentation book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/SubmitChecklist | 7 ++++---
Documentation/kernel-documentation.rst | 2 ++
2 files changed, 6 insertions(+), 3 deletions(-)
diff --git a/Documentation/SubmitChecklist b/Documentation/SubmitChecklist
index d646b1d47db1..1d64e9738e25 100644
--- a/Documentation/SubmitChecklist
+++ b/Documentation/SubmitChecklist
@@ -47,9 +47,10 @@ kernel patches.
but any one function that uses more than 512 bytes on the stack is a
candidate for change.
-11: Include kernel-doc to document global kernel APIs. (Not required for
- static functions, but OK there also.) Use 'make htmldocs' or 'make
- mandocs' to check the kernel-doc and fix any issues.
+11: Include :ref:`kernel-doc <kernel_doc>` to document global kernel APIs.
+ (Not required for static functions, but OK there also.) Use
+ ``make htmldocs`` or ``make pdfdocs`` to check the
+ :ref:`kernel-doc <kernel_doc>` and fix any issues.
12: Has been tested with CONFIG_PREEMPT, CONFIG_DEBUG_PREEMPT,
CONFIG_DEBUG_SLAB, CONFIG_DEBUG_PAGEALLOC, CONFIG_DEBUG_MUTEXES,
diff --git a/Documentation/kernel-documentation.rst b/Documentation/kernel-documentation.rst
index a0dcae15639b..10cc7ddb6235 100644
--- a/Documentation/kernel-documentation.rst
+++ b/Documentation/kernel-documentation.rst
@@ -294,6 +294,8 @@ The kernel-doc extension is included in the kernel source tree, at
``scripts/kernel-doc`` script to extract the documentation comments from the
source.
+.. _kernel_doc:
+
Writing kernel-doc comments
===========================
--
2.7.4
next prev parent reply other threads:[~2016-09-14 23:06 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-09-14 23:05 [PATCH 00/17] Improve documentation for the development-process Mauro Carvalho Chehab
2016-09-14 23:05 ` [PATCH 01/17] HOWTO.rst: update information about generating documentation Mauro Carvalho Chehab
2016-09-14 23:05 ` [PATCH 02/17] HOWTO.rst: improve some markups to make it visually better Mauro Carvalho Chehab
2016-09-14 23:05 ` [PATCH 03/17] HOWTO.rst: adjust external link references Mauro Carvalho Chehab
2016-09-14 23:05 ` [PATCH 04/17] Changes.rst: add minimal requirements for documentation build Mauro Carvalho Chehab
2016-09-14 23:05 ` Mauro Carvalho Chehab [this message]
2016-09-14 23:05 ` [PATCH 06/17] SubmitChecklist: convert it to ReST markup Mauro Carvalho Chehab
2016-09-14 23:05 ` [PATCH 07/17] SubmitChecklist: rename to RST and add to the development-proccess book Mauro Carvalho Chehab
2016-09-16 8:11 ` Jean Delvare
2016-09-14 23:05 ` [PATCH 08/17] doc-rst: add CSS styles for :kbd: and :menuselection: Mauro Carvalho Chehab
2016-09-14 23:05 ` [PATCH 09/17] email-clients.txt: convert it to ReST markup Mauro Carvalho Chehab
2016-09-14 23:05 ` [PATCH 10/17] email-clients.txt: add it to the development-process book Mauro Carvalho Chehab
2016-09-14 23:05 ` [PATCH 11/17] SubmittingPatches.rst: Add some cross-references Mauro Carvalho Chehab
2016-09-14 23:05 ` [PATCH 12/17] SubmittingPatches.rst: enrich the Sphinx output Mauro Carvalho Chehab
2016-09-14 23:05 ` [PATCH 13/17] SubmittingDrivers.rst: add a cross reference to CodingStyle Mauro Carvalho Chehab
2016-09-14 23:05 ` [PATCH 14/17] stable_api_nonsense.rst: fix emphasis on Sphinx Mauro Carvalho Chehab
2016-09-14 23:06 ` [PATCH 15/17] ManagementStyle.rst: avoid emphasis where not desired Mauro Carvalho Chehab
2016-09-14 23:06 ` [PATCH 16/17] stable_kernel_rules.rst: Add cross-references to other ReST files Mauro Carvalho Chehab
2016-09-14 23:06 ` [PATCH 17/17] applying-patches.rst: Update the information there Mauro Carvalho Chehab
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=2f78b03e4e88394bb05f7a4b3be3e9ea73925424.1473893776.git.mchehab@s-opensource.com \
--to=mchehab@s-opensource.com \
--cc=corbet@lwn.net \
--cc=jani.nikula@linux.intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=markus.heiser@darmarit.de \
--cc=mchehab@infradead.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
all inboxes | Powered by JetHome®