linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: "Jonathan Corbet" <corbet@lwn.net>,
	Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	"Guilherme G. Piccoli" <gpiccoli@canonical.com>,
	Andrew Klychkov <andrew.a.klychkov@gmail.com>,
	Andrew Morton <akpm@linux-foundation.org>,
	Mathieu Chouquet-Stringer <me@mathieu.digital>,
	Qais Yousef <qais.yousef@arm.com>,
	Randy Dunlap <rdunlap@infradead.org>,
	Stephen Kitt <steve@sk2.org>,
	linux-kernel@vger.kernel.org
Subject: [PATCH 09/34] docs: admin-guide: sysctl: avoid using ReST :doc:`foo` markup
Date: Sat,  5 Jun 2021 15:18:08 +0200	[thread overview]
Message-ID: <525173e8ae8bc9bb812ae5e87f64cb2498b87dfe.1622898327.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1622898327.git.mchehab+huawei@kernel.org>

The :doc:`foo` tag is auto-generated via automarkup.py.
So, use the filename at the sources, instead of :doc:`foo`.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/admin-guide/sysctl/abi.rst    |  2 +-
 Documentation/admin-guide/sysctl/kernel.rst | 37 +++++++++++----------
 2 files changed, 21 insertions(+), 18 deletions(-)

diff --git a/Documentation/admin-guide/sysctl/abi.rst b/Documentation/admin-guide/sysctl/abi.rst
index 77b1d1b2ad42..4e6db0a2a4c0 100644
--- a/Documentation/admin-guide/sysctl/abi.rst
+++ b/Documentation/admin-guide/sysctl/abi.rst
@@ -11,7 +11,7 @@ Documentation for /proc/sys/abi/
 
 Copyright (c) 2020, Stephen Kitt
 
-For general info, see :doc:`index`.
+For general info, see Documentation/admin-guide/sysctl/index.rst.
 
 ------------------------------------------------------------------------------
 
diff --git a/Documentation/admin-guide/sysctl/kernel.rst b/Documentation/admin-guide/sysctl/kernel.rst
index c24f57f2c782..10df7fc6495f 100644
--- a/Documentation/admin-guide/sysctl/kernel.rst
+++ b/Documentation/admin-guide/sysctl/kernel.rst
@@ -9,7 +9,8 @@ Copyright (c) 1998, 1999,  Rik van Riel <riel@nl.linux.org>
 
 Copyright (c) 2009,        Shen Feng<shen@cn.fujitsu.com>
 
-For general info and legal blurb, please look in :doc:`index`.
+For general info and legal blurb, please look in
+Documentation/admin-guide/sysctl/index.rst.
 
 ------------------------------------------------------------------------------
 
@@ -54,7 +55,7 @@ free space valid for 30 seconds.
 acpi_video_flags
 ================
 
-See :doc:`/power/video`. This allows the video resume mode to be set,
+See Documentation/power/video.rst. This allows the video resume mode to be set,
 in a similar fashion to the ``acpi_sleep`` kernel parameter, by
 combining the following values:
 
@@ -89,7 +90,7 @@ is 0x15 and the full version number is 0x234, this file will contain
 the value 340 = 0x154.
 
 See the ``type_of_loader`` and ``ext_loader_type`` fields in
-:doc:`/x86/boot` for additional information.
+Documentation/x86/boot.rst for additional information.
 
 
 bootloader_version (x86 only)
@@ -99,7 +100,7 @@ The complete bootloader version number.  In the example above, this
 file will contain the value 564 = 0x234.
 
 See the ``type_of_loader`` and ``ext_loader_ver`` fields in
-:doc:`/x86/boot` for additional information.
+Documentation/x86/boot.rst for additional information.
 
 
 bpf_stats_enabled
@@ -269,7 +270,7 @@ see the ``hostname(1)`` man page.
 firmware_config
 ===============
 
-See :doc:`/driver-api/firmware/fallback-mechanisms`.
+See Documentation/driver-api/firmware/fallback-mechanisms.rst.
 
 The entries in this directory allow the firmware loader helper
 fallback to be controlled:
@@ -297,7 +298,7 @@ crashes and outputting them to a serial console.
 ftrace_enabled, stack_tracer_enabled
 ====================================
 
-See :doc:`/trace/ftrace`.
+See Documentation/trace/ftrace.rst.
 
 
 hardlockup_all_cpu_backtrace
@@ -325,7 +326,7 @@ when a hard lockup is detected.
 1 Panic on hard lockup.
 = ===========================
 
-See :doc:`/admin-guide/lockup-watchdogs` for more information.
+See Documentation/admin-guide/lockup-watchdogs.rst for more information.
 This can also be set using the nmi_watchdog kernel parameter.
 
 
@@ -586,7 +587,8 @@ in a KVM virtual machine. This default can be overridden by adding::
 
    nmi_watchdog=1
 
-to the guest kernel command line (see :doc:`/admin-guide/kernel-parameters`).
+to the guest kernel command line (see
+Documentation/admin-guide/kernel-parameters.rst).
 
 
 numa_balancing
@@ -1071,7 +1073,7 @@ that support this feature.
 real-root-dev
 =============
 
-See :doc:`/admin-guide/initrd`.
+See Documentation/admin-guide/initrd.rst.
 
 
 reboot-cmd (SPARC only)
@@ -1158,7 +1160,7 @@ will take effect.
 seccomp
 =======
 
-See :doc:`/userspace-api/seccomp_filter`.
+See Documentation/userspace-api/seccomp_filter.rst.
 
 
 sg-big-buff
@@ -1329,7 +1331,7 @@ the boot PROM.
 sysrq
 =====
 
-See :doc:`/admin-guide/sysrq`.
+See Documentation/admin-guide/sysrq.rst.
 
 
 tainted
@@ -1359,15 +1361,16 @@ ORed together. The letters are seen in "Tainted" line of Oops reports.
 131072  `(T)`  The kernel was built with the struct randomization plugin
 ======  =====  ==============================================================
 
-See :doc:`/admin-guide/tainted-kernels` for more information.
+See Documentation/admin-guide/tainted-kernels.rst for more information.
 
 Note:
   writes to this sysctl interface will fail with ``EINVAL`` if the kernel is
   booted with the command line option ``panic_on_taint=<bitmask>,nousertaint``
   and any of the ORed together values being written to ``tainted`` match with
   the bitmask declared on panic_on_taint.
-  See :doc:`/admin-guide/kernel-parameters` for more details on that particular
-  kernel command line option and its optional ``nousertaint`` switch.
+  See Documentation/admin-guide/kernel-parameters.rst for more details on
+  that particular kernel command line option and its optional
+  ``nousertaint`` switch.
 
 threads-max
 ===========
@@ -1391,7 +1394,7 @@ If a value outside of this range is written to ``threads-max`` an
 traceoff_on_warning
 ===================
 
-When set, disables tracing (see :doc:`/trace/ftrace`) when a
+When set, disables tracing (see Documentation/trace/ftrace.rst) when a
 ``WARN()`` is hit.
 
 
@@ -1411,8 +1414,8 @@ will send them to printk() again.
 
 This only works if the kernel was booted with ``tp_printk`` enabled.
 
-See :doc:`/admin-guide/kernel-parameters` and
-:doc:`/trace/boottime-trace`.
+See Documentation/admin-guide/kernel-parameters.rst and
+Documentation/trace/boottime-trace.rst.
 
 
 .. _unaligned-dump-stack:
-- 
2.31.1


  parent reply	other threads:[~2021-06-05 13:19 UTC|newest]

Thread overview: 63+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-06-05 13:17 [PATCH 00/34] docs: avoid using ReST :doc:`foo` tag Mauro Carvalho Chehab
2021-06-05 13:18 ` [PATCH 01/34] docs: devices.rst: better reference documentation docs Mauro Carvalho Chehab
2021-06-05 13:18 ` [PATCH 02/34] docs: dev-tools: kunit: don't use a table for docs name Mauro Carvalho Chehab
2021-06-05 15:43   ` David Gow
2021-06-05 16:06     ` Mauro Carvalho Chehab
2021-06-07 20:14   ` Brendan Higgins
2021-06-05 13:18 ` [PATCH 03/34] media: docs: */media/index.rst: don't use ReST doc:`foo` Mauro Carvalho Chehab
2021-06-05 13:18 ` [PATCH 04/34] media: userspace-api: avoid using ReST :doc:`foo` markup Mauro Carvalho Chehab
2021-06-05 13:18 ` [PATCH 05/34] media: driver-api: drivers: " Mauro Carvalho Chehab
2021-06-05 13:18 ` [PATCH 06/34] media: admin-guide: " Mauro Carvalho Chehab
2021-06-05 13:18 ` [PATCH 07/34] docs: admin-guide: pm: avoid using ReSt " Mauro Carvalho Chehab
2021-06-05 13:18 ` [PATCH 08/34] docs: admin-guide: hw-vuln: avoid using ReST " Mauro Carvalho Chehab
2021-06-05 13:18 ` Mauro Carvalho Chehab [this message]
2021-06-05 13:18 ` [PATCH 10/34] docs: block: biodoc.rst: avoid using ReSt " Mauro Carvalho Chehab
2021-06-05 13:18 ` [PATCH 11/34] docs: bpf: bpf_lsm.rst: " Mauro Carvalho Chehab
2021-06-05 13:18 ` [PATCH 12/34] docs: core-api: " Mauro Carvalho Chehab
2021-06-05 13:18 ` [PATCH 13/34] docs: dev-tools: testing-overview.rst: " Mauro Carvalho Chehab
2021-06-05 15:43   ` David Gow
2021-06-05 16:13     ` Mauro Carvalho Chehab
2021-06-05 13:18 ` [PATCH 14/34] docs: dev-tools: kunit: avoid using ReST " Mauro Carvalho Chehab
2021-06-05 15:44   ` David Gow
2021-06-16  6:00     ` Mauro Carvalho Chehab
2021-06-16  6:13       ` Mauro Carvalho Chehab
2021-06-07 20:20   ` Brendan Higgins
2021-06-05 13:18 ` [PATCH 15/34] docs: devicetree: bindings: submitting-patches.rst: avoid using ReSt " Mauro Carvalho Chehab
2021-06-05 13:18 ` [PATCH 16/34] docs: doc-guide: " Mauro Carvalho Chehab
2021-06-05 13:18 ` [PATCH 17/34] docs: driver-api: " Mauro Carvalho Chehab
2021-06-05 13:18 ` [PATCH 18/34] docs: driver-api: gpio: using-gpio.rst: " Mauro Carvalho Chehab
2021-06-05 16:25   ` Linus Walleij
2021-06-05 13:18 ` [PATCH 19/34] docs: driver-api: surface_aggregator: " Mauro Carvalho Chehab
2021-06-05 14:14   ` Maximilian Luz
2021-06-07  9:31     ` Hans de Goede
2021-06-07  9:55       ` Mauro Carvalho Chehab
2021-06-07 10:07         ` Hans de Goede
2021-06-05 13:18 ` [PATCH 20/34] docs: driver-api: usb: " Mauro Carvalho Chehab
2021-06-05 13:18 ` [PATCH 21/34] docs: firmware-guide: acpi: " Mauro Carvalho Chehab
2021-06-05 13:18 ` [PATCH 22/34] docs: hwmon: adm1177.rst: " Mauro Carvalho Chehab
2021-06-06 13:01   ` Guenter Roeck
2021-06-05 13:18 ` [PATCH 23/34] docs: i2c: " Mauro Carvalho Chehab
2021-06-05 15:13   ` Wolfram Sang
2021-06-05 13:18 ` [PATCH 24/34] docs: kernel-hacking: hacking.rst: " Mauro Carvalho Chehab
2021-06-05 13:18 ` [PATCH 25/34] docs: networking: devlink: " Mauro Carvalho Chehab
2021-06-05 13:18 ` [PATCH 26/34] docs: PCI: endpoint: pci-endpoint-cfs.rst: " Mauro Carvalho Chehab
2021-06-10 23:46   ` Bjorn Helgaas
2021-06-11  8:45     ` Mauro Carvalho Chehab
2021-06-05 13:18 ` [PATCH 27/34] docs: PCI: pci.rst: " Mauro Carvalho Chehab
2021-06-10 23:46   ` Bjorn Helgaas
2021-06-05 13:18 ` [PATCH 28/34] docs: process: submitting-patches.rst: " Mauro Carvalho Chehab
2021-06-05 13:18 ` [PATCH 29/34] docs: security: landlock.rst: " Mauro Carvalho Chehab
2021-06-05 13:18 ` [PATCH 30/34] docs: trace: coresight: coresight.rst: " Mauro Carvalho Chehab
2021-06-08 15:23   ` Mathieu Poirier
2021-06-05 13:18 ` [PATCH 31/34] docs: trace: ftrace.rst: " Mauro Carvalho Chehab
2021-06-05 13:18 ` [PATCH 32/34] docs: userspace-api: landlock.rst: " Mauro Carvalho Chehab
2021-06-05 13:18 ` [PATCH 33/34] docs: virt: kvm: s390-pv-boot.rst: " Mauro Carvalho Chehab
2021-06-05 13:18 ` [PATCH 34/34] docs: x86: " Mauro Carvalho Chehab
2021-06-07 15:21   ` Peter Zijlstra
2021-06-05 13:37 ` [PATCH 00/34] docs: avoid using ReST :doc:`foo` tag Mauro Carvalho Chehab
2021-06-05 15:11 ` Nícolas F. R. A. Prado
2021-06-05 19:08   ` Mauro Carvalho Chehab
2021-06-06 22:52     ` Nícolas F. R. A. Prado
2021-06-07  7:34       ` Mauro Carvalho Chehab
2021-06-08  0:34         ` Nícolas F. R. A. Prado
2021-06-08  7:28           ` Mauro Carvalho Chehab

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=525173e8ae8bc9bb812ae5e87f64cb2498b87dfe.1622898327.git.mchehab+huawei@kernel.org \
    --to=mchehab+huawei@kernel.org \
    --cc=akpm@linux-foundation.org \
    --cc=andrew.a.klychkov@gmail.com \
    --cc=corbet@lwn.net \
    --cc=gpiccoli@canonical.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=me@mathieu.digital \
    --cc=qais.yousef@arm.com \
    --cc=rdunlap@infradead.org \
    --cc=steve@sk2.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).