tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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: Jakub Kicinski <kuba@kernel.org>
+25
-27
+25
-27
Documentation/networking/dns_resolver.rst
+25
-27
Documentation/networking/dns_resolver.rst
···
25
25
request-key. It is under development and does not yet provide the full feature
26
26
set. The features it does support include:
27
27
28
-
(*) Implements the dns_resolver key_type to contact userspace.
28
+
* Implements the dns_resolver key_type to contact userspace.
29
29
30
30
It does not yet support the following AFS features:
31
31
32
-
(*) Dns query support for AFSDB resource record.
32
+
* DNS query support for AFSDB resource record.
33
33
34
34
This code is extracted from the CIFS filesystem.
35
35
···
64
64
Usage
65
65
=====
66
66
67
-
To make use of this facility, one of the following functions that are
68
-
implemented in the module can be called after doing::
67
+
To make use of this facility, first ``dns_resolver.h`` must be included::
69
68
70
69
#include <linux/dns_resolver.h>
71
70
72
-
::
71
+
Then queries may be made by calling::
73
72
74
73
int dns_query(const char *type, const char *name, size_t namelen,
75
74
const char *options, char **_result, time_t *_expiry);
76
75
77
-
This is the basic access function. It looks for a cached DNS query and if
78
-
it doesn't find it, it upcalls to userspace to make a new DNS query, which
79
-
may then be cached. The key description is constructed as a string of the
80
-
form::
76
+
This is the basic access function. It looks for a cached DNS query and if
77
+
it doesn't find it, it upcalls to userspace to make a new DNS query, which
78
+
may then be cached. The key description is constructed as a string of the
79
+
form::
81
80
82
81
[<type>:]<name>
83
82
84
-
where <type> optionally specifies the particular upcall program to invoke,
85
-
and thus the type of query to do, and <name> specifies the string to be
86
-
looked up. The default query type is a straight hostname to IP address
87
-
set lookup.
83
+
where <type> optionally specifies the particular upcall program to invoke,
84
+
and thus the type of query, and <name> specifies the string to be looked up.
85
+
The default query type is a straight hostname to IP address set lookup.
88
86
89
-
The name parameter is not required to be a NUL-terminated string, and its
90
-
length should be given by the namelen argument.
87
+
The name parameter is not required to be a NUL-terminated string, and its
88
+
length should be given by the namelen argument.
91
89
92
-
The options parameter may be NULL or it may be a set of options
93
-
appropriate to the query type.
90
+
The options parameter may be NULL or it may be a set of options
91
+
appropriate to the query type.
94
92
95
-
The return value is a string appropriate to the query type. For instance,
96
-
for the default query type it is just a list of comma-separated IPv4 and
97
-
IPv6 addresses. The caller must free the result.
93
+
The return value is a string appropriate to the query type. For instance,
94
+
for the default query type it is just a list of comma-separated IPv4 and
95
+
IPv6 addresses. The caller must free the result.
98
96
99
-
The length of the result string is returned on success, and a negative
100
-
error code is returned otherwise. -EKEYREJECTED will be returned if the
101
-
DNS lookup failed.
97
+
The length of the result string is returned on success, and a negative
98
+
error code is returned otherwise. -EKEYREJECTED will be returned if the
99
+
DNS lookup failed.
102
100
103
-
If _expiry is non-NULL, the expiry time (TTL) of the result will be
104
-
returned also.
101
+
If _expiry is non-NULL, the expiry time (TTL) of the result will be
102
+
returned also.
105
103
106
104
The kernel maintains an internal keyring in which it caches looked up keys.
107
105
This can be cleared by any process that has the CAP_SYS_ADMIN capability by
···
140
142
dns_query() returns a copy of the value attached to the key, or an error if
141
143
that is indicated instead.
142
144
143
-
See <file:Documentation/security/keys/request-key.rst> for further
144
-
information about request-key function.
145
+
See Documentation/security/keys/request-key.rst for further information about
146
+
request-key function.
145
147
146
148
147
149
Debugging