Thread (10 messages) 10 messages, 3 authors, 2025-09-25

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

From: Randy Dunlap <hidden>
Date: 2025-09-24 05:00:56
Also in: linux-doc, lkml

Hi,

On 9/23/25 3:14 AM, 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.Hi

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::
I think imperative mood would be more like:

   Then make queries by calling::

but I'm not asking for a v3 patch.


-- 
~Randy
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help