From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: Dave Young <dyoung@redhat.com>
Cc: Alex Shi <alex.shi@linux.alibaba.com>,
Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
Baoquan He <bhe@redhat.com>, Vivek Goyal <vgoyal@redhat.com>,
Benjamin Herrenschmidt <benh@kernel.crashing.org>,
Paul Mackerras <paulus@samba.org>,
Michael Ellerman <mpe@ellerman.id.au>,
Harry Wei <harryxiyou@gmail.com>,
Jerry Hoemann <jerry.hoemann@hpe.com>,
Wim Van Sebroeck <wim@linux-watchdog.org>,
Guenter Roeck <linux@roeck-us.net>,
Russell King <linux@armlinux.org.uk>,
Catalin Marinas <catalin.marinas@arm.com>,
Will Deacon <will@kernel.org>,
Yoshinori Sato <ysato@users.sourceforge.jp>,
Rich Felker <dalias@libc.org>,
Thomas Gleixner <tglx@linutronix.de>,
Ingo Molnar <mingo@redhat.com>, Borislav Petkov <bp@alien8.de>,
"H. Peter Anvin" <hpa@zytor.com>,
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
Date: Sat, 6 Jul 2019 08:46:38 -0300 [thread overview]
Message-ID: <20190706084638.7dc875f2@coco.lan> (raw)
In-Reply-To: <20190705055904.GB2790@localhost.localdomain>
Em Fri, 5 Jul 2019 13:59:04 +0800
Dave Young <dyoung@redhat.com> 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 <mchehab+samsung@kernel.org>
> > > ---
> > > 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
next prev parent reply other threads:[~2019-07-06 11:46 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <cover.1561724493.git.mchehab+samsung@kernel.org>
2019-06-28 12:30 ` [PATCH 18/39] docs: admin-guide: add kdump documentation into it Mauro Carvalho Chehab
2019-07-05 3:43 ` Alex Shi
2019-07-05 5:59 ` Dave Young
2019-07-06 11:46 ` Mauro Carvalho Chehab [this message]
2019-07-05 5:55 ` Dave Young
2019-06-28 12:30 ` [PATCH 37/39] docs: adds some directories to the main documentation index Mauro Carvalho Chehab
2019-06-28 12:55 ` Bartlomiej Zolnierkiewicz
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=20190706084638.7dc875f2@coco.lan \
--to=mchehab+samsung@kernel.org \
--cc=alex.shi@linux.alibaba.com \
--cc=benh@kernel.crashing.org \
--cc=bhe@redhat.com \
--cc=bp@alien8.de \
--cc=catalin.marinas@arm.com \
--cc=corbet@lwn.net \
--cc=dalias@libc.org \
--cc=dyoung@redhat.com \
--cc=harryxiyou@gmail.com \
--cc=hpa@zytor.com \
--cc=jerry.hoemann@hpe.com \
--cc=kexec@lists.infradead.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-sh@vger.kernel.org \
--cc=linux-watchdog@vger.kernel.org \
--cc=linux@armlinux.org.uk \
--cc=linux@roeck-us.net \
--cc=linuxppc-dev@lists.ozlabs.org \
--cc=mchehab@infradead.org \
--cc=mingo@redhat.com \
--cc=mpe@ellerman.id.au \
--cc=paulus@samba.org \
--cc=tglx@linutronix.de \
--cc=vgoyal@redhat.com \
--cc=will@kernel.org \
--cc=wim@linux-watchdog.org \
--cc=x86@kernel.org \
--cc=ysato@users.sourceforge.jp \
/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).