* [PATCH] Documentation: platform: convert x86-laptop-drivers.txt to reST @ 2019-06-18 5:32 Puranjay Mohan 2019-06-18 5:41 ` [Linux-kernel-mentees] " Greg KH 0 siblings, 1 reply; 7+ messages in thread From: Puranjay Mohan @ 2019-06-18 5:32 UTC (permalink / raw) To: Shuah Khan Cc: Puranjay Mohan, linux-kernel-mentees, Jonathan Corbet, linux-doc, linux-kernel This converts the plain text documentation to reStructuredText format. No essential content change. Signed-off-by: Puranjay Mohan <puranjay12@gmail.com> --- Documentation/platform/x86-laptop-drivers.rst | 23 +++++++++++++++++++ Documentation/platform/x86-laptop-drivers.txt | 18 --------------- 2 files changed, 23 insertions(+), 18 deletions(-) create mode 100644 Documentation/platform/x86-laptop-drivers.rst delete mode 100644 Documentation/platform/x86-laptop-drivers.txt diff --git a/Documentation/platform/x86-laptop-drivers.rst b/Documentation/platform/x86-laptop-drivers.rst new file mode 100644 index 000000000000..0494c3fdd41c --- /dev/null +++ b/Documentation/platform/x86-laptop-drivers.rst @@ -0,0 +1,23 @@ +============= +compal-laptop +============= + +List of supported hardware: +=========================== + +by Compal: +---------- +- Compal FL90/IFL90 +- Compal FL91/IFL91 +- Compal FL92/JFL92 +- Compal FT00/IFT00 + +by Dell: +-------- +- Dell Vostro 1200 +- Dell Mini 9 (Inspiron 910) +- Dell Mini 10 (Inspiron 1010) +- Dell Mini 10v (Inspiron 1011) +- Dell Mini 1012 (Inspiron 1012) +- Dell Inspiron 11z (Inspiron 1110) +- Dell Mini 12 (Inspiron 1210) diff --git a/Documentation/platform/x86-laptop-drivers.txt b/Documentation/platform/x86-laptop-drivers.txt deleted file mode 100644 index 01facd2590bb..000000000000 --- a/Documentation/platform/x86-laptop-drivers.txt +++ /dev/null @@ -1,18 +0,0 @@ -compal-laptop -============= -List of supported hardware: - -by Compal: - Compal FL90/IFL90 - Compal FL91/IFL91 - Compal FL92/JFL92 - Compal FT00/IFT00 - -by Dell: - Dell Vostro 1200 - Dell Mini 9 (Inspiron 910) - Dell Mini 10 (Inspiron 1010) - Dell Mini 10v (Inspiron 1011) - Dell Mini 1012 (Inspiron 1012) - Dell Inspiron 11z (Inspiron 1110) - Dell Mini 12 (Inspiron 1210) -- 2.21.0 ^ permalink raw reply related [flat|nested] 7+ messages in thread
* Re: [Linux-kernel-mentees] [PATCH] Documentation: platform: convert x86-laptop-drivers.txt to reST 2019-06-18 5:32 [PATCH] Documentation: platform: convert x86-laptop-drivers.txt to reST Puranjay Mohan @ 2019-06-18 5:41 ` Greg KH 2019-06-18 13:17 ` Jonathan Corbet 0 siblings, 1 reply; 7+ messages in thread From: Greg KH @ 2019-06-18 5:41 UTC (permalink / raw) To: Puranjay Mohan Cc: Shuah Khan, linux-doc, linux-kernel-mentees, linux-kernel, Jonathan Corbet On Tue, Jun 18, 2019 at 11:02:27AM +0530, Puranjay Mohan wrote: > This converts the plain text documentation to reStructuredText format. > No essential content change. > > Signed-off-by: Puranjay Mohan <puranjay12@gmail.com> > --- > Documentation/platform/x86-laptop-drivers.rst | 23 +++++++++++++++++++ > Documentation/platform/x86-laptop-drivers.txt | 18 --------------- > 2 files changed, 23 insertions(+), 18 deletions(-) > create mode 100644 Documentation/platform/x86-laptop-drivers.rst > delete mode 100644 Documentation/platform/x86-laptop-drivers.txt Don't you also need to hook it up to the documentation build process when doing this? thanks, greg k-h ^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [Linux-kernel-mentees] [PATCH] Documentation: platform: convert x86-laptop-drivers.txt to reST 2019-06-18 5:41 ` [Linux-kernel-mentees] " Greg KH @ 2019-06-18 13:17 ` Jonathan Corbet 2019-06-18 13:39 ` Greg KH 0 siblings, 1 reply; 7+ messages in thread From: Jonathan Corbet @ 2019-06-18 13:17 UTC (permalink / raw) To: Greg KH Cc: Puranjay Mohan, Shuah Khan, linux-doc, linux-kernel-mentees, linux-kernel On Tue, 18 Jun 2019 07:41:58 +0200 Greg KH <gregkh@linuxfoundation.org> wrote: > On Tue, Jun 18, 2019 at 11:02:27AM +0530, Puranjay Mohan wrote: > > This converts the plain text documentation to reStructuredText format. > > No essential content change. > > > > Signed-off-by: Puranjay Mohan <puranjay12@gmail.com> > > --- > > Documentation/platform/x86-laptop-drivers.rst | 23 +++++++++++++++++++ > > Documentation/platform/x86-laptop-drivers.txt | 18 --------------- > > 2 files changed, 23 insertions(+), 18 deletions(-) > > create mode 100644 Documentation/platform/x86-laptop-drivers.rst > > delete mode 100644 Documentation/platform/x86-laptop-drivers.txt > > Don't you also need to hook it up to the documentation build process > when doing this? Hooking it into the TOC tree is a good thing, but I think it's also good to think about the exercise in general. This is a document dropped into place five years ago and never touched again. It's a short list of seemingly ancient laptops with no explanation of what it means. So the real question, IMO, is whether this document is useful to anybody and, if not, whether it should just be deleted instead. Puranjay, thanks for working to improve the kernel docs! Please don't be discouraged by this response - it's just a sign that kernel documentation has problems far beyond just formatting... Thanks, jon ^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [Linux-kernel-mentees] [PATCH] Documentation: platform: convert x86-laptop-drivers.txt to reST 2019-06-18 13:17 ` Jonathan Corbet @ 2019-06-18 13:39 ` Greg KH 2019-06-18 15:04 ` Shuah Khan 0 siblings, 1 reply; 7+ messages in thread From: Greg KH @ 2019-06-18 13:39 UTC (permalink / raw) To: Jonathan Corbet Cc: Puranjay Mohan, Shuah Khan, linux-doc, linux-kernel-mentees, linux-kernel On Tue, Jun 18, 2019 at 07:17:17AM -0600, Jonathan Corbet wrote: > On Tue, 18 Jun 2019 07:41:58 +0200 > Greg KH <gregkh@linuxfoundation.org> wrote: > > > On Tue, Jun 18, 2019 at 11:02:27AM +0530, Puranjay Mohan wrote: > > > This converts the plain text documentation to reStructuredText format. > > > No essential content change. > > > > > > Signed-off-by: Puranjay Mohan <puranjay12@gmail.com> > > > --- > > > Documentation/platform/x86-laptop-drivers.rst | 23 +++++++++++++++++++ > > > Documentation/platform/x86-laptop-drivers.txt | 18 --------------- > > > 2 files changed, 23 insertions(+), 18 deletions(-) > > > create mode 100644 Documentation/platform/x86-laptop-drivers.rst > > > delete mode 100644 Documentation/platform/x86-laptop-drivers.txt > > > > Don't you also need to hook it up to the documentation build process > > when doing this? > > Hooking it into the TOC tree is a good thing, but I think it's also good > to think about the exercise in general. This is a document dropped into > place five years ago and never touched again. It's a short list of > seemingly ancient laptops with no explanation of what it means. So the > real question, IMO, is whether this document is useful to anybody and, if > not, whether it should just be deleted instead. I bet it should be deleted, but we should ask the platform driver maintainers first before we do that :) thanks, greg k-h ^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [Linux-kernel-mentees] [PATCH] Documentation: platform: convert x86-laptop-drivers.txt to reST 2019-06-18 13:39 ` Greg KH @ 2019-06-18 15:04 ` Shuah Khan 2019-06-20 6:19 ` Andy Shevchenko 0 siblings, 1 reply; 7+ messages in thread From: Shuah Khan @ 2019-06-18 15:04 UTC (permalink / raw) To: Greg KH, Jonathan Corbet, cezary.jackiewicz, Darren Hart, andy, Shuah Khan Cc: Puranjay Mohan, linux-doc, linux-kernel-mentees, linux-kernel, platform-driver-x86 On 6/18/19 7:39 AM, Greg KH wrote: > On Tue, Jun 18, 2019 at 07:17:17AM -0600, Jonathan Corbet wrote: >> On Tue, 18 Jun 2019 07:41:58 +0200 >> Greg KH <gregkh@linuxfoundation.org> wrote: >> >>> On Tue, Jun 18, 2019 at 11:02:27AM +0530, Puranjay Mohan wrote: >>>> This converts the plain text documentation to reStructuredText format. >>>> No essential content change. >>>> >>>> Signed-off-by: Puranjay Mohan <puranjay12@gmail.com> >>>> --- >>>> Documentation/platform/x86-laptop-drivers.rst | 23 +++++++++++++++++++ >>>> Documentation/platform/x86-laptop-drivers.txt | 18 --------------- >>>> 2 files changed, 23 insertions(+), 18 deletions(-) >>>> create mode 100644 Documentation/platform/x86-laptop-drivers.rst >>>> delete mode 100644 Documentation/platform/x86-laptop-drivers.txt >>> >>> Don't you also need to hook it up to the documentation build process >>> when doing this? >> >> Hooking it into the TOC tree is a good thing, but I think it's also good >> to think about the exercise in general. This is a document dropped into >> place five years ago and never touched again. It's a short list of >> seemingly ancient laptops with no explanation of what it means. So the >> real question, IMO, is whether this document is useful to anybody and, if >> not, whether it should just be deleted instead. > > I bet it should be deleted, but we should ask the platform driver > maintainers first before we do that :) > Adding Platform driver maintainers Darren Hart and Andy Shevchenko, and Compal laptop maintainer Cezary Jackiewicz to the discussion. + platform-driver-x86@vger.kernel.org Hi Darren, Andy, and Cezary, Would it be okay to remove the x86-laptop-drivers.txt or should it be converted to .rst and kept around? thanks, -- Shuah ^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [Linux-kernel-mentees] [PATCH] Documentation: platform: convert x86-laptop-drivers.txt to reST 2019-06-18 15:04 ` Shuah Khan @ 2019-06-20 6:19 ` Andy Shevchenko 2019-06-20 13:38 ` Shuah Khan 0 siblings, 1 reply; 7+ messages in thread From: Andy Shevchenko @ 2019-06-20 6:19 UTC (permalink / raw) To: Shuah Khan Cc: Greg KH, Jonathan Corbet, Cezary Jackiewicz, Darren Hart, Andy Shevchenko, Puranjay Mohan, Linux Documentation List, linux-kernel-mentees, Linux Kernel Mailing List, Platform Driver On Tue, Jun 18, 2019 at 6:06 PM Shuah Khan <skhan@linuxfoundation.org> wrote: > On 6/18/19 7:39 AM, Greg KH wrote: > > On Tue, Jun 18, 2019 at 07:17:17AM -0600, Jonathan Corbet wrote: > >> On Tue, 18 Jun 2019 07:41:58 +0200 > >> Greg KH <gregkh@linuxfoundation.org> wrote: > >>> On Tue, Jun 18, 2019 at 11:02:27AM +0530, Puranjay Mohan wrote: > > I bet it should be deleted, but we should ask the platform driver > > maintainers first before we do that :) > Adding Platform driver maintainers Darren Hart and Andy Shevchenko, and > Compal laptop maintainer Cezary Jackiewicz to the discussion. > > + platform-driver-x86@vger.kernel.org > > Hi Darren, Andy, and Cezary, > > Would it be okay to remove the x86-laptop-drivers.txt or should it be > converted to .rst and kept around? Shuan, thanks for heads up. The list of laptops supported by drivers in PDx86 subsystem is quite big and growing. The mentioned file contains less than per cent out of it and I don't think there is sense to make it up to date with thousands lines. Agree on removal. -- With Best Regards, Andy Shevchenko ^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [Linux-kernel-mentees] [PATCH] Documentation: platform: convert x86-laptop-drivers.txt to reST 2019-06-20 6:19 ` Andy Shevchenko @ 2019-06-20 13:38 ` Shuah Khan 0 siblings, 0 replies; 7+ messages in thread From: Shuah Khan @ 2019-06-20 13:38 UTC (permalink / raw) To: Andy Shevchenko, Puranjay Mohan Cc: Greg KH, Jonathan Corbet, Cezary Jackiewicz, Darren Hart, Andy Shevchenko, Linux Documentation List, linux-kernel-mentees, Linux Kernel Mailing List, Platform Driver, Shuah Khan On 6/20/19 12:19 AM, Andy Shevchenko wrote: > On Tue, Jun 18, 2019 at 6:06 PM Shuah Khan <skhan@linuxfoundation.org> wrote: >> On 6/18/19 7:39 AM, Greg KH wrote: >>> On Tue, Jun 18, 2019 at 07:17:17AM -0600, Jonathan Corbet wrote: >>>> On Tue, 18 Jun 2019 07:41:58 +0200 >>>> Greg KH <gregkh@linuxfoundation.org> wrote: >>>>> On Tue, Jun 18, 2019 at 11:02:27AM +0530, Puranjay Mohan wrote: > >>> I bet it should be deleted, but we should ask the platform driver >>> maintainers first before we do that :) > >> Adding Platform driver maintainers Darren Hart and Andy Shevchenko, and >> Compal laptop maintainer Cezary Jackiewicz to the discussion. >> >> + platform-driver-x86@vger.kernel.org >> >> Hi Darren, Andy, and Cezary, >> >> Would it be okay to remove the x86-laptop-drivers.txt or should it be >> converted to .rst and kept around? > > Shuan, thanks for heads up. > The list of laptops supported by drivers in PDx86 subsystem is quite > big and growing. The mentioned file contains less than per cent out of > it and I don't think there is sense to make it up to date with > thousands lines. Agree on removal. > Thanks Andy! Puranjay! Please remove the file and cc everybody on this list on the v2 patch. Make sure to build docs and see if this removal doesn't cause errors. thanks, -- Shuah ^ permalink raw reply [flat|nested] 7+ messages in thread
end of thread, other threads:[~2019-06-20 13:38 UTC | newest] Thread overview: 7+ messages (download: mbox.gz follow: Atom feed -- links below jump to the message on this page -- 2019-06-18 5:32 [PATCH] Documentation: platform: convert x86-laptop-drivers.txt to reST Puranjay Mohan 2019-06-18 5:41 ` [Linux-kernel-mentees] " Greg KH 2019-06-18 13:17 ` Jonathan Corbet 2019-06-18 13:39 ` Greg KH 2019-06-18 15:04 ` Shuah Khan 2019-06-20 6:19 ` Andy Shevchenko 2019-06-20 13:38 ` Shuah Khan
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).