Commit 1b1fe672 authored by Bagas Sanjaya's avatar Bagas Sanjaya Committed by Jakub Kicinski
Browse files

net: dns_resolver: Move dns_query() explanation out of code block 



Documentation for dns_query() is placed in the function's literal code
block snippet instead. Move it out of there.

Signed-off-by: default avatarBagas Sanjaya <bagasdotme@gmail.com>
Reviewed-by: default avatarSimon Horman <horms@kernel.org>
Link: https://patch.msgid.link/20250924020626.17073-3-bagasdotme@gmail.com


Signed-off-by: default avatarJakub Kicinski <kuba@kernel.org>
parent 84a27b5a

Documentation/networking/dns_resolver.rst

+21 −23
Original line number Diff line number Diff line
@@ -64,12 +64,11 @@ 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, first ``dns_resolver.h`` must be included::



	#include <linux/dns_resolver.h>



     ::

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);
@@ -82,9 +81,8 @@ implemented in the module can be called after doing:: 
		[<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.

and thus the type of query, 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.