Commit 793adf57 authored by Jakub Kicinski's avatar Jakub Kicinski
Browse files

Merge branch 'dns_resolver-docs-formatting-cleanup' 

Bagas Sanjaya says:

====================
dns_resolver docs formatting cleanup

Here are reST cleanups for DNS Resolver Module documentation.
====================

Link: https://patch.msgid.link/20250924020626.17073-1-bagasdotme@gmail.com


Signed-off-by: default avatarJakub Kicinski <kuba@kernel.org>
parents 4e9510f1 ffa8f079

Documentation/networking/dns_resolver.rst

+25 −27
Original line number Diff line number Diff line
@@ -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.
@@ -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.
@@ -142,8 +140,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