Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <bd2957f4-3793-d876-8b1f-1dbb9cf160d1@gmail.com>
Date:   Tue, 28 Jun 2022 08:20:56 +0700
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101
 Thunderbird/91.10.0
Subject: Re: [RFC PATCH 06/11] docs: process: remove outdated
 submitting-drivers.rst
Content-Language: en-US
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
References: <20220627151819.22694-1-lukas.bulwahn@gmail.com>
 <20220627151819.22694-7-lukas.bulwahn@gmail.com>
From:   Bagas Sanjaya <bagasdotme@gmail.com>
In-Reply-To: <20220627151819.22694-7-lukas.bulwahn@gmail.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
Precedence: bulk

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