Received: by 2002:a25:ab43:0:0:0:0:0 with SMTP id u61csp4219595ybi; Tue, 18 Jun 2019 14:06:41 -0700 (PDT) X-Google-Smtp-Source: APXvYqwrL3b1ZRnm9xoWtXIhqz4AkpVy1+7xNGFRKfwjziSskoJtLD5A0cz+WOEXZUayGv/06/u+ X-Received: by 2002:a63:ed13:: with SMTP id d19mr4442008pgi.100.1560892001778; Tue, 18 Jun 2019 14:06:41 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1560892001; cv=none; d=google.com; s=arc-20160816; b=yU6/wzSzNk/ysbc0Nq/pMXfUz701wAiW6YVopc4etHbG8DT/A/Ch4B6Gi0x//FFUjY rpvgQ4va4N5unlAM97pc9IosqSBpyImygDawBor+6A7NmJM96Tyv1PR/17PVyORcoaX4 7d425XDpH/CaJxULClMhohwZazTYjaZcTwN7X6NEOHqyroqa4uNCMpXOi2AXFU6LTrmw fsVJYRNrAlKVFKap1qbgouTM7TdiC/uz8/wNpIRvp4yIj3UPyV1IKJS/A9EU/cQtuKo1 tvbzDMBu8VSZ6skS36W4WzfjNp8DqEOOS+fwFiGnPLnBfHV8xxHERo82MBuP412VPEsW uBGw== 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=ECIQo8wjoJ4L3SNzTPduVDIOPVbFLBmTWJrd5JeuGbI=; b=ahjunMrb49AtiHnsPaFw2ewO94zv335iPUzX9o04QH2cx6tkPjuSeVAk2GoA8aO/NZ x7oxCREeB5Z4IDRnrVnVLqwprvNT2WhgWGbirlRsdKxv1R9GCqSnYUjXcKu9fc1Tms8D 3lm2QqkfC5H/sLB00e9rJiSDgVo4ghPJrMP/MaPVMa9ki/icaGtvSKK7xftayUfHwEjp YToSi2S/VE75MiSF/mMie11syrm859yKgKrDFVJAeDG8ho0MLqcXfFLNtLoNbD6u/sWa cd3DY7a0PaRoM8aP+cn15kpXix7N2wMRmjLft2nTTMEDPyP1PJl5kRTWFsE19wky8BRu Gx7Q== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@infradead.org header.s=bombadil.20170209 header.b=uN25SBw4; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id u3si1189959pgu.514.2019.06.18.14.06.26; Tue, 18 Jun 2019 14:06:41 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; dkim=fail header.i=@infradead.org header.s=bombadil.20170209 header.b=uN25SBw4; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1730924AbfFRVGC (ORCPT + 99 others); Tue, 18 Jun 2019 17:06:02 -0400 Received: from bombadil.infradead.org ([198.137.202.133]:35048 "EHLO bombadil.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1730785AbfFRVGA (ORCPT ); Tue, 18 Jun 2019 17:06:00 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20170209; h=Sender:Content-Transfer-Encoding: Content-Type:MIME-Version:References:In-Reply-To:Message-Id:Date:Subject:Cc: To:From:Reply-To:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help: List-Unsubscribe:List-Subscribe:List-Post:List-Owner:List-Archive; bh=ECIQo8wjoJ4L3SNzTPduVDIOPVbFLBmTWJrd5JeuGbI=; b=uN25SBw4Qda4bD/guxXXptJsE9 r7PlgDNIP3HjKrbIXXNJNKv0ft4+UxzRcRzr8ynhelVrVadVEEMty5KGn0/tHZa/OtSeGMzkdo7aH ud2kbZEVm5bnRJvA9k/AWf4Gj3lScOUrgiD3I2x2Yphrz9PJ2HD2IdUUJ9sKZca8/FnJ80L/xKPHw DuC2RymFuwdCyNTIMg7AFZgPZmyUQaxXufKDm4nJxM/92Mk3GSUuvgi0eMPqpDIJxD74otO/wern2 VgpE8anPgIpMFNO2r2o0Eyu36fejzJVIl69APWrFet0an4rsUxFkW8N86PZH0ome46bT38xNCDjQh UwlTT3jw==; Received: from 177.133.86.196.dynamic.adsl.gvt.net.br ([177.133.86.196] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.92 #3 (Red Hat Linux)) id 1hdLIc-0006zH-KZ; Tue, 18 Jun 2019 21:05:51 +0000 Received: from mchehab by bombadil.infradead.org with local (Exim 4.92) (envelope-from ) id 1hdLIa-0002DI-7r; Tue, 18 Jun 2019 18:05:48 -0300 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jonathan Corbet , Dave Young , Baoquan He , Vivek Goyal , Benjamin Herrenschmidt , Paul Mackerras , Michael Ellerman , Harry Wei , Alex Shi , Jerry Hoemann , Wim Van Sebroeck , Guenter Roeck , Russell King , Catalin Marinas , Will Deacon , Yoshinori Sato , Rich Felker , Thomas Gleixner , Ingo Molnar , Borislav Petkov , "H. Peter Anvin" , x86@kernel.org, kexec@lists.infradead.org, linuxppc-dev@lists.ozlabs.org, linux-watchdog@vger.kernel.org, linux-arm-kernel@lists.infradead.org, linux-sh@vger.kernel.org Subject: [PATCH v1 22/22] admin-guide: add kdump documentation into it Date: Tue, 18 Jun 2019 18:05:46 -0300 Message-Id: X-Mailer: git-send-email 2.21.0 In-Reply-To: References: MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org The Kdump documentation describes procedures with admins use in order to solve issues on their systems. Signed-off-by: Mauro Carvalho Chehab --- Documentation/admin-guide/bug-hunting.rst | 4 ++-- Documentation/admin-guide/index.rst | 1 + Documentation/{ => admin-guide}/kdump/gdbmacros.txt | 0 Documentation/{ => admin-guide}/kdump/index.rst | 1 - Documentation/{ => admin-guide}/kdump/kdump.rst | 0 Documentation/{ => admin-guide}/kdump/vmcoreinfo.rst | 0 Documentation/admin-guide/kernel-parameters.txt | 6 +++--- Documentation/powerpc/firmware-assisted-dump.rst | 2 +- Documentation/translations/zh_CN/oops-tracing.txt | 4 ++-- Documentation/watchdog/hpwdt.rst | 2 +- MAINTAINERS | 2 +- arch/arm/Kconfig | 2 +- arch/arm64/Kconfig | 2 +- arch/sh/Kconfig | 2 +- arch/x86/Kconfig | 4 ++-- 15 files changed, 16 insertions(+), 16 deletions(-) rename Documentation/{ => admin-guide}/kdump/gdbmacros.txt (100%) rename Documentation/{ => admin-guide}/kdump/index.rst (97%) rename Documentation/{ => admin-guide}/kdump/kdump.rst (100%) rename Documentation/{ => admin-guide}/kdump/vmcoreinfo.rst (100%) diff --git a/Documentation/admin-guide/bug-hunting.rst b/Documentation/admin-guide/bug-hunting.rst index b761aa2a51d2..44b8a4edd348 100644 --- a/Documentation/admin-guide/bug-hunting.rst +++ b/Documentation/admin-guide/bug-hunting.rst @@ -90,9 +90,9 @@ the disk is not available then you have three options: run a null modem to a second machine and capture the output there using your favourite communication program. Minicom works well. -(3) Use Kdump (see Documentation/kdump/kdump.rst), +(3) Use Kdump (see Documentation/admin-guide/kdump/kdump.rst), extract the kernel ring buffer from old memory with using dmesg - gdbmacro in Documentation/kdump/gdbmacros.txt. + gdbmacro in Documentation/admin-guide/kdump/gdbmacros.txt. Finding the bug's location -------------------------- diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst index e4f0cb2a02bd..9f6820a7e8f8 100644 --- a/Documentation/admin-guide/index.rst +++ b/Documentation/admin-guide/index.rst @@ -39,6 +39,7 @@ problems and bugs in particular. ramoops dynamic-debug-howto init + kdump/index This is the beginning of a section with information of interest to application developers. Documents covering various aspects of the kernel diff --git a/Documentation/kdump/gdbmacros.txt b/Documentation/admin-guide/kdump/gdbmacros.txt similarity index 100% rename from Documentation/kdump/gdbmacros.txt rename to Documentation/admin-guide/kdump/gdbmacros.txt diff --git a/Documentation/kdump/index.rst b/Documentation/admin-guide/kdump/index.rst similarity index 97% rename from Documentation/kdump/index.rst rename to Documentation/admin-guide/kdump/index.rst index 2b17fcf6867a..8e2ebd0383cd 100644 --- a/Documentation/kdump/index.rst +++ b/Documentation/admin-guide/kdump/index.rst @@ -1,4 +1,3 @@ -:orphan: ================================================================ Documentation for Kdump - The kexec-based Crash Dumping Solution diff --git a/Documentation/kdump/kdump.rst b/Documentation/admin-guide/kdump/kdump.rst similarity index 100% rename from Documentation/kdump/kdump.rst rename to Documentation/admin-guide/kdump/kdump.rst diff --git a/Documentation/kdump/vmcoreinfo.rst b/Documentation/admin-guide/kdump/vmcoreinfo.rst similarity index 100% rename from Documentation/kdump/vmcoreinfo.rst rename to Documentation/admin-guide/kdump/vmcoreinfo.rst diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt index 69a9e2e66dfb..1f3fc445c78d 100644 --- a/Documentation/admin-guide/kernel-parameters.txt +++ b/Documentation/admin-guide/kernel-parameters.txt @@ -708,14 +708,14 @@ [KNL, x86_64] select a region under 4G first, and fall back to reserve region above 4G when '@offset' hasn't been specified. - See Documentation/kdump/kdump.rst for further details. + See Documentation/admin-guide/kdump/kdump.rst for further details. crashkernel=range1:size1[,range2:size2,...][@offset] [KNL] Same as above, but depends on the memory in the running system. The syntax of range is start-[end] where start and end are both a memory unit (amount[KMG]). See also - Documentation/kdump/kdump.rst for an example. + Documentation/admin-guide/kdump/kdump.rst for an example. crashkernel=size[KMG],high [KNL, x86_64] range could be above 4G. Allow kernel @@ -1207,7 +1207,7 @@ Specifies physical address of start of kernel core image elf header and optionally the size. Generally kexec loader will pass this option to capture kernel. - See Documentation/kdump/kdump.rst for details. + See Documentation/admin-guide/kdump/kdump.rst for details. enable_mtrr_cleanup [X86] The kernel tries to adjust MTRR layout from continuous diff --git a/Documentation/powerpc/firmware-assisted-dump.rst b/Documentation/powerpc/firmware-assisted-dump.rst index d7fa7c35dd12..9ca12830a48e 100644 --- a/Documentation/powerpc/firmware-assisted-dump.rst +++ b/Documentation/powerpc/firmware-assisted-dump.rst @@ -61,7 +61,7 @@ as follows: the default calculated size. Use this option if default boot memory size is not sufficient for second kernel to boot successfully. For syntax of crashkernel= parameter, - refer to Documentation/kdump/kdump.rst. If any offset is + refer to Documentation/admin-guide/kdump/kdump.rst. If any offset is provided in crashkernel= parameter, it will be ignored as fadump uses a predefined offset to reserve memory for boot memory dump preservation in case of a crash. diff --git a/Documentation/translations/zh_CN/oops-tracing.txt b/Documentation/translations/zh_CN/oops-tracing.txt index 368ddd05b304..c5f3bda7abcb 100644 --- a/Documentation/translations/zh_CN/oops-tracing.txt +++ b/Documentation/translations/zh_CN/oops-tracing.txt @@ -53,8 +53,8 @@ cat /proc/kmsg > file， 然而你必须介入中止传输， kmsg是一个“ （2）用串口终端启动（请参看Documentation/admin-guide/serial-console.rst），运行一个null modem到另一台机器并用你喜欢的通讯工具获取输出。Minicom工作地很好。 -（3）使用Kdump（请参看Documentation/kdump/kdump.rst）， -使用在Documentation/kdump/gdbmacros.txt中定义的dmesg gdb宏，从旧的内存中提取内核 +（3）使用Kdump（请参看Documentation/admin-guide/kdump/kdump.rst）， +使用在Documentation/admin-guide/kdump/gdbmacros.txt中定义的dmesg gdb宏，从旧的内存中提取内核 环形缓冲区。 完整信息 diff --git a/Documentation/watchdog/hpwdt.rst b/Documentation/watchdog/hpwdt.rst index 437456bd91a4..9a75720dd51a 100644 --- a/Documentation/watchdog/hpwdt.rst +++ b/Documentation/watchdog/hpwdt.rst @@ -59,7 +59,7 @@ Last reviewed: 08/20/2018 and loop forever. This is generally not what a watchdog user wants. For those wishing to learn more please see: - Documentation/kdump/kdump.rst + Documentation/admin-guide/kdump/kdump.rst Documentation/admin-guide/kernel-parameters.txt (panic=) Your Linux Distribution specific documentation. diff --git a/MAINTAINERS b/MAINTAINERS index ab170522ec55..071b9e5a1664 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -8571,7 +8571,7 @@ R: Vivek Goyal L: kexec@lists.infradead.org W: http://lse.sourceforge.net/kdump/ S: Maintained -F: Documentation/kdump/ +F: Documentation/admin-guide/kdump/ KEENE FM RADIO TRANSMITTER DRIVER M: Hans Verkuil diff --git a/arch/arm/Kconfig b/arch/arm/Kconfig index ff0e247573d8..fc495004f148 100644 --- a/arch/arm/Kconfig +++ b/arch/arm/Kconfig @@ -2009,7 +2009,7 @@ config CRASH_DUMP kdump/kexec. The crash dump kernel must be compiled to a memory address not used by the main kernel - For more details see Documentation/kdump/kdump.rst + For more details see Documentation/admin-guide/kdump/kdump.rst config AUTO_ZRELADDR bool "Auto calculation of the decompressed kernel image address" diff --git a/arch/arm64/Kconfig b/arch/arm64/Kconfig index a8a5fe91c579..9c2275b22904 100644 --- a/arch/arm64/Kconfig +++ b/arch/arm64/Kconfig @@ -995,7 +995,7 @@ config CRASH_DUMP reserved region and then later executed after a crash by kdump/kexec. - For more details see Documentation/kdump/kdump.rst + For more details see Documentation/admin-guide/kdump/kdump.rst config XEN_DOM0 def_bool y diff --git a/arch/sh/Kconfig b/arch/sh/Kconfig index 7440639510a0..b731d22c5b9d 100644 --- a/arch/sh/Kconfig +++ b/arch/sh/Kconfig @@ -624,7 +624,7 @@ config CRASH_DUMP to a memory address not used by the main kernel using PHYSICAL_START. - For more details see Documentation/kdump/kdump.rst + For more details see Documentation/admin-guide/kdump/kdump.rst config KEXEC_JUMP bool "kexec jump (EXPERIMENTAL)" diff --git a/arch/x86/Kconfig b/arch/x86/Kconfig index 586dd3529d14..8ed2e47ef4ba 100644 --- a/arch/x86/Kconfig +++ b/arch/x86/Kconfig @@ -2052,7 +2052,7 @@ config CRASH_DUMP to a memory address not used by the main kernel or BIOS using PHYSICAL_START, or it must be built as a relocatable image (CONFIG_RELOCATABLE=y). - For more details see Documentation/kdump/kdump.rst + For more details see Documentation/admin-guide/kdump/kdump.rst config KEXEC_JUMP bool "kexec jump" @@ -2089,7 +2089,7 @@ config PHYSICAL_START the reserved region. In other words, it can be set based on the "X" value as specified in the "crashkernel=YM@XM" command line boot parameter passed to the panic-ed - kernel. Please take a look at Documentation/kdump/kdump.rst + kernel. Please take a look at Documentation/admin-guide/kdump/kdump.rst for more details about crash dumps. Usage of bzImage for capturing the crash dump is recommended as -- 2.21.0