From: Pavel Machek <pavel@ucw•cz>
To: Mauro Carvalho Chehab <mchehab@s-opensource•com>
Cc: Nicolas Pitre <nicolas.pitre@linaro•org>,
Linus Walleij <linus.walleij@linaro•org>,
Jaroslav Kysela <perex@perex•cz>,
Chris Metcalf <cmetcalf@ezchip•com>,
Peter Loeffler <peter.loeffler@guruz•at>,
Finn Thain <fthain@telegraphics•com.au>,
Yaowei Bai <baiyaowei@cmss•chinamobile.com>,
Jakub Wilk <jwilk@jwilk•net>,
linux-acpi@vger•kernel.org,
Geert Uytterhoeven <geert@linux-m68k•org>,
Guenter Roeck <linux@roeck-us•net>,
Petr Mladek <pmladek@suse•com>, Jean Delvare <jdelvare@suse•com>,
linux-pm@vger•kernel.org,
Alexander Viro <viro@zeniv•linux.org.uk>,
Andy Lutomirski <luto@kernel•org>,
Thomas Gleixner <tglx@linutronix•de>,
Karsten Keil <isdn@linux-pingi•de>, Jiri Kosina <jkosina@suse•cz>,
"seokhoon.yoon" <iamyooon@gmail•com>,
Li Zefan <lizefan@huawei•com>, Ryan Swan <ryan@ryanswan•com>,
Joe Perches <joe@perches•com>,
Andrew Morton <akpm@linux-foundation•org>,
Mark Rutland
Subject: Re: [PATCH v2 34/37] docs: fix locations of several documents that got moved
Date: Wed, 2 Nov 2016 10:31:54 +0100 [thread overview]
Message-ID: <20161102093154.GC23350@amd> (raw)
In-Reply-To: <20161019115918.1162d16e@vento.lan>
[-- Attachment #1.1: Type: text/plain, Size: 1794 bytes --]
Hi!
> > Dunno, but kernel-parameters.txt was already quite long... for a file
> > that is referenced quite often. Adding admin-guide/ into the path does
> > not really help.
>
> The big string name starts with Documentation/ :) There are some discussions
> about changing it to doc/ (or docs/). Also, as you said, kernel-parameters
> is already a big name. Perhaps we could use, instead,
> > "kernel-parms".
cmdline?
> If we rename kernel-parameters.rst to kernel-parms.rst, plus the doc/ rename,
> then the string size will actually reduce:
>
> - (see Documentation/kernel-parameters.txt), the minimum possible
> + (see doc/admin-guide/kernel-parms.rst), the minimum possible
>
> > Maybe admin-guide should go directly into Documentation/ , as that's
> > what our users are interested in?
>
> There are several problems if we keep them at Documentation/ dir:
>
> - We'll end by mixing documents already converted to ReST with documents
> not converted yet;
>
> - A rename is needed anyway, as Sphinx only accepts ReST files that end
> with the extension(s) defined at Documentation/conf.py (currently,
> .rst);
>
> - A partial documentation build is made by sub-directory. If we put
> files under /Documentation, there's no way to build just one
> book.
Well, documentation is primarily for users. I'm sure tools can adapt...
> > Plus, I'm not sure how many developers will figure out that process/
> > is what describes kernel patch submission process. We have processes
> > in the kernel, after all...
>
> Do you have a better idea?
development/ ?
Best regards,
Pavel
--
(english) http://www.livejournal.com/~pavelmachek
(cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html
[-- Attachment #1.2: Digital signature --]
[-- Type: application/pgp-signature, Size: 181 bytes --]
[-- Attachment #2: Type: text/plain, Size: 183 bytes --]
_______________________________________________
Virtualization mailing list
Virtualization@lists•linux-foundation.org
https://lists.linuxfoundation.org/mailman/listinfo/virtualization
next prev parent reply other threads:[~2016-11-02 9:31 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <cover.1476801354.git.mchehab@s-opensource.com>
[not found] ` <cover.1476801354.git.mchehab-JsYNTwtnfakRB7SZvlqPiA@public.gmane.org>
2016-10-18 14:53 ` [PATCH v2 34/37] docs: fix locations of several documents that got moved Mauro Carvalho Chehab
[not found] ` <28c1f5d3867174a7017e3f3d9e9e4ebb096ceed8.1476801354.git.mchehab-JsYNTwtnfakRB7SZvlqPiA@public.gmane.org>
2016-10-19 10:34 ` Pavel Machek
2016-10-19 13:59 ` Mauro Carvalho Chehab
2016-11-02 9:31 ` Pavel Machek [this message]
2016-11-02 10:08 ` Prarit Bhargava
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=20161102093154.GC23350@amd \
--to=pavel@ucw$(echo .)cz \
--cc=akpm@linux-foundation$(echo .)org \
--cc=baiyaowei@cmss$(echo .)chinamobile.com \
--cc=cmetcalf@ezchip$(echo .)com \
--cc=fthain@telegraphics$(echo .)com.au \
--cc=geert@linux-m68k$(echo .)org \
--cc=iamyooon@gmail$(echo .)com \
--cc=isdn@linux-pingi$(echo .)de \
--cc=jdelvare@suse$(echo .)com \
--cc=jkosina@suse$(echo .)cz \
--cc=joe@perches$(echo .)com \
--cc=jwilk@jwilk$(echo .)net \
--cc=linus.walleij@linaro$(echo .)org \
--cc=linux-acpi@vger$(echo .)kernel.org \
--cc=linux-pm@vger$(echo .)kernel.org \
--cc=linux@roeck-us$(echo .)net \
--cc=lizefan@huawei$(echo .)com \
--cc=luto@kernel$(echo .)org \
--cc=mchehab@s-opensource$(echo .)com \
--cc=nicolas.pitre@linaro$(echo .)org \
--cc=perex@perex$(echo .)cz \
--cc=peter.loeffler@guruz$(echo .)at \
--cc=pmladek@suse$(echo .)com \
--cc=ryan@ryanswan$(echo .)com \
--cc=tglx@linutronix$(echo .)de \
--cc=viro@zeniv$(echo .)linux.org.uk \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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