[<prev] [next>] [<thread-prev] [day] [month] [year] [list]
Message-ID: <f41e4063-ac88-4444-b932-cc1c7cabbd7c@infradead.org>
Date: Tue, 23 Sep 2025 22:00:55 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: Simon Horman <horms@...nel.org>, Bagas Sanjaya <bagasdotme@...il.com>
Cc: Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
Linux Documentation <linux-doc@...r.kernel.org>,
Linux Networking <netdev@...r.kernel.org>,
"David S. Miller" <davem@...emloft.net>, Eric Dumazet <edumazet@...gle.com>,
Jakub Kicinski <kuba@...nel.org>, Paolo Abeni <pabeni@...hat.com>,
Jonathan Corbet <corbet@....net>,
Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
Kees Cook <kees@...nel.org>
Subject: Re: [PATCH net-next 2/3] net: dns_resolver: Move dns_query()
explanation out of code block
Hi,
On 9/23/25 3:14 AM, Simon Horman wrote:
> On Mon, Sep 22, 2025 at 04:56:47PM +0700, Bagas Sanjaya wrote:
>> Documentation for dns_query() is placed in the function's literal code
>> block snippet instead. Move it out of there.
>>
>> Fixes: 9dfe1361261b ("docs: networking: convert dns_resolver.txt to ReST")
>> Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>
>
> Thanks, this renders much better. In a browser at least.Hi
>
> I've added a few comments below.
>
>> ---
>> Documentation/networking/dns_resolver.rst | 45 +++++++++++------------
>> 1 file changed, 22 insertions(+), 23 deletions(-)
>>
>> diff --git a/Documentation/networking/dns_resolver.rst b/Documentation/networking/dns_resolver.rst
>> index 5cec37bedf9950..329fb21d005ccd 100644
>> --- a/Documentation/networking/dns_resolver.rst
>> +++ b/Documentation/networking/dns_resolver.rst
>> @@ -64,44 +64,43 @@ before the more general line given above as the first match is the one taken::
>> Usage
>> =====
>>
>> -To make use of this facility, one of the following functions that are
>> -implemented in the module can be called after doing::
>> +To make use of this facility, the appropriate header must be included first::
>
> Maybe: ..., first linux/dns_resolver.h must be included.
>
>>
>> #include <linux/dns_resolver.h>
>>
>> - ::
>> +Then you can make queries by calling::
>
> Please use imperative mood:
>
> Then queries may be made by calling::
>
I think imperative mood would be more like:
Then make queries by calling::
but I'm not asking for a v3 patch.
--
~Randy
Powered by blists - more mailing lists