Re: [PATCH v2 34/37] docs: fix locations of several documents that got moved

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
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