[PATCH net-next 0/3] dns_resolver docs formatting cleanup

[PATCH net-next 0/3] dns_resolver docs formatting cleanup

[Bagas Sanjaya]

Hi,

Here are reST cleanups for DNS Resolver Module documentation. The shortlog
below should be self-explanatory.

Enjoy!

Bagas Sanjaya (3):
  net: dns_resolver: Use reST bullet list for features list
  net: dns_resolver: Move dns_query() explanation out of code block
  net: dns_resolver: Fix request-key cross-reference

 Documentation/networking/dns_resolver.rst | 53 +++++++++++------------
 1 file changed, 26 insertions(+), 27 deletions(-)


base-commit: 312e6f7676e63bbb9b81e5c68e580a9f776cc6f0
-- 
An old man doll... just what I always wanted! - Clara

[PATCH net-next 1/3] net: dns_resolver: Use reST bullet list for features list

[Bagas Sanjaya]

Features overview list uses an asterisk in parentheses (``(*)``)
as bullet list marker, which isn't supported by Sphinx as proper
bullet. Replace it with just asterisk.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/networking/dns_resolver.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/networking/dns_resolver.rst b/Documentation/networking/dns_resolver.rst
index c0364f7070af84..5cec37bedf9950 100644
--- a/Documentation/networking/dns_resolver.rst
+++ b/Documentation/networking/dns_resolver.rst
@@ -25,11 +25,11 @@ These routines must be supported by userspace tools dns.upcall, cifs.upcall and
 request-key.  It is under development and does not yet provide the full feature
 set.  The features it does support include:
 
- (*) Implements the dns_resolver key_type to contact userspace.
+ * Implements the dns_resolver key_type to contact userspace.
 
 It does not yet support the following AFS features:
 
- (*) Dns query support for AFSDB resource record.
+ * DNS query support for AFSDB resource record.
 
 This code is extracted from the CIFS filesystem.
 
-- 
An old man doll... just what I always wanted! - Clara

[PATCH net-next 2/3] net: dns_resolver: Move dns_query() explanation out of code block

[Bagas Sanjaya]

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@gmail.com>
---
 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::
 
 	#include <linux/dns_resolver.h>
 
-     ::
+Then you can make queries by calling::
 
 	int dns_query(const char *type, const char *name, size_t namelen,
 		     const char *options, char **_result, time_t *_expiry);
 
-     This is the basic access function.  It looks for a cached DNS query and if
-     it doesn't find it, it upcalls to userspace to make a new DNS query, which
-     may then be cached.  The key description is constructed as a string of the
-     form::
+This is the basic access function.  It looks for a cached DNS query and if
+it doesn't find it, it upcalls to userspace to make a new DNS query, which
+may then be cached.  The key description is constructed as a string of the
+form::
 
 		[<type>:]<name>
 
-     where <type> optionally specifies the particular upcall program to invoke,
-     and thus the type of query to do, and <name> specifies the string to be
-     looked up.  The default query type is a straight hostname to IP address
-     set lookup.
+where <type> optionally specifies the particular upcall program to invoke,
+and thus the type of query to do, and <name> specifies the string to be
+looked up.  The default query type is a straight hostname to IP address
+set lookup.
 
-     The name parameter is not required to be a NUL-terminated string, and its
-     length should be given by the namelen argument.
+The name parameter is not required to be a NUL-terminated string, and its
+length should be given by the namelen argument.
 
-     The options parameter may be NULL or it may be a set of options
-     appropriate to the query type.
+The options parameter may be NULL or it may be a set of options
+appropriate to the query type.
 
-     The return value is a string appropriate to the query type.  For instance,
-     for the default query type it is just a list of comma-separated IPv4 and
-     IPv6 addresses.  The caller must free the result.
+The return value is a string appropriate to the query type.  For instance,
+for the default query type it is just a list of comma-separated IPv4 and
+IPv6 addresses.  The caller must free the result.
 
-     The length of the result string is returned on success, and a negative
-     error code is returned otherwise.  -EKEYREJECTED will be returned if the
-     DNS lookup failed.
+The length of the result string is returned on success, and a negative
+error code is returned otherwise.  -EKEYREJECTED will be returned if the
+DNS lookup failed.
 
-     If _expiry is non-NULL, the expiry time (TTL) of the result will be
-     returned also.
+If _expiry is non-NULL, the expiry time (TTL) of the result will be
+returned also.
 
 The kernel maintains an internal keyring in which it caches looked up keys.
 This can be cleared by any process that has the CAP_SYS_ADMIN capability by
-- 
An old man doll... just what I always wanted! - Clara

[PATCH net-next 3/3] net: dns_resolver: Fix request-key cross-reference

[Bagas Sanjaya]

Link to "Key Request Service" docs uses file:// scheme instead due to
angled brackets markup. Fix it to proper cross-reference.

Fixes: 3db38ed76890 ("doc: ReSTify keys-request-key.txt")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/networking/dns_resolver.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/networking/dns_resolver.rst b/Documentation/networking/dns_resolver.rst
index 329fb21d005ccd..18c2af83d5129c 100644
--- a/Documentation/networking/dns_resolver.rst
+++ b/Documentation/networking/dns_resolver.rst
@@ -141,8 +141,8 @@ the key will be discarded and recreated when the data it holds has expired.
 dns_query() returns a copy of the value attached to the key, or an error if
 that is indicated instead.
 
-See <file:Documentation/security/keys/request-key.rst> for further
-information about request-key function.
+See Documentation/security/keys/request-key.rst for further information about
+request-key function.
 
 
 Debugging
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH net-next 1/3] net: dns_resolver: Use reST bullet list for features list

[Simon Horman]

On Mon, Sep 22, 2025 at 04:56:46PM +0700, Bagas Sanjaya wrote:
> Features overview list uses an asterisk in parentheses (``(*)``)
> as bullet list marker, which isn't supported by Sphinx as proper
> bullet. Replace it with just asterisk.
> 
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Thanks,

I visually inspected the html output in a browser and confirmed
that before '(*)' was rendered, and now a bullet is.

Reviewed-by: Simon Horman <horms@kernel.org>

Re: [PATCH net-next 2/3] net: dns_resolver: Move dns_query() explanation out of code block

[Simon Horman]

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@gmail.com>

Thanks, this renders much better. In a browser at least.

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::

>  
>  	int dns_query(const char *type, const char *name, size_t namelen,
>  		     const char *options, char **_result, time_t *_expiry);
>  
> -     This is the basic access function.  It looks for a cached DNS query and if
> -     it doesn't find it, it upcalls to userspace to make a new DNS query, which
> -     may then be cached.  The key description is constructed as a string of the
> -     form::
> +This is the basic access function.  It looks for a cached DNS query and if
> +it doesn't find it, it upcalls to userspace to make a new DNS query, which
> +may then be cached.  The key description is constructed as a string of the
> +form::
>  
>  		[<type>:]<name>
>  
> -     where <type> optionally specifies the particular upcall program to invoke,
> -     and thus the type of query to do, and <name> specifies the string to be
> -     looked up.  The default query type is a straight hostname to IP address
> -     set lookup.
> +where <type> optionally specifies the particular upcall program to invoke,
> +and thus the type of query to do, and <name> specifies the string to be

I think while we are here "to do" could be removed.
But maybe that's just me.

> +looked up.  The default query type is a straight hostname to IP address
> +set lookup.

...

Re: [PATCH net-next 3/3] net: dns_resolver: Fix request-key cross-reference

[Simon Horman]

On Mon, Sep 22, 2025 at 04:56:48PM +0700, Bagas Sanjaya wrote:
> Link to "Key Request Service" docs uses file:// scheme instead due to
> angled brackets markup. Fix it to proper cross-reference.
> 
> Fixes: 3db38ed76890 ("doc: ReSTify keys-request-key.txt")
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Thanks,

I visually inspected the html output in a browser and confirmed
the both the name and link for cross-reference is now correct.

Reviewed-by: Simon Horman <horms@kernel.org>

Re: [PATCH net-next 2/3] net: dns_resolver: Move dns_query() explanation out of code block

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 3014 bytes --]

On Tue, Sep 23, 2025 at 11:14:56AM +0100, 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@gmail.com>
> 
> Thanks, this renders much better. In a browser at least.
> 
> 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::
> 
> >  
> >  	int dns_query(const char *type, const char *name, size_t namelen,
> >  		     const char *options, char **_result, time_t *_expiry);
> >  
> > -     This is the basic access function.  It looks for a cached DNS query and if
> > -     it doesn't find it, it upcalls to userspace to make a new DNS query, which
> > -     may then be cached.  The key description is constructed as a string of the
> > -     form::
> > +This is the basic access function.  It looks for a cached DNS query and if
> > +it doesn't find it, it upcalls to userspace to make a new DNS query, which
> > +may then be cached.  The key description is constructed as a string of the
> > +form::
> >  
> >  		[<type>:]<name>
> >  
> > -     where <type> optionally specifies the particular upcall program to invoke,
> > -     and thus the type of query to do, and <name> specifies the string to be
> > -     looked up.  The default query type is a straight hostname to IP address
> > -     set lookup.
> > +where <type> optionally specifies the particular upcall program to invoke,
> > +and thus the type of query to do, and <name> specifies the string to be
> 
> I think while we are here "to do" could be removed.
> But maybe that's just me.
> 
> > +looked up.  The default query type is a straight hostname to IP address
> > +set lookup.
> 
> ...

Thanks for the wording suggestions! I'll apply them in v2.

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

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH net-next 2/3] net: dns_resolver: Move dns_query() explanation out of code block

[Randy Dunlap]

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@gmail.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

Re: [PATCH net-next 2/3] net: dns_resolver: Move dns_query() explanation out of code block

[Simon Horman]

On Tue, Sep 23, 2025 at 10:00:55PM -0700, Randy Dunlap wrote:
> Hi,
> 
> On 9/23/25 3:14 AM, Simon Horman wrote:
> > On Mon, Sep 22, 2025 at 04:56:47PM +0700, Bagas Sanjaya wrote:

...

> > > +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.

Thanks Randy,

Sorry for my incorrect advice.

I also agree that a v3 isn't necessary just for this.