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
WARNING: multiple messages have this Message-ID (diff)
From: Pavel Machek <pavel@ucw.cz>
To: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Cc: "Linux Doc Mailing List" <linux-doc@vger.kernel.org>,
"Mauro Carvalho Chehab" <mchehab@infradead.org>,
"Jonathan Corbet" <corbet@lwn.net>,
"Rafael J. Wysocki" <rjw@rjwysocki.net>,
"Len Brown" <lenb@kernel.org>, "Jens Axboe" <axboe@kernel.dk>,
"Alessandro Zummo" <a.zummo@towertech.it>,
"Alexandre Belloni" <alexandre.belloni@free-electrons.com>,
"Rob Herring" <robh+dt@kernel.org>,
"Mark Rutland" <mark.rutland@arm.com>,
"Jean Delvare" <jdelvare@suse.com>,
"Guenter Roeck" <linux@roeck-us.net>,
"Karsten Keil" <isdn@linux-pingi.de>,
"Mauro Carvalho Chehab" <mchehab@kernel.org>,
"Steffen Klassert" <klassert@mathematik.tu-chemnitz.de>,
"Greg Kroah-Hartman" <gregkh@linuxfoundation.org>,
"Johannes Berg" <johannes@sipsolutions.net>,
"Jaroslav Kysela" <perex@perex.cz>,
"Takashi Iwai" <tiwai@suse.com>,
"Paolo Bonzini" <pbonzini@redhat.com>,
"Radim Krčmář" <rkrcmar@redhat.com>,
"Wim Van Sebroeck" <wim@iguana.be>,
"Thomas Gleixner" <tglx@linutronix.de>,
"Ingo Molnar" <mingo@redhat.com>,
"H. Peter Anvin" <hpa@zytor.com>,
x86@kernel.org, "Harry Wei" <harryxiyou@gmail.com>,
"Tejun Heo" <tj@kernel.org>,
"Harald Welte" <laforge@gnumonks.org>,
"Wolfgang Grandegger" <wg@grandegger.com>,
"Marc Kleine-Budde" <mkl@pengutronix.de>,
"Dan Williams" <dan.j.williams@intel.com>,
"Martyn Welch" <martyn@welchs.me.uk>,
"Manohar Vanga" <manohar.vanga@gmail.com>,
"Tomi Valkeinen" <tomi.valkeinen@ti.com>,
"Michael S. Tsirkin" <mst@redhat.com>,
"Alexander Viro" <viro@zeniv.linux.org.uk>,
"Anton Vorontsov" <anton@enomsg.org>,
"Colin Cross" <ccross@android.com>,
"Kees Cook" <keescook@chromium.org>,
"Tony Luck" <tony.luck@intel.com>,
"Andy Whitcroft" <apw@canonical.com>,
"Joe Perches" <joe@perches.com>, "Shuah Khan" <shuah@kernel.org>,
"Diego Viola" <diego.viola@gmail.com>,
"Øyvind A. Holm" <sunny@sunbase.org>,
"James Bottomley" <James.Bottomley@HansenPartnership.com>,
"Linus Walleij" <linus.walleij@linaro.org>,
"Andrew Morton" <akpm@linux-foundation.org>,
"Paul E. McKenney" <paulmck@linux.vnet.ibm.com>,
"Greg Hackmann" <ghackmann@google.com>,
"Manuel Pégourié-Gonnard" <mpg@elzevir.fr>,
"Jiri Kosina" <jkosina@suse.cz>, "Li Zefan" <lizefan@huawei.com>,
"Yuan Sun" <sunyuan3@huawei.com>,
"Haosdent Huang" <haosdent@gmail.com>,
"Li RongQing" <roy.qing.li@gmail.com>,
"Masanari Iida" <standby24x7@gmail.com>,
"David S. Miller" <davem@davemloft.net>,
"SeongJae Park" <sj38.park@gmail.com>,
"Minchan Kim" <minchan@kernel.org>,
"Markus Heiser" <markus.heiser@darmarIT.de>,
"Laurent Pinchart" <laurent.pinchart@ideasonboard.com>,
"Askar Safin" <safinaskar@mail.ru>,
"Thomas Gardner" <tmg@fastmail.com>,
"Peter Loeffler" <peter.loeffler@guruz.at>,
"Philippe Loctaux" <phil@philippeloctaux.com>,
"Doug Smythies" <doug.smythies@gmail.com>,
"Chris Metcalf" <cmetcalf@ezchip.com>,
"Jakub Wilk" <jwilk@jwilk.net>,
"Martin K. Petersen" <martin.petersen@oracle.com>,
"Finn Thain" <fthain@telegraphics.com.au>,
"Hannes Reinicke" <hare@suse.de>,
"Geert Uytterhoeven" <geert@linux-m68k.org>,
"Arnaldo Carvalho de Melo" <acme@redhat.com>,
"Borislav Petkov" <bp@suse.de>,
"Christian Borntraeger" <borntraeger@de.ibm.com>,
"Andy Lutomirski" <luto@kernel.org>,
"Daniel Bristot de Oliveira" <bristot@redhat.com>,
"Ben Hutchings" <ben@decadent.org.uk>,
"Hidehiro Kawai" <hidehiro.kawai.ez@hitachi.com>,
"seokhoon.yoon" <iamyooon@gmail.com>,
"Egor Uleyskiy" <egor.ulieiskii@gmail.com>,
"Ryan Swan" <ryan@ryanswan.com>,
"Rasmus Villemoes" <linux@rasmusvillemoes.dk>,
"Ulf Hansson" <ulf.hansson@linaro.org>,
"Tomeu Vizoso" <tomeu.vizoso@collabora.com>,
"Andy Shevchenko" <andriy.shevchenko@linux.intel.com>,
"Sudip Mukherjee" <sudipm.mukherjee@gmail.com>,
"Oliver Neukum" <oneukum@suse.com>,
"Arnd Bergmann" <arnd@arndb.de>,
"Johannes Weiner" <hannes@cmpxchg.org>,
"Thomas Garnier" <thgarnie@google.com>,
"Ard Biesheuvel" <ard.biesheuvel@linaro.org>,
"Petr Mladek" <pmladek@suse.com>,
"Nicolas Pitre" <nicolas.pitre@linaro.org>,
"Prarit Bhargava" <prarit@redhat.com>,
"Yang Shi" <yang.shi@linaro.org>,
"Yaowei Bai" <baiyaowei@cmss.chinamobile.com>,
"Andrey Ryabinin" <aryabinin@virtuozzo.com>,
"Josh Poimboeuf" <jpoimboe@redhat.com>,
"Nikolay Aleksandrov" <nikolay@cumulusnetworks.com>,
"Dmitry Vyukov" <dvyukov@google.com>,
"Darren Hart" <dvhart@linux.intel.com>,
"Wei Jiangang" <weijg.fnst@cn.fujitsu.com>,
linux-acpi@vger.kernel.org, rtc-linux@googlegroups.com,
devicetree@vger.kernel.org, linux-hwmon@vger.kernel.org,
netdev@vger.kernel.org, linux-pm@vger.kernel.org,
stable@vger.kernel.org, linux-wireless@vger.kernel.org,
alsa-devel@alsa-project.org, kvm@vger.kernel.org,
linux-watchdog@vger.kernel.org, linux-kernel@zh-kernel.org,
linux-ide@vger.kernel.org, linux-can@vger.kernel.org,
linux-nvdimm@lists.01.org, devel@driverdev.osuosl.org,
linux-fbdev@vger.kernel.org,
virtualization@lists.linux-foundation.org,
linux-fsdevel@vger.kernel.org, linux-kselftest@vger.kernel.org
Subject: [rtc-linux] 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: Type: text/plain, Size: 2259 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
--
You received this message because you are subscribed to "rtc-linux".
Membership options at http://groups.google.com/group/rtc-linux .
Please read http://groups.google.com/group/rtc-linux/web/checklist
before submitting a driver.
---
You received this message because you are subscribed to the Google Groups "rtc-linux" group.
To unsubscribe from this group and stop receiving emails from it, send an email to rtc-linux+unsubscribe@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 181 bytes --]
WARNING: multiple messages have this Message-ID (diff)
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: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <cover.1476801354.git.mchehab@s-opensource.com>
2016-10-18 14:53 ` [PATCH v2 34/37] docs: fix locations of several documents that got moved Mauro Carvalho Chehab
[not found] ` <cover.1476801354.git.mchehab-JsYNTwtnfakRB7SZvlqPiA@public.gmane.org>
2016-10-18 14:53 ` Mauro Carvalho Chehab
2016-10-18 14:53 ` Mauro Carvalho Chehab
2016-10-18 14:53 ` [rtc-linux] " Mauro Carvalho Chehab
2016-10-19 10:34 ` Pavel Machek
[not found] ` <28c1f5d3867174a7017e3f3d9e9e4ebb096ceed8.1476801354.git.mchehab-JsYNTwtnfakRB7SZvlqPiA@public.gmane.org>
2016-10-19 10:34 ` Pavel Machek
2016-10-19 10:34 ` [rtc-linux] " Pavel Machek
2016-10-19 13:59 ` Mauro Carvalho Chehab
2016-10-19 13:59 ` [rtc-linux] " Mauro Carvalho Chehab
2016-10-19 13:59 ` Mauro Carvalho Chehab
2016-11-02 9:31 ` Pavel Machek [this message]
2016-11-02 9:31 ` Pavel Machek
2016-11-02 9:31 ` [rtc-linux] " Pavel Machek
2016-11-02 10:08 ` Prarit Bhargava
2016-11-02 10:08 ` Prarit Bhargava
2016-11-02 10:08 ` [rtc-linux] " Prarit Bhargava
2016-11-02 10:08 ` Prarit Bhargava
2016-10-19 13:59 ` Mauro Carvalho Chehab
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.cz \
--cc=akpm@linux-foundation.org \
--cc=baiyaowei@cmss.chinamobile.com \
--cc=cmetcalf@ezchip.com \
--cc=fthain@telegraphics.com.au \
--cc=geert@linux-m68k.org \
--cc=iamyooon@gmail.com \
--cc=isdn@linux-pingi.de \
--cc=jdelvare@suse.com \
--cc=jkosina@suse.cz \
--cc=joe@perches.com \
--cc=jwilk@jwilk.net \
--cc=linus.walleij@linaro.org \
--cc=linux-acpi@vger.kernel.org \
--cc=linux-pm@vger.kernel.org \
--cc=linux@roeck-us.net \
--cc=lizefan@huawei.com \
--cc=luto@kernel.org \
--cc=mchehab@s-opensource.com \
--cc=nicolas.pitre@linaro.org \
--cc=perex@perex.cz \
--cc=peter.loeffler@guruz.at \
--cc=pmladek@suse.com \
--cc=ryan@ryanswan.com \
--cc=tglx@linutronix.de \
--cc=viro@zeniv.linux.org.uk \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.