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:

quoted

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

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

I've added a few comments below.

quoted

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

quoted

 
 	#include <linux/dns_resolver.h>
 
-     ::
+Then you can make queries by calling::

Please use imperative mood:

Then queries may be made by calling::

quoted

 
 	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.

quoted

+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