docs: networking: convert ipv6.txt to ReST
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Mon, 27 Apr 2020 22:01:50 +0000 (00:01 +0200)
committerDavid S. Miller <davem@davemloft.net>
Tue, 28 Apr 2020 21:40:18 +0000 (14:40 -0700)
Not much to be done here:

- add SPDX header;
- add a document title;
- mark a literal as such, in order to avoid a warning;
- add to networking/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: David S. Miller <davem@davemloft.net>
Documentation/admin-guide/kernel-parameters.txt
Documentation/networking/index.rst
Documentation/networking/ipv6.rst [new file with mode: 0644]
Documentation/networking/ipv6.txt [deleted file]
net/ipv6/Kconfig

index e37db6f1be64cfc7a13df948a1724e1c68f66e41..e43f2e1f295845f8f789a7bf09997db53441b729 100644 (file)
                              shot down by NMI
 
        autoconf=       [IPV6]
-                       See Documentation/networking/ipv6.txt.
+                       See Documentation/networking/ipv6.rst.
 
        show_lapic=     [APIC,X86] Advanced Programmable Interrupt Controller
                        Limit apic dumping. The parameter defines the maximal
                        miss to occur.
 
        disable=        [IPV6]
-                       See Documentation/networking/ipv6.txt.
+                       See Documentation/networking/ipv6.rst.
 
        hardened_usercopy=
                         [KNL] Under CONFIG_HARDENED_USERCOPY, whether
                        to workaround buggy firmware.
 
        disable_ipv6=   [IPV6]
-                       See Documentation/networking/ipv6.txt.
+                       See Documentation/networking/ipv6.rst.
 
        disable_mtrr_cleanup [X86]
                        The kernel tries to adjust MTRR layout from continuous
index 7d133d8dbe2aba6108666546cb0233bb3945b90d..709675464e518e0d8be81aa63ee03e4d24dfc45a 100644 (file)
@@ -70,6 +70,7 @@ Contents:
    iphase
    ipsec
    ip-sysctl
+   ipv6
 
 .. only::  subproject and html
 
diff --git a/Documentation/networking/ipv6.rst b/Documentation/networking/ipv6.rst
new file mode 100644 (file)
index 0000000..ba09c2f
--- /dev/null
@@ -0,0 +1,78 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+====
+IPv6
+====
+
+
+Options for the ipv6 module are supplied as parameters at load time.
+
+Module options may be given as command line arguments to the insmod
+or modprobe command, but are usually specified in either
+``/etc/modules.d/*.conf`` configuration files, or in a distro-specific
+configuration file.
+
+The available ipv6 module parameters are listed below.  If a parameter
+is not specified the default value is used.
+
+The parameters are as follows:
+
+disable
+
+       Specifies whether to load the IPv6 module, but disable all
+       its functionality.  This might be used when another module
+       has a dependency on the IPv6 module being loaded, but no
+       IPv6 addresses or operations are desired.
+
+       The possible values and their effects are:
+
+       0
+               IPv6 is enabled.
+
+               This is the default value.
+
+       1
+               IPv6 is disabled.
+
+               No IPv6 addresses will be added to interfaces, and
+               it will not be possible to open an IPv6 socket.
+
+               A reboot is required to enable IPv6.
+
+autoconf
+
+       Specifies whether to enable IPv6 address autoconfiguration
+       on all interfaces.  This might be used when one does not wish
+       for addresses to be automatically generated from prefixes
+       received in Router Advertisements.
+
+       The possible values and their effects are:
+
+       0
+               IPv6 address autoconfiguration is disabled on all interfaces.
+
+               Only the IPv6 loopback address (::1) and link-local addresses
+               will be added to interfaces.
+
+       1
+               IPv6 address autoconfiguration is enabled on all interfaces.
+
+               This is the default value.
+
+disable_ipv6
+
+       Specifies whether to disable IPv6 on all interfaces.
+       This might be used when no IPv6 addresses are desired.
+
+       The possible values and their effects are:
+
+       0
+               IPv6 is enabled on all interfaces.
+
+               This is the default value.
+
+       1
+               IPv6 is disabled on all interfaces.
+
+               No IPv6 addresses will be added to interfaces.
+
diff --git a/Documentation/networking/ipv6.txt b/Documentation/networking/ipv6.txt
deleted file mode 100644 (file)
index 6cd74fa..0000000
+++ /dev/null
@@ -1,72 +0,0 @@
-
-Options for the ipv6 module are supplied as parameters at load time.
-
-Module options may be given as command line arguments to the insmod
-or modprobe command, but are usually specified in either
-/etc/modules.d/*.conf configuration files, or in a distro-specific
-configuration file.
-
-The available ipv6 module parameters are listed below.  If a parameter
-is not specified the default value is used.
-
-The parameters are as follows:
-
-disable
-
-       Specifies whether to load the IPv6 module, but disable all
-       its functionality.  This might be used when another module
-       has a dependency on the IPv6 module being loaded, but no
-       IPv6 addresses or operations are desired.
-
-       The possible values and their effects are:
-
-       0
-               IPv6 is enabled.
-
-               This is the default value.
-
-       1
-               IPv6 is disabled.
-
-               No IPv6 addresses will be added to interfaces, and
-               it will not be possible to open an IPv6 socket.
-
-               A reboot is required to enable IPv6.
-
-autoconf
-
-       Specifies whether to enable IPv6 address autoconfiguration
-       on all interfaces.  This might be used when one does not wish
-       for addresses to be automatically generated from prefixes
-       received in Router Advertisements.
-
-       The possible values and their effects are:
-
-       0
-               IPv6 address autoconfiguration is disabled on all interfaces.
-
-               Only the IPv6 loopback address (::1) and link-local addresses
-               will be added to interfaces.
-
-       1
-               IPv6 address autoconfiguration is enabled on all interfaces.
-
-               This is the default value.
-
-disable_ipv6
-
-       Specifies whether to disable IPv6 on all interfaces.
-       This might be used when no IPv6 addresses are desired.
-
-       The possible values and their effects are:
-
-       0
-               IPv6 is enabled on all interfaces.
-
-               This is the default value.
-
-       1
-               IPv6 is disabled on all interfaces.
-
-               No IPv6 addresses will be added to interfaces.
-
index 2ccaee98fddbff881e7dfee237504962f11077fa..5a6111da26c47e20faad4bd02405c45b2d3dc588 100644 (file)
@@ -13,7 +13,7 @@ menuconfig IPV6
          For general information about IPv6, see
          <https://en.wikipedia.org/wiki/IPv6>.
          For specific information about IPv6 under Linux, see
-         Documentation/networking/ipv6.txt and read the HOWTO at
+         Documentation/networking/ipv6.rst and read the HOWTO at
          <http://www.tldp.org/HOWTO/Linux+IPv6-HOWTO/>
 
          To compile this protocol support as a module, choose M here: the