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: <e8605c72-7807-ee03-83eb-6744bb3dbd47@gmail.com>
Date:   Tue, 28 Jun 2022 13:40:09 +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>
Cc:     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>,
        "open list:DOCUMENTATION" <linux-doc@vger.kernel.org>,
        linux-doc-tw-discuss@lists.sourceforge.net,
        Jean Delvare <jdelvare@suse.com>,
        Guenter Roeck <linux@roeck-us.net>,
        linux-hwmon@vger.kernel.org,
        kernel-janitors <kernel-janitors@vger.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@vger.kernel.org>
References: <20220627151819.22694-1-lukas.bulwahn@gmail.com>
 <20220627151819.22694-7-lukas.bulwahn@gmail.com>
 <bd2957f4-3793-d876-8b1f-1dbb9cf160d1@gmail.com>
 <CAKXUXMz58KV5m2HzYTwG7eq=2n4TMOT_F4Q8fL0Tn-7VAgtHAg@mail.gmail.com>
From:   Bagas Sanjaya <bagasdotme@gmail.com>
In-Reply-To: <CAKXUXMz58KV5m2HzYTwG7eq=2n4TMOT_F4Q8fL0Tn-7VAgtHAg@mail.gmail.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
Precedence: bulk

On 6/28/22 12:00, Lukas Bulwahn wrote:
> On Tue, Jun 28, 2022 at 3:21 AM Bagas Sanjaya <bagasdotme@gmail.com> wrote:
>>
>> 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.
>>
> 
> I only touched this sentence with 'make pdfdocs' above to reformat the
> paragraph after deleting the reference to submitting-drivers. Maybe
> the statement on make pdfdocs is outdated already or we should refer
> to the documentation build page instead?
> 

I think we can say "The kernel documentation subsystem (kernel-doc)
uses Sphinx. Refer to Documentation/doc-guide/sphinx.rst for more
information.", at least.

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