* [PATCH 00/38] net: manually convert files to ReST format - part 1
@ 2020-04-27 22:01 Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 17/38] docs: networking: convert dns_resolver.txt to ReST Mauro Carvalho Chehab
` (2 more replies)
0 siblings, 3 replies; 5+ messages in thread
From: Mauro Carvalho Chehab @ 2020-04-27 22:01 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet, netdev,
linux-hams, intel-wired-lan, linux-decnet-user, ceph-devel, bpf,
linux-atm-general, lvs-devel
There are very few documents upstream that aren't converted upstream.
This series convert part of the networking text files into ReST.
It is part of a bigger set of patches, which were split on parts,
in order to make reviewing task easier.
The full series (including those ones) are at:
https://git.linuxtv.org/mchehab/experimental.git/log/?h=net-docs
And the documents, converted to HTML via the building system
are at:
https://www.infradead.org/~mchehab/kernel_docs/networking/
Mauro Carvalho Chehab (38):
docs: networking: convert caif files to ReST
docs: networking: convert 6pack.txt to ReST
docs: networking: convert altera_tse.txt to ReST
docs: networking: convert arcnet-hardware.txt to ReST
docs: networking: convert arcnet.txt to ReST
docs: networking: convert atm.txt to ReST
docs: networking: convert ax25.txt to ReST
docs: networking: convert baycom.txt to ReST
docs: networking: convert bonding.txt to ReST
docs: networking: convert cdc_mbim.txt to ReST
docs: networking: convert cops.txt to ReST
docs: networking: convert cxacru.txt to ReST
docs: networking: convert dccp.txt to ReST
docs: networking: convert dctcp.txt to ReST
docs: networking: convert decnet.txt to ReST
docs: networking: convert defza.txt to ReST
docs: networking: convert dns_resolver.txt to ReST
docs: networking: convert driver.txt to ReST
docs: networking: convert eql.txt to ReST
docs: networking: convert fib_trie.txt to ReST
docs: networking: convert filter.txt to ReST
docs: networking: convert fore200e.txt to ReST
docs: networking: convert framerelay.txt to ReST
docs: networking: convert generic-hdlc.txt to ReST
docs: networking: convert generic_netlink.txt to ReST
docs: networking: convert gen_stats.txt to ReST
docs: networking: convert gtp.txt to ReST
docs: networking: convert hinic.txt to ReST
docs: networking: convert ila.txt to ReST
docs: networking: convert ipddp.txt to ReST
docs: networking: convert ip_dynaddr.txt to ReST
docs: networking: convert iphase.txt to ReST
docs: networking: convert ipsec.txt to ReST
docs: networking: convert ip-sysctl.txt to ReST
docs: networking: convert ipv6.txt to ReST
docs: networking: convert ipvlan.txt to ReST
docs: networking: convert ipvs-sysctl.txt to ReST
docs: networking: convert kcm.txt to ReST
.../admin-guide/kernel-parameters.txt | 10 +-
Documentation/admin-guide/sysctl/net.rst | 4 +-
Documentation/bpf/index.rst | 4 +-
.../networking/{6pack.txt => 6pack.rst} | 46 +-
.../{altera_tse.txt => altera_tse.rst} | 87 +-
...rcnet-hardware.txt => arcnet-hardware.rst} | 2169 +++++++++--------
.../networking/{arcnet.txt => arcnet.rst} | 348 +--
Documentation/networking/{atm.txt => atm.rst} | 6 +
.../networking/{ax25.txt => ax25.rst} | 6 +
.../networking/{baycom.txt => baycom.rst} | 110 +-
.../networking/{bonding.txt => bonding.rst} | 1275 +++++-----
Documentation/networking/caif/caif.rst | 2 -
Documentation/networking/caif/index.rst | 13 +
.../caif/{Linux-CAIF.txt => linux_caif.rst} | 54 +-
Documentation/networking/caif/spi_porting.rst | 229 ++
Documentation/networking/caif/spi_porting.txt | 208 --
.../networking/{cdc_mbim.txt => cdc_mbim.rst} | 76 +-
Documentation/networking/cops.rst | 80 +
Documentation/networking/cops.txt | 63 -
.../networking/{cxacru.txt => cxacru.rst} | 86 +-
.../networking/{dccp.txt => dccp.rst} | 39 +-
.../networking/{dctcp.txt => dctcp.rst} | 14 +-
.../networking/{decnet.txt => decnet.rst} | 77 +-
.../networking/{defza.txt => defza.rst} | 8 +-
.../networking/device_drivers/intel/e100.rst | 2 +-
.../networking/device_drivers/intel/ixgb.rst | 2 +-
.../{dns_resolver.txt => dns_resolver.rst} | 52 +-
.../networking/{driver.txt => driver.rst} | 22 +-
Documentation/networking/{eql.txt => eql.rst} | 445 ++--
.../networking/{fib_trie.txt => fib_trie.rst} | 16 +-
.../networking/{filter.txt => filter.rst} | 850 ++++---
.../networking/{fore200e.txt => fore200e.rst} | 8 +-
.../{framerelay.txt => framerelay.rst} | 21 +-
.../{gen_stats.txt => gen_stats.rst} | 98 +-
.../{generic-hdlc.txt => generic-hdlc.rst} | 86 +-
...eneric_netlink.txt => generic_netlink.rst} | 6 +
Documentation/networking/{gtp.txt => gtp.rst} | 95 +-
.../networking/{hinic.txt => hinic.rst} | 5 +-
Documentation/networking/{ila.txt => ila.rst} | 81 +-
Documentation/networking/index.rst | 38 +
.../{ip-sysctl.txt => ip-sysctl.rst} | 829 ++++---
.../{ip_dynaddr.txt => ip_dynaddr.rst} | 29 +-
.../networking/{ipddp.txt => ipddp.rst} | 13 +-
.../networking/{iphase.txt => iphase.rst} | 185 +-
.../networking/{ipsec.txt => ipsec.rst} | 14 +-
.../networking/{ipv6.txt => ipv6.rst} | 8 +-
.../networking/{ipvlan.txt => ipvlan.rst} | 159 +-
.../{ipvs-sysctl.txt => ipvs-sysctl.rst} | 180 +-
Documentation/networking/{kcm.txt => kcm.rst} | 83 +-
Documentation/networking/ltpc.txt | 2 +-
Documentation/networking/packet_mmap.txt | 2 +-
Documentation/networking/snmp_counter.rst | 2 +-
MAINTAINERS | 8 +-
drivers/atm/Kconfig | 4 +-
drivers/net/Kconfig | 4 +-
drivers/net/appletalk/Kconfig | 6 +-
drivers/net/arcnet/Kconfig | 6 +-
drivers/net/caif/Kconfig | 2 +-
drivers/net/hamradio/Kconfig | 10 +-
drivers/net/wan/Kconfig | 4 +-
net/Kconfig | 2 +-
net/atm/Kconfig | 2 +-
net/ax25/Kconfig | 6 +-
net/ceph/Kconfig | 2 +-
net/core/gen_stats.c | 2 +-
net/decnet/Kconfig | 4 +-
net/dns_resolver/Kconfig | 2 +-
net/dns_resolver/dns_key.c | 2 +-
net/dns_resolver/dns_query.c | 2 +-
net/ipv4/Kconfig | 2 +-
net/ipv4/icmp.c | 2 +-
net/ipv6/Kconfig | 2 +-
tools/bpf/bpf_asm.c | 2 +-
tools/bpf/bpf_dbg.c | 2 +-
74 files changed, 4656 insertions(+), 3769 deletions(-)
rename Documentation/networking/{6pack.txt => 6pack.rst} (90%)
rename Documentation/networking/{altera_tse.txt => altera_tse.rst} (85%)
rename Documentation/networking/{arcnet-hardware.txt => arcnet-hardware.rst} (66%)
rename Documentation/networking/{arcnet.txt => arcnet.rst} (76%)
rename Documentation/networking/{atm.txt => atm.rst} (89%)
rename Documentation/networking/{ax25.txt => ax25.rst} (91%)
rename Documentation/networking/{baycom.txt => baycom.rst} (58%)
rename Documentation/networking/{bonding.txt => bonding.rst} (75%)
create mode 100644 Documentation/networking/caif/index.rst
rename Documentation/networking/caif/{Linux-CAIF.txt => linux_caif.rst} (90%)
create mode 100644 Documentation/networking/caif/spi_porting.rst
delete mode 100644 Documentation/networking/caif/spi_porting.txt
rename Documentation/networking/{cdc_mbim.txt => cdc_mbim.rst} (88%)
create mode 100644 Documentation/networking/cops.rst
delete mode 100644 Documentation/networking/cops.txt
rename Documentation/networking/{cxacru.txt => cxacru.rst} (66%)
rename Documentation/networking/{dccp.txt => dccp.rst} (94%)
rename Documentation/networking/{dctcp.txt => dctcp.rst} (89%)
rename Documentation/networking/{decnet.txt => decnet.rst} (87%)
rename Documentation/networking/{defza.txt => defza.rst} (91%)
rename Documentation/networking/{dns_resolver.txt => dns_resolver.rst} (89%)
rename Documentation/networking/{driver.txt => driver.rst} (85%)
rename Documentation/networking/{eql.txt => eql.rst} (62%)
rename Documentation/networking/{fib_trie.txt => fib_trie.rst} (96%)
rename Documentation/networking/{filter.txt => filter.rst} (77%)
rename Documentation/networking/{fore200e.txt => fore200e.rst} (94%)
rename Documentation/networking/{framerelay.txt => framerelay.rst} (93%)
rename Documentation/networking/{gen_stats.txt => gen_stats.rst} (60%)
rename Documentation/networking/{generic-hdlc.txt => generic-hdlc.rst} (75%)
rename Documentation/networking/{generic_netlink.txt => generic_netlink.rst} (64%)
rename Documentation/networking/{gtp.txt => gtp.rst} (79%)
rename Documentation/networking/{hinic.txt => hinic.rst} (97%)
rename Documentation/networking/{ila.txt => ila.rst} (82%)
rename Documentation/networking/{ip-sysctl.txt => ip-sysctl.rst} (83%)
rename Documentation/networking/{ip_dynaddr.txt => ip_dynaddr.rst} (65%)
rename Documentation/networking/{ipddp.txt => ipddp.rst} (89%)
rename Documentation/networking/{iphase.txt => iphase.rst} (50%)
rename Documentation/networking/{ipsec.txt => ipsec.rst} (90%)
rename Documentation/networking/{ipv6.txt => ipv6.rst} (93%)
rename Documentation/networking/{ipvlan.txt => ipvlan.rst} (54%)
rename Documentation/networking/{ipvs-sysctl.txt => ipvs-sysctl.rst} (62%)
rename Documentation/networking/{kcm.txt => kcm.rst} (84%)
--
2.25.4
^ permalink raw reply [flat|nested] 5+ messages in thread
* [PATCH 17/38] docs: networking: convert dns_resolver.txt to ReST
2020-04-27 22:01 [PATCH 00/38] net: manually convert files to ReST format - part 1 Mauro Carvalho Chehab
@ 2020-04-27 22:01 ` Mauro Carvalho Chehab
2020-04-28 20:11 ` [PATCH 00/38] net: manually convert files to ReST format - part 1 David Miller
2020-04-28 21:40 ` David Miller
2 siblings, 0 replies; 5+ messages in thread
From: Mauro Carvalho Chehab @ 2020-04-27 22:01 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet,
David S. Miller, Jakub Kicinski, Ilya Dryomov, Jeff Layton,
Sage Weil, netdev, ceph-devel
- add SPDX header;
- adjust titles and chapters, adding proper markups;
- comment out text-only TOC from html/pdf output;
- mark code blocks and literals as such;
- adjust identation, whitespaces and blank lines;
- add to networking/index.rst.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
.../{dns_resolver.txt => dns_resolver.rst} | 52 +++++++++----------
Documentation/networking/index.rst | 1 +
net/ceph/Kconfig | 2 +-
net/dns_resolver/Kconfig | 2 +-
net/dns_resolver/dns_key.c | 2 +-
net/dns_resolver/dns_query.c | 2 +-
6 files changed, 30 insertions(+), 31 deletions(-)
rename Documentation/networking/{dns_resolver.txt => dns_resolver.rst} (89%)
diff --git a/Documentation/networking/dns_resolver.txt b/Documentation/networking/dns_resolver.rst
similarity index 89%
rename from Documentation/networking/dns_resolver.txt
rename to Documentation/networking/dns_resolver.rst
index eaa8f9a6fd5d..add4d59a99a5 100644
--- a/Documentation/networking/dns_resolver.txt
+++ b/Documentation/networking/dns_resolver.rst
@@ -1,8 +1,10 @@
- ===================
- DNS Resolver Module
- ===================
+.. SPDX-License-Identifier: GPL-2.0
-Contents:
+===================
+DNS Resolver Module
+===================
+
+.. Contents:
- Overview.
- Compilation.
@@ -12,8 +14,7 @@ Contents:
- Debugging.
-========
-OVERVIEW
+Overview
========
The DNS resolver module provides a way for kernel services to make DNS queries
@@ -33,50 +34,50 @@ It does not yet support the following AFS features:
This code is extracted from the CIFS filesystem.
-===========
-COMPILATION
+Compilation
===========
-The module should be enabled by turning on the kernel configuration options:
+The module should be enabled by turning on the kernel configuration options::
CONFIG_DNS_RESOLVER - tristate "DNS Resolver support"
-==========
-SETTING UP
+Setting up
==========
To set up this facility, the /etc/request-key.conf file must be altered so that
/sbin/request-key can appropriately direct the upcalls. For example, to handle
basic dname to IPv4/IPv6 address resolution, the following line should be
-added:
+added::
+
#OP TYPE DESC CO-INFO PROGRAM ARG1 ARG2 ARG3 ...
#====== ============ ======= ======= ==========================
create dns_resolver * * /usr/sbin/cifs.upcall %k
To direct a query for query type 'foo', a line of the following should be added
-before the more general line given above as the first match is the one taken.
+before the more general line given above as the first match is the one taken::
create dns_resolver foo:* * /usr/sbin/dns.foo %k
-=====
-USAGE
+Usage
=====
To make use of this facility, one of the following functions that are
-implemented in the module can be called after doing:
+implemented in the module can be called after doing::
#include <linux/dns_resolver.h>
- (1) int dns_query(const char *type, const char *name, size_t namelen,
- const char *options, char **_result, time_t *_expiry);
+ ::
+
+ 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:
+ form::
[<type>:]<name>
@@ -107,16 +108,14 @@ This can be cleared by any process that has the CAP_SYS_ADMIN capability by
the use of KEYCTL_KEYRING_CLEAR on the keyring ID.
-===============================
-READING DNS KEYS FROM USERSPACE
+Reading DNS Keys from Userspace
===============================
Keys of dns_resolver type can be read from userspace using keyctl_read() or
"keyctl read/print/pipe".
-=========
-MECHANISM
+Mechanism
=========
The dnsresolver module registers a key type called "dns_resolver". Keys of
@@ -147,11 +146,10 @@ See <file:Documentation/security/keys/request-key.rst> for further
information about request-key function.
-=========
-DEBUGGING
+Debugging
=========
Debugging messages can be turned on dynamically by writing a 1 into the
-following file:
+following file::
- /sys/module/dnsresolver/parameters/debug
+ /sys/module/dnsresolver/parameters/debug
diff --git a/Documentation/networking/index.rst b/Documentation/networking/index.rst
index c893127004b9..55746038a7e9 100644
--- a/Documentation/networking/index.rst
+++ b/Documentation/networking/index.rst
@@ -52,6 +52,7 @@ Contents:
dctcp
decnet
defza
+ dns_resolver
.. only:: subproject and html
diff --git a/net/ceph/Kconfig b/net/ceph/Kconfig
index 2e8e6f904920..d7bec7adc267 100644
--- a/net/ceph/Kconfig
+++ b/net/ceph/Kconfig
@@ -39,6 +39,6 @@ config CEPH_LIB_USE_DNS_RESOLVER
be resolved using the CONFIG_DNS_RESOLVER facility.
For information on how to use CONFIG_DNS_RESOLVER consult
- Documentation/networking/dns_resolver.txt
+ Documentation/networking/dns_resolver.rst
If unsure, say N.
diff --git a/net/dns_resolver/Kconfig b/net/dns_resolver/Kconfig
index 0a1c2238b4bd..255df9b6e9e8 100644
--- a/net/dns_resolver/Kconfig
+++ b/net/dns_resolver/Kconfig
@@ -19,7 +19,7 @@ config DNS_RESOLVER
SMB2 later. DNS Resolver is supported by the userspace upcall
helper "/sbin/dns.resolver" via /etc/request-key.conf.
- See <file:Documentation/networking/dns_resolver.txt> for further
+ See <file:Documentation/networking/dns_resolver.rst> for further
information.
To compile this as a module, choose M here: the module will be called
diff --git a/net/dns_resolver/dns_key.c b/net/dns_resolver/dns_key.c
index ad53eb31d40f..3aced951d5ab 100644
--- a/net/dns_resolver/dns_key.c
+++ b/net/dns_resolver/dns_key.c
@@ -1,6 +1,6 @@
/* Key type used to cache DNS lookups made by the kernel
*
- * See Documentation/networking/dns_resolver.txt
+ * See Documentation/networking/dns_resolver.rst
*
* Copyright (c) 2007 Igor Mammedov
* Author(s): Igor Mammedov (niallain@gmail.com)
diff --git a/net/dns_resolver/dns_query.c b/net/dns_resolver/dns_query.c
index cab4e0df924f..82b084cc1cc6 100644
--- a/net/dns_resolver/dns_query.c
+++ b/net/dns_resolver/dns_query.c
@@ -1,7 +1,7 @@
/* Upcall routine, designed to work as a key type and working through
* /sbin/request-key to contact userspace when handling DNS queries.
*
- * See Documentation/networking/dns_resolver.txt
+ * See Documentation/networking/dns_resolver.rst
*
* Copyright (c) 2007 Igor Mammedov
* Author(s): Igor Mammedov (niallain@gmail.com)
--
2.25.4
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH 00/38] net: manually convert files to ReST format - part 1
2020-04-27 22:01 [PATCH 00/38] net: manually convert files to ReST format - part 1 Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 17/38] docs: networking: convert dns_resolver.txt to ReST Mauro Carvalho Chehab
@ 2020-04-28 20:11 ` David Miller
2020-04-28 20:15 ` Jonathan Corbet
2020-04-28 21:40 ` David Miller
2 siblings, 1 reply; 5+ messages in thread
From: David Miller @ 2020-04-28 20:11 UTC (permalink / raw)
To: mchehab+huawei
Cc: linux-doc, linux-kernel, corbet, netdev, linux-hams,
intel-wired-lan, linux-decnet-user, ceph-devel, bpf,
linux-atm-general, lvs-devel
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Date: Tue, 28 Apr 2020 00:01:15 +0200
> There are very few documents upstream that aren't converted upstream.
>
> This series convert part of the networking text files into ReST.
> It is part of a bigger set of patches, which were split on parts,
> in order to make reviewing task easier.
>
> The full series (including those ones) are at:
>
> https://git.linuxtv.org/mchehab/experimental.git/log/?h=net-docs
>
> And the documents, converted to HTML via the building system
> are at:
>
> https://www.infradead.org/~mchehab/kernel_docs/networking/
These look good as far as I can tell.
Jon, do you mind if I merge this via the networking tree?
Thanks.
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH 00/38] net: manually convert files to ReST format - part 1
2020-04-28 20:11 ` [PATCH 00/38] net: manually convert files to ReST format - part 1 David Miller
@ 2020-04-28 20:15 ` Jonathan Corbet
0 siblings, 0 replies; 5+ messages in thread
From: Jonathan Corbet @ 2020-04-28 20:15 UTC (permalink / raw)
To: David Miller
Cc: mchehab+huawei, linux-doc, linux-kernel, netdev, linux-hams,
intel-wired-lan, linux-decnet-user, ceph-devel, bpf,
linux-atm-general, lvs-devel
On Tue, 28 Apr 2020 13:11:43 -0700 (PDT)
David Miller <davem@davemloft.net> wrote:
> Jon, do you mind if I merge this via the networking tree?
Not at all, that's what I was expecting you would do.
Thanks,
jon
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH 00/38] net: manually convert files to ReST format - part 1
2020-04-27 22:01 [PATCH 00/38] net: manually convert files to ReST format - part 1 Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 17/38] docs: networking: convert dns_resolver.txt to ReST Mauro Carvalho Chehab
2020-04-28 20:11 ` [PATCH 00/38] net: manually convert files to ReST format - part 1 David Miller
@ 2020-04-28 21:40 ` David Miller
2 siblings, 0 replies; 5+ messages in thread
From: David Miller @ 2020-04-28 21:40 UTC (permalink / raw)
To: mchehab+huawei
Cc: linux-doc, linux-kernel, corbet, netdev, linux-hams,
intel-wired-lan, linux-decnet-user, ceph-devel, bpf,
linux-atm-general, lvs-devel
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Date: Tue, 28 Apr 2020 00:01:15 +0200
> There are very few documents upstream that aren't converted upstream.
>
> This series convert part of the networking text files into ReST.
> It is part of a bigger set of patches, which were split on parts,
> in order to make reviewing task easier.
>
> The full series (including those ones) are at:
>
> https://git.linuxtv.org/mchehab/experimental.git/log/?h=net-docs
>
> And the documents, converted to HTML via the building system
> are at:
>
> https://www.infradead.org/~mchehab/kernel_docs/networking/
Series applied to net-next, thank you.
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2020-04-28 21:40 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-04-27 22:01 [PATCH 00/38] net: manually convert files to ReST format - part 1 Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 17/38] docs: networking: convert dns_resolver.txt to ReST Mauro Carvalho Chehab
2020-04-28 20:11 ` [PATCH 00/38] net: manually convert files to ReST format - part 1 David Miller
2020-04-28 20:15 ` Jonathan Corbet
2020-04-28 21:40 ` David Miller
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).