public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Lukas Bulwahn <lukas.bulwahn@gmail.com>,
	Jonathan Corbet <corbet@lwn.net>,
	Federico Vaga <federico.vaga@vaga.pv.it>,
	Alex Shi <alexs@kernel.org>, Yanteng Si <siyanteng@loongson.cn>,
	Hu Haowen <src.res@email.cn>,
	linux-doc@vger.kernel.org,
	linux-doc-tw-discuss@lists.sourceforge.net
Cc: Jean Delvare <jdelvare@suse.com>,
	Guenter Roeck <linux@roeck-us.net>,
	linux-hwmon@vger.kernel.org, kernel-janitors@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: Re: [RFC PATCH 06/11] docs: process: remove outdated submitting-drivers.rst
Date: Tue, 28 Jun 2022 08:20:56 +0700	[thread overview]
Message-ID: <bd2957f4-3793-d876-8b1f-1dbb9cf160d1@gmail.com> (raw)
In-Reply-To: <20220627151819.22694-7-lukas.bulwahn@gmail.com>

On 6/27/22 22:18, Lukas Bulwahn wrote:
>  There are numerous sources of information on Linux kernel development and
>  related topics.  First among those will always be the Documentation
> -directory found in the kernel source distribution.  The top-level :ref:`process/howto.rst <process_howto>`
> -file is an important starting point; :ref:`process/submitting-patches.rst <submittingpatches>`
> -and :ref:`process/submitting-drivers.rst  <submittingdrivers>`
> -are also something which all kernel developers should
> -read.  Many internal kernel APIs are documented using the kerneldoc
> -mechanism; "make htmldocs" or "make pdfdocs" can be used to generate those
> -documents in HTML or PDF format (though the version of TeX shipped by some
> -distributions runs into internal limits and fails to process the documents
> -properly).
> +directory found in the kernel source distribution.  Start with the
> +top-level :ref:`process/howto.rst <process_howto>`; also read
> +:ref:`process/submitting-patches.rst <submittingpatches>`. Many internal
> +kernel APIs are documented using the kerneldoc mechanism; "make htmldocs"
> +or "make pdfdocs" can be used to generate those documents in HTML or PDF
> +format (though the version of TeX shipped by some distributions runs into
> +internal limits and fails to process the documents properly).
>

Did you mean "beware that TeX distribution version as shipped by distributions
may fail to properly generate the documents"? I have never tried pdfdocs,
since the dependency requirement can be huge (hundreds of MB needed to
download packages), so I can't tell whether the phrase is relevant.
 
> -  :ref:`Documentation/process/submitting-patches.rst <submittingpatches>` and :ref:`Documentation/process/submitting-drivers.rst <submittingdrivers>`
> -    These files describe in explicit detail how to successfully create
> +  :ref:`Documentation/process/submitting-patches.rst <submittingpatches>`
> +    This file describes in explicit detail how to successfully create
>      and send a patch, including (but not limited to):
>  

Maybe "This document" instead of file?

> @@ -12,9 +12,8 @@ This document contains a large number of suggestions in a relatively terse
>  format.  For detailed information on how the kernel development process
>  works, see Documentation/process/development-process.rst. Also, read
>  Documentation/process/submit-checklist.rst
> -for a list of items to check before submitting code.  If you are submitting
> -a driver, also read Documentation/process/submitting-drivers.rst; for device
> -tree binding patches, read
> +for a list of items to check before submitting code.
> +For device tree binding patches, read
>  Documentation/devicetree/bindings/submitting-patches.rst.

The hunk above is OK.

-- 
An old man doll... just what I always wanted! - Clara

  reply	other threads:[~2022-06-28  1:21 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-06-27 15:18 [RFC PATCH 00/11] docs: remove submitting-drivers.rst Lukas Bulwahn
2022-06-27 15:18 ` [RFC PATCH 01/11] docs: kernel-docs: order reference from newest to oldest Lukas Bulwahn
2022-06-27 15:18 ` [RFC PATCH 02/11] docs: kernel-docs: shorten the lengthy doc title Lukas Bulwahn
2022-06-27 15:18 ` [RFC PATCH 03/11] docs: kernel-docs: reflect that it is community-maintained Lukas Bulwahn
2022-06-27 15:18 ` [RFC PATCH 04/11] docs: kernel-docs: add a reference mentioned in submitting-drivers.rst Lukas Bulwahn
2022-06-27 15:18 ` [RFC PATCH 05/11] docs: admin: devices: drop confusing outdated statement on Latex Lukas Bulwahn
2022-06-27 15:18 ` [RFC PATCH 06/11] docs: process: remove outdated submitting-drivers.rst Lukas Bulwahn
2022-06-28  1:20   ` Bagas Sanjaya [this message]
2022-06-28  5:00     ` Lukas Bulwahn
2022-06-28  6:40       ` Bagas Sanjaya
2022-06-27 15:18 ` [RFC PATCH 07/11] docs: it_IT: align to submitting-drivers removal Lukas Bulwahn
2022-06-28  9:16   ` Federico Vaga
2022-06-28 10:27     ` Lukas Bulwahn
2022-07-04  9:49     ` Lukas Bulwahn
2022-07-04 10:59       ` Federico Vaga
2022-06-27 15:18 ` [RFC PATCH 08/11] docs: ja_JP: howto: remove reference to removed submitting-drivers Lukas Bulwahn
2022-06-28  5:25   ` Akira Yokosawa
2022-06-28 10:24     ` Lukas Bulwahn
2022-06-27 15:18 ` [RFC PATCH 09/11] docs: ko_KR: " Lukas Bulwahn
2022-06-27 15:18 ` [RFC PATCH 10/11] docs: zh_CN: align to submitting-drivers removal Lukas Bulwahn
2022-06-29  6:40   ` Alex Shi
2022-06-27 15:18 ` [RFC PATCH 11/11] docs: zh_TW: " Lukas Bulwahn
2022-06-28  2:50 ` [RFC PATCH 00/11] docs: remove submitting-drivers.rst Bagas Sanjaya
2022-06-28  4:52   ` Lukas Bulwahn
2022-06-30 17:26 ` Jonathan Corbet
2022-07-04 13:02   ` Lukas Bulwahn

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=bd2957f4-3793-d876-8b1f-1dbb9cf160d1@gmail.com \
    --to=bagasdotme@gmail.com \
    --cc=alexs@kernel.org \
    --cc=corbet@lwn.net \
    --cc=federico.vaga@vaga.pv.it \
    --cc=jdelvare@suse.com \
    --cc=kernel-janitors@vger.kernel.org \
    --cc=linux-doc-tw-discuss@lists.sourceforge.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-hwmon@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux@roeck-us.net \
    --cc=lukas.bulwahn@gmail.com \
    --cc=siyanteng@loongson.cn \
    --cc=src.res@email.cn \
    /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