From mboxrd@z Thu Jan 1 00:00:00 1970 From: Prarit Bhargava Subject: Re: [PATCH v2 34/37] docs: fix locations of several documents that got moved Date: Wed, 02 Nov 2016 06:08:43 -0400 Message-ID: <5819BB2B.7010404@redhat.com> References: <28c1f5d3867174a7017e3f3d9e9e4ebb096ceed8.1476801354.git.mchehab@s-opensource.com> <20161019103442.GD1461@amd> <20161019115918.1162d16e@vento.lan> <20161102093154.GC23350@amd> Reply-To: rtc-linux-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Return-path: Sender: rtc-linux-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org In-Reply-To: <20161102093154.GC23350@amd> List-Post: , List-Help: , List-Archive: , List-Unsubscribe: , To: Pavel Machek , Mauro Carvalho Chehab Cc: Linux Doc Mailing List , Mauro Carvalho Chehab , Jonathan Corbet , "Rafael J. Wysocki" , Len Brown , Jens Axboe , Alessandro Zummo , Alexandre Belloni , Rob Herring , Mark Rutland , Jean Delvare , Guenter Roeck , Karsten Keil , Mauro Carvalho Chehab , Steffen Klassert , Greg Kroah-Hartman , Johannes Berg , Jaroslav Kysela , Takashi Iwai , Paolo Bonzini List-Id: alsa-devel@alsa-project.org On 11/02/2016 05:31 AM, Pavel Machek wrote: > 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? You would not believe the number of users I've dealt with that have confused "cmdline/command line" (aka prompt) with "kernel parameter". I go back and edit customer debug requests to make sure there's no use of cmdline in place of kernel parameter. For the love of every customer facing engineer out there, please stop using cmdline ;). P. > >> 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 > -- 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-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org For more options, visit https://groups.google.com/d/optout. From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Sender: rtc-linux@googlegroups.com Received: from mx1.redhat.com (mx1.redhat.com. [209.132.183.28]) by gmr-mx.google.com with ESMTPS id p22si87028ywe.3.2016.11.02.03.09.07 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 02 Nov 2016 03:09:07 -0700 (PDT) Message-ID: <5819BB2B.7010404@redhat.com> Date: Wed, 02 Nov 2016 06:08:43 -0400 From: Prarit Bhargava MIME-Version: 1.0 To: Pavel Machek , Mauro Carvalho Chehab CC: Linux Doc Mailing List , Mauro Carvalho Chehab , Jonathan Corbet , "Rafael J. Wysocki" , Len Brown , Jens Axboe , Alessandro Zummo , Alexandre Belloni , Rob Herring , Mark Rutland , Jean Delvare , Guenter Roeck , Karsten Keil , Mauro Carvalho Chehab , Steffen Klassert , Greg Kroah-Hartman , Johannes Berg , Jaroslav Kysela , Takashi Iwai , Paolo Bonzini , =?UTF-8?B?UmFkaW0gS3LEjW3DocWZ?= , Wim Van Sebroeck , Thomas Gleixner , Ingo Molnar , "H. Peter Anvin" , x86@kernel.org, Harry Wei , Tejun Heo , Harald Welte , Wolfgang Grandegger , Marc Kleine-Budde , Dan Williams , Martyn Welch , Manohar Vanga , Tomi Valkeinen , "Michael S. Tsirkin" , Alexander Viro , Anton Vorontsov , Colin Cross , Kees Cook , Tony Luck , Andy Whitcroft , Joe Perches , Shuah Khan , Diego Viola , =?UTF-8?B?IsOYeXZpbmQgQS4gSG9sbSI=?= , James Bottomley , Linus Walleij , Andrew Morton , "Paul E. McKenney" , Greg Hackmann , =?UTF-8?B?TWFudWVsIFDDqWdvdXJpw6ktR29ubmFyZA==?= , Jiri Kosina , Li Zefan , Yuan Sun , Haosdent Huang , Li RongQing , Masanari Iida , "David S. Miller" , SeongJae Park , Minchan Kim , Markus Heiser , Laurent Pinchart , Askar Safin , Thomas Gardner , Peter Loeffler , Philippe Loctaux , Doug Smythies , Chris Metcalf , Jakub Wilk , "Martin K. Petersen" , Finn Thain , Hannes Reinicke , Geert Uytterhoeven , Arnaldo Carvalho de Melo , Borislav Petkov , Christian Borntraeger , Andy Lutomirski , Daniel Bristot de Oliveira , Ben Hutchings , Hidehiro Kawai , "seokhoon.yoon" , Egor Uleyskiy , Ryan Swan , Rasmus Villemoes , Ulf Hansson , Tomeu Vizoso , Andy Shevchenko , Sudip Mukherjee , Oliver Neukum , Arnd Bergmann , Johannes Weiner , Thomas Garnier , Ard Biesheuvel , Petr Mladek , Nicolas Pitre , Yang Shi , Yaowei Bai , Andrey Ryabinin , Josh Poimboeuf , Nikolay Aleksandrov , Dmitry Vyukov , Darren Hart , Wei Jiangang , 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@ml01.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 References: <28c1f5d3867174a7017e3f3d9e9e4ebb096ceed8.1476801354.git.mchehab@s-opensource.com> <20161019103442.GD1461@amd> <20161019115918.1162d16e@vento.lan> <20161102093154.GC23350@amd> In-Reply-To: <20161102093154.GC23350@amd> Content-Type: text/plain; charset=UTF-8 Reply-To: rtc-linux@googlegroups.com List-ID: List-Post: , List-Help: , List-Archive: , List-Unsubscribe: , On 11/02/2016 05:31 AM, Pavel Machek wrote: > 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? You would not believe the number of users I've dealt with that have confused "cmdline/command line" (aka prompt) with "kernel parameter". I go back and edit customer debug requests to make sure there's no use of cmdline in place of kernel parameter. For the love of every customer facing engineer out there, please stop using cmdline ;). P. > >> 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 > -- 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. From mboxrd@z Thu Jan 1 00:00:00 1970 From: Prarit Bhargava Subject: Re: [PATCH v2 34/37] docs: fix locations of several documents that got moved Date: Wed, 02 Nov 2016 06:08:43 -0400 Message-ID: <5819BB2B.7010404@redhat.com> References: <28c1f5d3867174a7017e3f3d9e9e4ebb096ceed8.1476801354.git.mchehab@s-opensource.com> <20161019103442.GD1461@amd> <20161019115918.1162d16e@vento.lan> <20161102093154.GC23350@amd> Reply-To: rtc-linux-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Cc: Linux Doc Mailing List , Mauro Carvalho Chehab , Jonathan Corbet , "Rafael J. Wysocki" , Len Brown , Jens Axboe , Alessandro Zummo , Alexandre Belloni , Rob Herring , Mark Rutland , Jean Delvare , Guenter Roeck , Karsten Keil , Mauro Carvalho Chehab , Steffen Klassert , Greg Kroah-Hartman , Johannes Berg , Jaroslav Kysela , Takashi Iwai , Paolo Bonzini , Mauro Carvalho Chehab Return-path: Sender: rtc-linux-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org In-Reply-To: <20161102093154.GC23350@amd> List-Post: , List-Help: , List-Archive: , List-Unsubscribe: , List-Id: kvm.vger.kernel.org On 11/02/2016 05:31 AM, Pavel Machek wrote: > 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? You would not believe the number of users I've dealt with that have confused "cmdline/command line" (aka prompt) with "kernel parameter". I go back and edit customer debug requests to make sure there's no use of cmdline in place of kernel parameter. For the love of every customer facing engineer out there, please stop using cmdline ;). P. > >> 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 > -- 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-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org For more options, visit https://groups.google.com/d/optout.