Received: by 2002:a05:6a10:206:0:0:0:0 with SMTP id 6csp1893704pxj; Sat, 5 Jun 2021 06:21:28 -0700 (PDT) X-Google-Smtp-Source: ABdhPJzprZ8Co+qZzLqONuR6BWC7whZJgwmZkoA6AkAnNE9jhI+2JhHVXtJjfX2sFl2aWfHg519Z X-Received: by 2002:a05:6402:5201:: with SMTP id s1mr10769549edd.54.1622899288178; Sat, 05 Jun 2021 06:21:28 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1622899288; cv=none; d=google.com; s=arc-20160816; b=dGvRrdHs1lXRBpxGWWANoSufIpBEqUsOFf7upqnG/EcQrL9YcN0f53ItbDz+JHVCRX fBD/Sun8TMoHHjytePi2elYn9m2SaP9GvzIVoDlYbqvsaL6amYGj3uIgRpEKPwW/ZkDt oYQq7jChVS60BL4795T8+J1yEQQTWGyhD2t3af8b00ry2sVvNZUPMbHMmCKM5vimswFz g9yO5vRWbclglQqhE3Iu+FQwlXL3JjkRRxvyPdc35N9swXOeyVmOxsDJuN2LV9ftirmv RVolgBAL/2elvSv5woJ1nvc7yixxYZ+B9TlfQJ1f23NPxB+eDPd/edo401yfZJQHSmN9 P3Eg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=+FnKwGlq0bykdHgPAU218UkZ039x932tBD33XWC2oxw=; b=nbHjdK3ZRItybLefZw6P9b/TDN0a9CC7FDAztxy3CLeE9HVyGEPQ91EoqpqFfEVXM1 bKFbq2+i6ULgSvBUjXnux16vZu0DhGKoXyCNhOWucwnqPqdc3YB0j4OKLoz4iA83afTp /z9u7xdOhmGO1qTbaGSoPKdyBxlsD/KHeFxDrInkD4i8ex8iEFpLiJvnjaUmccHR9v88 c4Iwj7ERx/T2zbBf8zImBjQXDr1iyzZY2rDnosiDQpphHQdoTyIHS2+cXUeHLvJHNT8R HJNjx+piKYemKIO3zVkAVu8LboHjxSIlmcMdILq74wayF0qm7/lOb2Re8jTINb6Hl0Nc HfLw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b="GPIN5a/1"; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id u20si7536003edv.439.2021.06.05.06.21.05; Sat, 05 Jun 2021 06:21:28 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b="GPIN5a/1"; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230381AbhFENUp (ORCPT + 99 others); Sat, 5 Jun 2021 09:20:45 -0400 Received: from mail.kernel.org ([198.145.29.99]:35088 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230036AbhFENU0 (ORCPT ); Sat, 5 Jun 2021 09:20:26 -0400 Received: by mail.kernel.org (Postfix) with ESMTPSA id A0FA961421; Sat, 5 Jun 2021 13:18:37 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1622899117; bh=AWUVfjHntj18JrWVyyrbUvVXvdLBBNxY88EfYBbgiKc=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=GPIN5a/1QbZdq4l8cdBiaiZeeZN0ucDya2SFJdLHcDNP4nv344x+Im654KzUmWJPI 8ajkAaoiG/3jxemoEuz5oqlTkWFPiDnU83v6qiEr90yrenVme+S6LGG6GdzDxLrjYX yHAgTqh21RHVZD+nRJMBshXmslMlG2hKW6CkKyGGwUrIqAl3Yj6xmRCz8gHI2COqNE G0y/lu1A7HRXbuCWqlfO89qdkbOaeJnG8ex3/PM4lgHQlQ2S+YeNbOrdU93aiBKwDT DYtUGgc4sPWhk8qV/P8aYN8Xw7MXMu6JAjvywpTMhnHpaJREcxvvIzytHO/uV2seGA g4f9vqNtrkEHg== Received: by mail.kernel.org with local (Exim 4.94.2) (envelope-from ) id 1lpWCB-008GF3-Kj; Sat, 05 Jun 2021 15:18:35 +0200 From: Mauro Carvalho Chehab To: "Jonathan Corbet" , Linux Doc Mailing List Cc: Mauro Carvalho Chehab , "Guilherme G. Piccoli" , Andrew Klychkov , Andrew Morton , Mathieu Chouquet-Stringer , Qais Yousef , Randy Dunlap , Stephen Kitt , 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 Message-Id: <525173e8ae8bc9bb812ae5e87f64cb2498b87dfe.1622898327.git.mchehab+huawei@kernel.org> X-Mailer: git-send-email 2.31.1 In-Reply-To: References: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: Mauro Carvalho Chehab Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.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 --- 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 Copyright (c) 2009, Shen Feng -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=,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