From mboxrd@z Thu Jan 1 00:00:00 1970 Return-path: Date: Sat, 6 Jul 2019 08:46:38 -0300 From: Mauro Carvalho Chehab Subject: Re: [PATCH 18/39] docs: admin-guide: add kdump documentation into it Message-ID: <20190706084638.7dc875f2@coco.lan> In-Reply-To: <20190705055904.GB2790@localhost.localdomain> References: <654e7591c044632c06257e0f069a52c0bb993554.1561724493.git.mchehab+samsung@kernel.org> <6911b74c-848f-0060-3db5-b5d7e8061cb5@linux.alibaba.com> <20190705055904.GB2790@localhost.localdomain> MIME-Version: 1.0 List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: base64 Sender: "kexec" Errors-To: kexec-bounces+dwmw2=infradead.org@lists.infradead.org To: Dave Young Cc: Rich Felker , Linux Doc Mailing List , Catalin Marinas , Jerry Hoemann , Harry Wei , Paul Mackerras , "H. Peter Anvin" , Alex Shi , Will Deacon , Yoshinori Sato , Jonathan Corbet , linux-sh@vger.kernel.org, Michael Ellerman , x86@kernel.org, Russell King , Ingo Molnar , Benjamin Herrenschmidt , Guenter Roeck , linux-watchdog@vger.kernel.org, Mauro Carvalho Chehab , Borislav Petkov , Thomas Gleixner , Wim Van Sebroeck , linux-arm-kernel@lists.infradead.org, Baoquan He , kexec@lists.infradead.org, linux-kernel@vger.kernel.org, Vivek Goyal , linuxppc-dev@lists.ozlabs.org RW0gRnJpLCA1IEp1bCAyMDE5IDEzOjU5OjA0ICswODAwCkRhdmUgWW91bmcgPGR5b3VuZ0ByZWRo YXQuY29tPiBlc2NyZXZldToKCj4gT24gMDcvMDUvMTkgYXQgMTE6NDNhbSwgQWxleCBTaGkgd3Jv dGU6Cj4gPiAKPiA+IAo+ID4g5ZyoIDIwMTkvNi8yOCDkuIvljYg4OjMwLCBNYXVybyBDYXJ2YWxo byBDaGVoYWIg5YaZ6YGTOiAgCj4gPiA+IFRoZSBLZHVtcCBkb2N1bWVudGF0aW9uIGRlc2NyaWJl cyBwcm9jZWR1cmVzIHdpdGggYWRtaW5zIHVzZQo+ID4gPiBpbiBvcmRlciB0byBzb2x2ZSBpc3N1 ZXMgb24gdGhlaXIgc3lzdGVtcy4KPiA+ID4gCj4gPiA+IFNpZ25lZC1vZmYtYnk6IE1hdXJvIENh cnZhbGhvIENoZWhhYiA8bWNoZWhhYitzYW1zdW5nQGtlcm5lbC5vcmc+Cj4gPiA+IC0tLQo+ID4g PiAgRG9jdW1lbnRhdGlvbi9hZG1pbi1ndWlkZS9idWctaHVudGluZy5yc3QgICAgICAgICAgICB8 IDQgKystLQo+ID4gPiAgRG9jdW1lbnRhdGlvbi9hZG1pbi1ndWlkZS9pbmRleC5yc3QgICAgICAg ICAgICAgICAgICB8IDEgKwo+ID4gPiAgRG9jdW1lbnRhdGlvbi97ID0+IGFkbWluLWd1aWRlfS9r ZHVtcC9nZGJtYWNyb3MudHh0ICB8IDAKPiA+ID4gIERvY3VtZW50YXRpb24veyA9PiBhZG1pbi1n dWlkZX0va2R1bXAvaW5kZXgucnN0ICAgICAgfCAxIC0KPiA+ID4gIERvY3VtZW50YXRpb24veyA9 PiBhZG1pbi1ndWlkZX0va2R1bXAva2R1bXAucnN0ICAgICAgfCAwCj4gPiA+ICBEb2N1bWVudGF0 aW9uL3sgPT4gYWRtaW4tZ3VpZGV9L2tkdW1wL3ZtY29yZWluZm8ucnN0IHwgMCAgCj4gPiAKPiA+ IEkgYW0gbm90IHN1cmUgaWYgaXQncyBjb252ZW5pZW5jZSBmb3IgcGVvcGxlIHRvIGhhdmUgbW9y ZSBsZXZlbHMgaW4gZG9jcy4KPiA+IAo+ID4gQnV0IEkgZ3Vlc3MsIG1vdmUgYXJjaHMgaW50byBh IERvY3VtZW50YXRpb24vYXJjaC8gZGlyIHNob3VsZCBiZSBmaW5lLiBsaWtlIERvY3VtZW50YXRp b24vYXJjaC97eDg2LGFybSxhcm02NCxpYTY0LG02OGssczM5MCxwb3dlcnBjLC4uLn0gIAo+IAo+ IEFsZXgsIG1vdmluZyBrZHVtcCB0byBhZG1pbi1ndWlkZSBzb3VuZHMgcmVhc29uYWJsZSB0byBt ZS4gIEkgYWxzbyBhZ3JlZQo+IHdpdGggeW91IGZvciB0aG9zZSBhcmNoIGRlcGVuZGVudCBmaWxl cyBjYW4gYmUgbW92ZWQgdG8KPiBEb2N1bWVudGF0aW9uL2FyY2gvLCBtYXliZSB5b3UgYXJlIHRh bGtpbmcgYWJvdXQgc29tZSBvdGhlciBwYXRjaGVzIGluCj4gdGhlIHNlcmllcyBmb3IgdGhlIGFy Y2gvPyAKCkFsZXgsCgpJdCBtYWtlcyBzZW5zZSBmb3IgbWUgdG8gaGF2ZSBhIERvY3VtZW50YXRp b24vYXJjaCBkaXJlY3RvcnksIGFuZCBwbGFjZQp0aGUgYXJjaC1zcGVjaWZpYyBkb2NzIG92ZXIg dGhlcmUuCgpUaGVyZSdzIGFjdHVhbGx5IGEgdGVjaG5pY2FsIGFkdmFudGFnZSBvbiBkb2luZyB0 aGF0OiBTcGhpbnggaXMgZHVtYgp3aXRoIHJlZ2FyZHMgdG8gUERGL0xhVGVYIG91dHB1dDogaXQg cmVxdWlyZXMgYWxsIHRvcCBkb2N1bWVudHMgdG8gYmUKbGlzdGVkIGF0IERvY3VtZW50YXRpb24v Y29uZi5weSwgdW5kZXIgdGhpcyB2YXI6CgoJbGF0ZXhfZG9jdW1lbnRzID0gWwoJCS4uLgoJXQoK QXMgaXQgY3JlYXRlcyBvbmUgcnVudGltZSBNYWtlZmlsZSBhdCBEb2N1bWVudGF0aW9uL291dHB1 dCBwZXIgbGlzdGVkCmRvY3VtZW50IHRoZXJlLiBTbywgdGhlIG1vcmUgd2UgZ3JvdXAgc3VjaCBk b2N1bWVudHMsIHRoZSBsZXNzIG1lcmdlCmNvbmZsaWN0cyB3ZSdsbCBoYXZlIGF0IERvY3VtZW50 YXRpb24vY29uZi5weS4KCkJ0dywgdGhlcmUncyBhIFtURUNIIFRPUElDXSBwcm9wb3NhbCBmb3Ig S1MvMjAxOSBtZWFudCB0byBkaXNjdXNzIApEb2N1bWVudGF0aW9uLgoKSSBzdXNwZWN0IHdlIGNv dWxkIGRpc2N1c3MgdGhlIHByb3MvY29ucyBvZiBkb2luZyBzdWNoIGNoYW5nZSB0aGVyZS4KCk15 IHBlcnNvbmFsIHZpZXcgaXMgdGhhdCB3ZSBzaG91bGQga2VlcCB0aGUgRG9jdW1lbnRhdGlvbi8g cm9vdCBkaXIgYXMKY2xlYW4gYXMgcG9zc2libGUgYXMgYSBsb25nIHRlcm0gZ29hbC4KCk9uIHRo ZSBvdGhlciBoYW5kLCBpdCBtYWtlcyB0aGUgcGF0aCBiaWdnZXIgYW5kIGhhcmRlciB0byByZW5h bWUuCgpPbiBhIHNpZGUgbm90ZSwgbGFzdCB0aW1lIHdlIGRpc2N1c3NlZCBkb2N1bWVudGF0aW9u IGF0IEtTIEkgcmVtZW1iZXIKSSBwcm9wb3NlZCB0byBzaG9ydGN1dCAiRG9jdW1lbnRhdGlvbi8i IHRvIGp1c3QgImRvY3MvIi4gVGhlIGNvbnNlbnN1cwpvbiB0aGF0IHRpbWUgd2VyZSB0byBrZWVw IHRoZSBiaWcgbmFtZS4gSSBzdGlsbCB0aGluayB0aGF0IGEgc2hvcnRlcgpvbmUgY291bGQgaGVs cCBwZW9wbGUgdG8gcmVtaW5kIHdoZXJlIGRvY3VtZW50YXRpb24gd2lsbCBiZSBsb2NhdGVkLgoK VGhhbmtzLApNYXVybwoKX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19f X19fX18Ka2V4ZWMgbWFpbGluZyBsaXN0CmtleGVjQGxpc3RzLmluZnJhZGVhZC5vcmcKaHR0cDov L2xpc3RzLmluZnJhZGVhZC5vcmcvbWFpbG1hbi9saXN0aW5mby9rZXhlYwo= From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on archive.lwn.net X-Spam-Level: X-Spam-Status: No, score=-5.8 required=5.0 tests=DKIM_INVALID,DKIM_SIGNED, MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI,SPF_HELO_NONE,SPF_NONE autolearn=ham autolearn_force=no version=3.4.2 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by archive.lwn.net (Postfix) with ESMTP id 785AF7D2F0 for ; Sat, 6 Jul 2019 11:46:56 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726177AbfGFLq4 (ORCPT ); Sat, 6 Jul 2019 07:46:56 -0400 Received: from bombadil.infradead.org ([198.137.202.133]:43480 "EHLO bombadil.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726023AbfGFLqz (ORCPT ); Sat, 6 Jul 2019 07:46:55 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20170209; h=Content-Transfer-Encoding: Content-Type:MIME-Version:References:In-Reply-To:Message-ID:Subject:Cc:To: From:Date:Sender: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=j6y676QYR/iHJJ649Hu4pguKBc+26wcukAE46ESMMlo=; b=dOTYigO14yG8pQxnEPFBC19DX /Ww8mAJLwcfe1SJqp/NylfCiIiI9REBU4NBiWe4dYMw9xdQP6lV0y+pUltL/gztWxW7BxkiF1kRXE w6XA7g9pa5LjIsiEu0S8st2kB2gzhI15q6uEUzs4XQgoqkyabISla1WvfKEt7LUVcsysRFNZryzy2 Vt4rLjvEjd+OfhIGQpJR1++ZVceLUOM/+IRXvzm2znfchAZwwCauZYISTmjywQAOsgIR2YmU3+vzt 0KvSoXLLqm4bOXutzWmOhE1jpX4jFMrPYVTRcXNwmtfs/ro27ahj9vrDH17GltUK57PchaGmotAd6 Zh3YctvFg==; Received: from 177.205.70.5.dynamic.adsl.gvt.net.br ([177.205.70.5] helo=coco.lan) by bombadil.infradead.org with esmtpsa (Exim 4.92 #3 (Red Hat Linux)) id 1hjj9S-0002M7-Qh; Sat, 06 Jul 2019 11:46:47 +0000 Date: Sat, 6 Jul 2019 08:46:38 -0300 From: Mauro Carvalho Chehab To: Dave Young Cc: Alex Shi , Linux Doc Mailing List , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jonathan Corbet , Baoquan He , Vivek Goyal , Benjamin Herrenschmidt , Paul Mackerras , Michael Ellerman , Harry Wei , 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: Re: [PATCH 18/39] docs: admin-guide: add kdump documentation into it Message-ID: <20190706084638.7dc875f2@coco.lan> In-Reply-To: <20190705055904.GB2790@localhost.localdomain> References: <654e7591c044632c06257e0f069a52c0bb993554.1561724493.git.mchehab+samsung@kernel.org> <6911b74c-848f-0060-3db5-b5d7e8061cb5@linux.alibaba.com> <20190705055904.GB2790@localhost.localdomain> X-Mailer: Claws Mail 3.17.3 (GTK+ 2.24.32; x86_64-redhat-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Sender: linux-doc-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org Em Fri, 5 Jul 2019 13:59:04 +0800 Dave Young escreveu: > On 07/05/19 at 11:43am, Alex Shi wrote: > >=20 > >=20 > > =E5=9C=A8 2019/6/28 =E4=B8=8B=E5=8D=888:30, Mauro Carvalho Chehab =E5= =86=99=E9=81=93: =20 > > > The Kdump documentation describes procedures with admins use > > > in order to solve issues on their systems. > > >=20 > > > Signed-off-by: Mauro Carvalho Chehab > > > --- > > > Documentation/admin-guide/bug-hunting.rst | 4 ++-- > > > Documentation/admin-guide/index.rst | 1 + > > > Documentation/{ =3D> admin-guide}/kdump/gdbmacros.txt | 0 > > > Documentation/{ =3D> admin-guide}/kdump/index.rst | 1 - > > > Documentation/{ =3D> admin-guide}/kdump/kdump.rst | 0 > > > Documentation/{ =3D> admin-guide}/kdump/vmcoreinfo.rst | 0 =20 > >=20 > > I am not sure if it's convenience for people to have more levels in doc= s. > >=20 > > But I guess, move archs into a Documentation/arch/ dir should be fine. = like Documentation/arch/{x86,arm,arm64,ia64,m68k,s390,powerpc,...} =20 >=20 > Alex, moving kdump to admin-guide sounds reasonable to me. I also agree > with you for those arch dependent files can be moved to > Documentation/arch/, maybe you are talking about some other patches in > the series for the arch/?=20 Alex, It makes sense for me to have a Documentation/arch directory, and place the arch-specific docs over there. There's actually a technical advantage on doing that: Sphinx is dumb with regards to PDF/LaTeX output: it requires all top documents to be listed at Documentation/conf.py, under this var: latex_documents =3D [ ... ] As it creates one runtime Makefile at Documentation/output per listed document there. So, the more we group such documents, the less merge conflicts we'll have at Documentation/conf.py. Btw, there's a [TECH TOPIC] proposal for KS/2019 meant to discuss=20 Documentation. I suspect we could discuss the pros/cons of doing such change there. My personal view is that we should keep the Documentation/ root dir as clean as possible as a long term goal. On the other hand, it makes the path bigger and harder to rename. On a side note, last time we discussed documentation at KS I remember I proposed to shortcut "Documentation/" to just "docs/". The consensus on that time were to keep the big name. I still think that a shorter one could help people to remind where documentation will be located. Thanks, Mauro From mboxrd@z Thu Jan 1 00:00:00 1970 From: Mauro Carvalho Chehab Date: Sat, 06 Jul 2019 11:46:38 +0000 Subject: Re: [PATCH 18/39] docs: admin-guide: add kdump documentation into it Message-Id: <20190706084638.7dc875f2@coco.lan> List-Id: References: <654e7591c044632c06257e0f069a52c0bb993554.1561724493.git.mchehab+samsung@kernel.org> <6911b74c-848f-0060-3db5-b5d7e8061cb5@linux.alibaba.com> <20190705055904.GB2790@localhost.localdomain> In-Reply-To: <20190705055904.GB2790@localhost.localdomain> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 8bit To: Dave Young Cc: Rich Felker , Linux Doc Mailing List , Catalin Marinas , Jerry Hoemann , Harry Wei , Paul Mackerras , "H. Peter Anvin" , Alex Shi , Will Deacon , Yoshinori Sato , Jonathan Corbet , linux-sh@vger.kernel.org, Michael Ellerman , x86@kernel.org, Russell King , Ingo Molnar , Benjamin Herrenschmidt , Guenter Roeck , linux-watchdog@vger.kernel.org, Mauro Carvalho Chehab , Borislav Petkov , Thomas Gleixner , Wim Van Sebroeck , linux-arm-kernel@lists.infradead.org, Baoquan He , kexec@lists.infradead.org, linux-kernel@vger.kernel.org, Vivek Goyal , linuxppc-dev@lists.ozlabs.org Em Fri, 5 Jul 2019 13:59:04 +0800 Dave Young escreveu: > On 07/05/19 at 11:43am, Alex Shi wrote: > > > > > > 在 2019/6/28 下午8:30, Mauro Carvalho Chehab 写道: > > > 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 > > > > I am not sure if it's convenience for people to have more levels in docs. > > > > But I guess, move archs into a Documentation/arch/ dir should be fine. like Documentation/arch/{x86,arm,arm64,ia64,m68k,s390,powerpc,...} > > Alex, moving kdump to admin-guide sounds reasonable to me. I also agree > with you for those arch dependent files can be moved to > Documentation/arch/, maybe you are talking about some other patches in > the series for the arch/? Alex, It makes sense for me to have a Documentation/arch directory, and place the arch-specific docs over there. There's actually a technical advantage on doing that: Sphinx is dumb with regards to PDF/LaTeX output: it requires all top documents to be listed at Documentation/conf.py, under this var: latex_documents = [ ... ] As it creates one runtime Makefile at Documentation/output per listed document there. So, the more we group such documents, the less merge conflicts we'll have at Documentation/conf.py. Btw, there's a [TECH TOPIC] proposal for KS/2019 meant to discuss Documentation. I suspect we could discuss the pros/cons of doing such change there. My personal view is that we should keep the Documentation/ root dir as clean as possible as a long term goal. On the other hand, it makes the path bigger and harder to rename. On a side note, last time we discussed documentation at KS I remember I proposed to shortcut "Documentation/" to just "docs/". The consensus on that time were to keep the big name. I still think that a shorter one could help people to remind where documentation will be located. Thanks, Mauro From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-5.3 required=3.0 tests=DKIM_INVALID,DKIM_SIGNED, MAILING_LIST_MULTI,SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_SANE_2 autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 2B798C0650E for ; Sat, 6 Jul 2019 11:49:19 +0000 (UTC) Received: from lists.ozlabs.org (lists.ozlabs.org [203.11.71.2]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 66B95213F2 for ; Sat, 6 Jul 2019 11:49:18 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="dOTYigO1" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 66B95213F2 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=kernel.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=linuxppc-dev-bounces+linuxppc-dev=archiver.kernel.org@lists.ozlabs.org Received: from lists.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) by lists.ozlabs.org (Postfix) with ESMTP id 45gqkN1pwTzDqgX for ; Sat, 6 Jul 2019 21:49:16 +1000 (AEST) Authentication-Results: lists.ozlabs.org; spf=permerror (mailfrom) smtp.mailfrom=kernel.org (client-ip=2607:7c80:54:e::133; helo=bombadil.infradead.org; envelope-from=mchehab+samsung@kernel.org; receiver=) Authentication-Results: lists.ozlabs.org; dmarc=fail (p=none dis=none) header.from=kernel.org Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:e::133]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by lists.ozlabs.org (Postfix) with ESMTPS id 45gqhc2Ty3zDqDd for ; Sat, 6 Jul 2019 21:47:44 +1000 (AEST) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20170209; h=Content-Transfer-Encoding: Content-Type:MIME-Version:References:In-Reply-To:Message-ID:Subject:Cc:To: From:Date:Sender: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=j6y676QYR/iHJJ649Hu4pguKBc+26wcukAE46ESMMlo=; b=dOTYigO14yG8pQxnEPFBC19DX /Ww8mAJLwcfe1SJqp/NylfCiIiI9REBU4NBiWe4dYMw9xdQP6lV0y+pUltL/gztWxW7BxkiF1kRXE w6XA7g9pa5LjIsiEu0S8st2kB2gzhI15q6uEUzs4XQgoqkyabISla1WvfKEt7LUVcsysRFNZryzy2 Vt4rLjvEjd+OfhIGQpJR1++ZVceLUOM/+IRXvzm2znfchAZwwCauZYISTmjywQAOsgIR2YmU3+vzt 0KvSoXLLqm4bOXutzWmOhE1jpX4jFMrPYVTRcXNwmtfs/ro27ahj9vrDH17GltUK57PchaGmotAd6 Zh3YctvFg==; Received: from 177.205.70.5.dynamic.adsl.gvt.net.br ([177.205.70.5] helo=coco.lan) by bombadil.infradead.org with esmtpsa (Exim 4.92 #3 (Red Hat Linux)) id 1hjj9S-0002M7-Qh; Sat, 06 Jul 2019 11:46:47 +0000 Date: Sat, 6 Jul 2019 08:46:38 -0300 From: Mauro Carvalho Chehab To: Dave Young Subject: Re: [PATCH 18/39] docs: admin-guide: add kdump documentation into it Message-ID: <20190706084638.7dc875f2@coco.lan> In-Reply-To: <20190705055904.GB2790@localhost.localdomain> References: <654e7591c044632c06257e0f069a52c0bb993554.1561724493.git.mchehab+samsung@kernel.org> <6911b74c-848f-0060-3db5-b5d7e8061cb5@linux.alibaba.com> <20190705055904.GB2790@localhost.localdomain> X-Mailer: Claws Mail 3.17.3 (GTK+ 2.24.32; x86_64-redhat-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable X-BeenThere: linuxppc-dev@lists.ozlabs.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Linux on PowerPC Developers Mail List List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Rich Felker , Linux Doc Mailing List , Catalin Marinas , Jerry Hoemann , Harry Wei , Paul Mackerras , "H. Peter Anvin" , Alex Shi , Will Deacon , Yoshinori Sato , Jonathan Corbet , linux-sh@vger.kernel.org, x86@kernel.org, Russell King , Ingo Molnar , Guenter Roeck , linux-watchdog@vger.kernel.org, Mauro Carvalho Chehab , Borislav Petkov , Thomas Gleixner , Wim Van Sebroeck , linux-arm-kernel@lists.infradead.org, Baoquan He , kexec@lists.infradead.org, linux-kernel@vger.kernel.org, Vivek Goyal , linuxppc-dev@lists.ozlabs.org Errors-To: linuxppc-dev-bounces+linuxppc-dev=archiver.kernel.org@lists.ozlabs.org Sender: "Linuxppc-dev" Em Fri, 5 Jul 2019 13:59:04 +0800 Dave Young escreveu: > On 07/05/19 at 11:43am, Alex Shi wrote: > >=20 > >=20 > > =E5=9C=A8 2019/6/28 =E4=B8=8B=E5=8D=888:30, Mauro Carvalho Chehab =E5= =86=99=E9=81=93: =20 > > > The Kdump documentation describes procedures with admins use > > > in order to solve issues on their systems. > > >=20 > > > Signed-off-by: Mauro Carvalho Chehab > > > --- > > > Documentation/admin-guide/bug-hunting.rst | 4 ++-- > > > Documentation/admin-guide/index.rst | 1 + > > > Documentation/{ =3D> admin-guide}/kdump/gdbmacros.txt | 0 > > > Documentation/{ =3D> admin-guide}/kdump/index.rst | 1 - > > > Documentation/{ =3D> admin-guide}/kdump/kdump.rst | 0 > > > Documentation/{ =3D> admin-guide}/kdump/vmcoreinfo.rst | 0 =20 > >=20 > > I am not sure if it's convenience for people to have more levels in doc= s. > >=20 > > But I guess, move archs into a Documentation/arch/ dir should be fine. = like Documentation/arch/{x86,arm,arm64,ia64,m68k,s390,powerpc,...} =20 >=20 > Alex, moving kdump to admin-guide sounds reasonable to me. I also agree > with you for those arch dependent files can be moved to > Documentation/arch/, maybe you are talking about some other patches in > the series for the arch/?=20 Alex, It makes sense for me to have a Documentation/arch directory, and place the arch-specific docs over there. There's actually a technical advantage on doing that: Sphinx is dumb with regards to PDF/LaTeX output: it requires all top documents to be listed at Documentation/conf.py, under this var: latex_documents =3D [ ... ] As it creates one runtime Makefile at Documentation/output per listed document there. So, the more we group such documents, the less merge conflicts we'll have at Documentation/conf.py. Btw, there's a [TECH TOPIC] proposal for KS/2019 meant to discuss=20 Documentation. I suspect we could discuss the pros/cons of doing such change there. My personal view is that we should keep the Documentation/ root dir as clean as possible as a long term goal. On the other hand, it makes the path bigger and harder to rename. On a side note, last time we discussed documentation at KS I remember I proposed to shortcut "Documentation/" to just "docs/". The consensus on that time were to keep the big name. I still think that a shorter one could help people to remind where documentation will be located. Thanks, Mauro From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-5.5 required=3.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,MAILING_LIST_MULTI,SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS, URIBL_BLOCKED,USER_AGENT_SANE_2 autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id A3ED7C0650E for ; Sat, 6 Jul 2019 11:47:11 +0000 (UTC) Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 786EC214AF for ; Sat, 6 Jul 2019 11:47:11 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="J0ocHfB8" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 786EC214AF Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=kernel.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+infradead-linux-arm-kernel=archiver.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20170209; h=Sender: Content-Transfer-Encoding:Content-Type:Cc:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:MIME-Version:References:In-Reply-To: Message-ID:Subject:To:From:Date:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=xFyipWcyhQpHdpWC8jMLJ2Ije0STcJLLJjM5ge+PShc=; b=J0ocHfB8tvB1FH Yc4ycoJ9v8ET0yNxWpS/IqKMN3JIf1YZMd40CfT5CLVOk8PClRoaTAUSfJbt2KKAJ4TrHSrj0jhUP TQMtkGM3iWxPvw+5M8tKcVplEGCkLavDGdQRFNvqzuJCVy0/lji/oOtNvLaDuqq8DA4mTIJKVRZ11 EtyrU3CxCCX7WTiU4ZZiY99VeInJtcZH/bLIFmvng7DWqOVIbpEvpwboKgIuBv6G5GV5S312BP/bR 8WxBpMH3mUv+NR8qOqzhoaLmBAlz8zJZKMK1fgBfulmhkWJyQODDPhp/VPLJ5PQpapttopgzowhcR PJbef/sbaagEeDefN32w==; Received: from localhost ([127.0.0.1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.92 #3 (Red Hat Linux)) id 1hjj9i-0002Qe-WB; Sat, 06 Jul 2019 11:47:03 +0000 Received: from 177.205.70.5.dynamic.adsl.gvt.net.br ([177.205.70.5] helo=coco.lan) by bombadil.infradead.org with esmtpsa (Exim 4.92 #3 (Red Hat Linux)) id 1hjj9S-0002M7-Qh; Sat, 06 Jul 2019 11:46:47 +0000 Date: Sat, 6 Jul 2019 08:46:38 -0300 From: Mauro Carvalho Chehab To: Dave Young Subject: Re: [PATCH 18/39] docs: admin-guide: add kdump documentation into it Message-ID: <20190706084638.7dc875f2@coco.lan> In-Reply-To: <20190705055904.GB2790@localhost.localdomain> References: <654e7591c044632c06257e0f069a52c0bb993554.1561724493.git.mchehab+samsung@kernel.org> <6911b74c-848f-0060-3db5-b5d7e8061cb5@linux.alibaba.com> <20190705055904.GB2790@localhost.localdomain> X-Mailer: Claws Mail 3.17.3 (GTK+ 2.24.32; x86_64-redhat-linux-gnu) MIME-Version: 1.0 X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Rich Felker , Linux Doc Mailing List , Catalin Marinas , Jerry Hoemann , Harry Wei , Paul Mackerras , "H. Peter Anvin" , Alex Shi , Will Deacon , Yoshinori Sato , Jonathan Corbet , linux-sh@vger.kernel.org, Michael Ellerman , x86@kernel.org, Russell King , Ingo Molnar , Benjamin Herrenschmidt , Guenter Roeck , linux-watchdog@vger.kernel.org, Mauro Carvalho Chehab , Borislav Petkov , Thomas Gleixner , Wim Van Sebroeck , linux-arm-kernel@lists.infradead.org, Baoquan He , kexec@lists.infradead.org, linux-kernel@vger.kernel.org, Vivek Goyal , linuxppc-dev@lists.ozlabs.org Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: base64 Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+infradead-linux-arm-kernel=archiver.kernel.org@lists.infradead.org RW0gRnJpLCA1IEp1bCAyMDE5IDEzOjU5OjA0ICswODAwCkRhdmUgWW91bmcgPGR5b3VuZ0ByZWRo YXQuY29tPiBlc2NyZXZldToKCj4gT24gMDcvMDUvMTkgYXQgMTE6NDNhbSwgQWxleCBTaGkgd3Jv dGU6Cj4gPiAKPiA+IAo+ID4g5ZyoIDIwMTkvNi8yOCDkuIvljYg4OjMwLCBNYXVybyBDYXJ2YWxo byBDaGVoYWIg5YaZ6YGTOiAgCj4gPiA+IFRoZSBLZHVtcCBkb2N1bWVudGF0aW9uIGRlc2NyaWJl cyBwcm9jZWR1cmVzIHdpdGggYWRtaW5zIHVzZQo+ID4gPiBpbiBvcmRlciB0byBzb2x2ZSBpc3N1 ZXMgb24gdGhlaXIgc3lzdGVtcy4KPiA+ID4gCj4gPiA+IFNpZ25lZC1vZmYtYnk6IE1hdXJvIENh cnZhbGhvIENoZWhhYiA8bWNoZWhhYitzYW1zdW5nQGtlcm5lbC5vcmc+Cj4gPiA+IC0tLQo+ID4g PiAgRG9jdW1lbnRhdGlvbi9hZG1pbi1ndWlkZS9idWctaHVudGluZy5yc3QgICAgICAgICAgICB8 IDQgKystLQo+ID4gPiAgRG9jdW1lbnRhdGlvbi9hZG1pbi1ndWlkZS9pbmRleC5yc3QgICAgICAg ICAgICAgICAgICB8IDEgKwo+ID4gPiAgRG9jdW1lbnRhdGlvbi97ID0+IGFkbWluLWd1aWRlfS9r ZHVtcC9nZGJtYWNyb3MudHh0ICB8IDAKPiA+ID4gIERvY3VtZW50YXRpb24veyA9PiBhZG1pbi1n dWlkZX0va2R1bXAvaW5kZXgucnN0ICAgICAgfCAxIC0KPiA+ID4gIERvY3VtZW50YXRpb24veyA9 PiBhZG1pbi1ndWlkZX0va2R1bXAva2R1bXAucnN0ICAgICAgfCAwCj4gPiA+ICBEb2N1bWVudGF0 aW9uL3sgPT4gYWRtaW4tZ3VpZGV9L2tkdW1wL3ZtY29yZWluZm8ucnN0IHwgMCAgCj4gPiAKPiA+ IEkgYW0gbm90IHN1cmUgaWYgaXQncyBjb252ZW5pZW5jZSBmb3IgcGVvcGxlIHRvIGhhdmUgbW9y ZSBsZXZlbHMgaW4gZG9jcy4KPiA+IAo+ID4gQnV0IEkgZ3Vlc3MsIG1vdmUgYXJjaHMgaW50byBh IERvY3VtZW50YXRpb24vYXJjaC8gZGlyIHNob3VsZCBiZSBmaW5lLiBsaWtlIERvY3VtZW50YXRp b24vYXJjaC97eDg2LGFybSxhcm02NCxpYTY0LG02OGssczM5MCxwb3dlcnBjLC4uLn0gIAo+IAo+ IEFsZXgsIG1vdmluZyBrZHVtcCB0byBhZG1pbi1ndWlkZSBzb3VuZHMgcmVhc29uYWJsZSB0byBt ZS4gIEkgYWxzbyBhZ3JlZQo+IHdpdGggeW91IGZvciB0aG9zZSBhcmNoIGRlcGVuZGVudCBmaWxl cyBjYW4gYmUgbW92ZWQgdG8KPiBEb2N1bWVudGF0aW9uL2FyY2gvLCBtYXliZSB5b3UgYXJlIHRh bGtpbmcgYWJvdXQgc29tZSBvdGhlciBwYXRjaGVzIGluCj4gdGhlIHNlcmllcyBmb3IgdGhlIGFy Y2gvPyAKCkFsZXgsCgpJdCBtYWtlcyBzZW5zZSBmb3IgbWUgdG8gaGF2ZSBhIERvY3VtZW50YXRp b24vYXJjaCBkaXJlY3RvcnksIGFuZCBwbGFjZQp0aGUgYXJjaC1zcGVjaWZpYyBkb2NzIG92ZXIg dGhlcmUuCgpUaGVyZSdzIGFjdHVhbGx5IGEgdGVjaG5pY2FsIGFkdmFudGFnZSBvbiBkb2luZyB0 aGF0OiBTcGhpbnggaXMgZHVtYgp3aXRoIHJlZ2FyZHMgdG8gUERGL0xhVGVYIG91dHB1dDogaXQg cmVxdWlyZXMgYWxsIHRvcCBkb2N1bWVudHMgdG8gYmUKbGlzdGVkIGF0IERvY3VtZW50YXRpb24v Y29uZi5weSwgdW5kZXIgdGhpcyB2YXI6CgoJbGF0ZXhfZG9jdW1lbnRzID0gWwoJCS4uLgoJXQoK QXMgaXQgY3JlYXRlcyBvbmUgcnVudGltZSBNYWtlZmlsZSBhdCBEb2N1bWVudGF0aW9uL291dHB1 dCBwZXIgbGlzdGVkCmRvY3VtZW50IHRoZXJlLiBTbywgdGhlIG1vcmUgd2UgZ3JvdXAgc3VjaCBk b2N1bWVudHMsIHRoZSBsZXNzIG1lcmdlCmNvbmZsaWN0cyB3ZSdsbCBoYXZlIGF0IERvY3VtZW50 YXRpb24vY29uZi5weS4KCkJ0dywgdGhlcmUncyBhIFtURUNIIFRPUElDXSBwcm9wb3NhbCBmb3Ig S1MvMjAxOSBtZWFudCB0byBkaXNjdXNzIApEb2N1bWVudGF0aW9uLgoKSSBzdXNwZWN0IHdlIGNv dWxkIGRpc2N1c3MgdGhlIHByb3MvY29ucyBvZiBkb2luZyBzdWNoIGNoYW5nZSB0aGVyZS4KCk15 IHBlcnNvbmFsIHZpZXcgaXMgdGhhdCB3ZSBzaG91bGQga2VlcCB0aGUgRG9jdW1lbnRhdGlvbi8g cm9vdCBkaXIgYXMKY2xlYW4gYXMgcG9zc2libGUgYXMgYSBsb25nIHRlcm0gZ29hbC4KCk9uIHRo ZSBvdGhlciBoYW5kLCBpdCBtYWtlcyB0aGUgcGF0aCBiaWdnZXIgYW5kIGhhcmRlciB0byByZW5h bWUuCgpPbiBhIHNpZGUgbm90ZSwgbGFzdCB0aW1lIHdlIGRpc2N1c3NlZCBkb2N1bWVudGF0aW9u IGF0IEtTIEkgcmVtZW1iZXIKSSBwcm9wb3NlZCB0byBzaG9ydGN1dCAiRG9jdW1lbnRhdGlvbi8i IHRvIGp1c3QgImRvY3MvIi4gVGhlIGNvbnNlbnN1cwpvbiB0aGF0IHRpbWUgd2VyZSB0byBrZWVw IHRoZSBiaWcgbmFtZS4gSSBzdGlsbCB0aGluayB0aGF0IGEgc2hvcnRlcgpvbmUgY291bGQgaGVs cCBwZW9wbGUgdG8gcmVtaW5kIHdoZXJlIGRvY3VtZW50YXRpb24gd2lsbCBiZSBsb2NhdGVkLgoK VGhhbmtzLApNYXVybwoKX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19f X19fX18KbGludXgtYXJtLWtlcm5lbCBtYWlsaW5nIGxpc3QKbGludXgtYXJtLWtlcm5lbEBsaXN0 cy5pbmZyYWRlYWQub3JnCmh0dHA6Ly9saXN0cy5pbmZyYWRlYWQub3JnL21haWxtYW4vbGlzdGlu Zm8vbGludXgtYXJtLWtlcm5lbAo=