* [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 07/38] docs: networking: convert ax25.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 07/38] docs: networking: convert ax25.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, Ralf Baechle, netdev, linux-hams
There isn't much to be done here. Just:
- add SPDX header;
- add a document title.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/networking/{ax25.txt => ax25.rst} | 6 ++++++
Documentation/networking/index.rst | 1 +
net/ax25/Kconfig | 6 +++---
3 files changed, 10 insertions(+), 3 deletions(-)
rename Documentation/networking/{ax25.txt => ax25.rst} (91%)
diff --git a/Documentation/networking/ax25.txt b/Documentation/networking/ax25.rst
similarity index 91%
rename from Documentation/networking/ax25.txt
rename to Documentation/networking/ax25.rst
index 8257dbf9be57..824afd7002db 100644
--- a/Documentation/networking/ax25.txt
+++ b/Documentation/networking/ax25.rst
@@ -1,3 +1,9 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=====
+AX.25
+=====
+
To use the amateur radio protocols within Linux you will need to get a
suitable copy of the AX.25 Utilities. More detailed information about
AX.25, NET/ROM and ROSE, associated programs and and utilities can be
diff --git a/Documentation/networking/index.rst b/Documentation/networking/index.rst
index 841f3c3905d5..6a5858b27cf6 100644
--- a/Documentation/networking/index.rst
+++ b/Documentation/networking/index.rst
@@ -42,6 +42,7 @@ Contents:
arcnet-hardware
arcnet
atm
+ ax25
.. only:: subproject and html
diff --git a/net/ax25/Kconfig b/net/ax25/Kconfig
index 043fd5437809..97d686d115c0 100644
--- a/net/ax25/Kconfig
+++ b/net/ax25/Kconfig
@@ -40,7 +40,7 @@ config AX25
radio as well as information about how to configure an AX.25 port is
contained in the AX25-HOWTO, available from
<http://www.tldp.org/docs.html#howto>. You might also want to
- check out the file <file:Documentation/networking/ax25.txt> in the
+ check out the file <file:Documentation/networking/ax25.rst> in the
kernel source. More information about digital amateur radio in
general is on the WWW at
<http://www.tapr.org/>.
@@ -88,7 +88,7 @@ config NETROM
users as well as information about how to configure an AX.25 port is
contained in the Linux Ham Wiki, available from
<http://www.linux-ax25.org>. You also might want to check out the
- file <file:Documentation/networking/ax25.txt>. More information about
+ file <file:Documentation/networking/ax25.rst>. More information about
digital amateur radio in general is on the WWW at
<http://www.tapr.org/>.
@@ -107,7 +107,7 @@ config ROSE
users as well as information about how to configure an AX.25 port is
contained in the Linux Ham Wiki, available from
<http://www.linux-ax25.org>. You also might want to check out the
- file <file:Documentation/networking/ax25.txt>. More information about
+ file <file:Documentation/networking/ax25.rst>. More information about
digital amateur radio in general is on the WWW at
<http://www.tapr.org/>.
--
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 07/38] docs: networking: convert ax25.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 07/38] docs: networking: convert ax25.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 07/38] docs: networking: convert ax25.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).