Re: Kernel docs: muddying the waters a bit

2016-05-06 Thread Mauro Carvalho Chehab
Em Fri, 6 May 2016 18:26:10 +0200 Markus Heiser escreveu: > Hi Mauro, > > Am 06.05.2016 um 13:03 schrieb Mauro Carvalho Chehab > : > > Yeah, it looks better, however table truncation seem to be > > happening also on other parts, like the

Re: Kernel docs: muddying the waters a bit

2016-05-06 Thread Mauro Carvalho Chehab
Em Fri, 6 May 2016 18:26:10 +0200 Markus Heiser escreveu: > Hi Mauro, > > Am 06.05.2016 um 13:03 schrieb Mauro Carvalho Chehab > : > > Yeah, it looks better, however table truncation seem to be > > happening also on other parts, like the tables on this page: > > > > > >

Re: Kernel docs: muddying the waters a bit

2016-05-06 Thread Markus Heiser
Hi Mauro, Am 06.05.2016 um 13:03 schrieb Mauro Carvalho Chehab : > Yeah, it looks better, however table truncation seem to be > happening also on other parts, like the tables on this page: > > >

Re: Kernel docs: muddying the waters a bit

2016-05-06 Thread Markus Heiser
Hi Mauro, Am 06.05.2016 um 13:03 schrieb Mauro Carvalho Chehab : > Yeah, it looks better, however table truncation seem to be > happening also on other parts, like the tables on this page: > > > https://return42.github.io/sphkerneldoc/books/linux_tv/media/v4l/pixfmt-packed-rgb.html >

Re: Kernel docs: muddying the waters a bit

2016-05-06 Thread Jani Nikula
On Fri, 06 May 2016, Markus Heiser wrote: > Am 06.05.2016 um 17:06 schrieb Jani Nikula : > >> On Fri, 06 May 2016, Markus Heiser wrote: >>> @Jonathan: what do you think? Should I prepare a patch >>> with a basic reST

Re: Kernel docs: muddying the waters a bit

2016-05-06 Thread Jani Nikula
On Fri, 06 May 2016, Markus Heiser wrote: > Am 06.05.2016 um 17:06 schrieb Jani Nikula : > >> On Fri, 06 May 2016, Markus Heiser wrote: >>> @Jonathan: what do you think? Should I prepare a patch >>> with a basic reST (sphinx) build infrastructure, including >>> >>> * a folder for sphinx docs:

Re: Kernel docs: muddying the waters a bit

2016-05-06 Thread Markus Heiser
Am 06.05.2016 um 17:06 schrieb Jani Nikula : > On Fri, 06 May 2016, Markus Heiser wrote: >> @Jonathan: what do you think? Should I prepare a patch >> with a basic reST (sphinx) build infrastructure, including >> >> * a folder for sphinx docs:

Re: Kernel docs: muddying the waters a bit

2016-05-06 Thread Markus Heiser
Am 06.05.2016 um 17:06 schrieb Jani Nikula : > On Fri, 06 May 2016, Markus Heiser wrote: >> @Jonathan: what do you think? Should I prepare a patch >> with a basic reST (sphinx) build infrastructure, including >> >> * a folder for sphinx docs: >> >> ./Documentation/sphinx/ > > I'm already

Re: Kernel docs: muddying the waters a bit

2016-05-06 Thread Mauro Carvalho Chehab
Em Fri, 6 May 2016 18:06:49 +0300 Jani Nikula escreveu: > On Fri, 06 May 2016, Markus Heiser wrote: > > @Jonathan: what do you think? Should I prepare a patch > > with a basic reST (sphinx) build infrastructure, including > > > > * a folder for

Re: Kernel docs: muddying the waters a bit

2016-05-06 Thread Mauro Carvalho Chehab
Em Fri, 6 May 2016 18:06:49 +0300 Jani Nikula escreveu: > On Fri, 06 May 2016, Markus Heiser wrote: > > @Jonathan: what do you think? Should I prepare a patch > > with a basic reST (sphinx) build infrastructure, including > > > > * a folder for sphinx docs: > > > > ./Documentation/sphinx/ >

Re: Kernel docs: muddying the waters a bit

2016-05-06 Thread Mauro Carvalho Chehab
Em Fri, 6 May 2016 16:27:21 +0200 Markus Heiser escreveu: > Hi all, hi Jonathan, > > Am 06.05.2016 um 15:42 schrieb Mauro Carvalho Chehab > : > > > Em Fri, 6 May 2016 15:32:35 +0200 > > Markus Heiser escreveu: > >

Re: Kernel docs: muddying the waters a bit

2016-05-06 Thread Mauro Carvalho Chehab
Em Fri, 6 May 2016 16:27:21 +0200 Markus Heiser escreveu: > Hi all, hi Jonathan, > > Am 06.05.2016 um 15:42 schrieb Mauro Carvalho Chehab > : > > > Em Fri, 6 May 2016 15:32:35 +0200 > > Markus Heiser escreveu: > > > >> Hi Mauro, > >> > >> Am 06.05.2016 um 13:35 schrieb Mauro Carvalho

Re: Kernel docs: muddying the waters a bit

2016-05-06 Thread Jani Nikula
On Fri, 06 May 2016, Markus Heiser wrote: > @Jonathan: what do you think? Should I prepare a patch > with a basic reST (sphinx) build infrastructure, including > > * a folder for sphinx docs: > > ./Documentation/sphinx/ I'm already working on a patch series taking a

Re: Kernel docs: muddying the waters a bit

2016-05-06 Thread Jani Nikula
On Fri, 06 May 2016, Markus Heiser wrote: > @Jonathan: what do you think? Should I prepare a patch > with a basic reST (sphinx) build infrastructure, including > > * a folder for sphinx docs: > > ./Documentation/sphinx/ I'm already working on a patch series taking a different approach. I don't

Re: Kernel docs: muddying the waters a bit

2016-05-06 Thread Markus Heiser
Hi all, hi Jonathan, Am 06.05.2016 um 15:42 schrieb Mauro Carvalho Chehab : > Em Fri, 6 May 2016 15:32:35 +0200 > Markus Heiser escreveu: > >> Hi Mauro, >> >> Am 06.05.2016 um 13:35 schrieb Mauro Carvalho Chehab >>

Re: Kernel docs: muddying the waters a bit

2016-05-06 Thread Markus Heiser
Hi all, hi Jonathan, Am 06.05.2016 um 15:42 schrieb Mauro Carvalho Chehab : > Em Fri, 6 May 2016 15:32:35 +0200 > Markus Heiser escreveu: > >> Hi Mauro, >> >> Am 06.05.2016 um 13:35 schrieb Mauro Carvalho Chehab >> : >> >>> Markus, >>> >>> Em Fri, 6 May 2016 13:23:06 +0200 >>> Markus

Re: Kernel docs: muddying the waters a bit

2016-05-06 Thread Markus Heiser
Hi Jani, I forget to mentioning, with a local copy of my kernel-doc script: https://github.com/return42/sphkerneldoc/blob/master/scripts/kernel-doc You could do reST markup in the source code comments and extract them. This might be a interim workaround which helps you not to edit source code

Re: Kernel docs: muddying the waters a bit

2016-05-06 Thread Markus Heiser
Hi Jani, I forget to mentioning, with a local copy of my kernel-doc script: https://github.com/return42/sphkerneldoc/blob/master/scripts/kernel-doc You could do reST markup in the source code comments and extract them. This might be a interim workaround which helps you not to edit source code

Re: Kernel docs: muddying the waters a bit

2016-05-06 Thread Markus Heiser
Hy Jani, Am 04.05.2016 um 18:13 schrieb Jani Nikula : >> Am 04.05.2016 um 17:09 schrieb Jonathan Corbet : >> >>> I think all of this makes sense. It would be really nice to have the >>> directives in the native sphinx language like that. I *don't* think

Re: Kernel docs: muddying the waters a bit

2016-05-06 Thread Markus Heiser
Hy Jani, Am 04.05.2016 um 18:13 schrieb Jani Nikula : >> Am 04.05.2016 um 17:09 schrieb Jonathan Corbet : >> >>> I think all of this makes sense. It would be really nice to have the >>> directives in the native sphinx language like that. I *don't* think we >>> need to aim for that at the

Re: Kernel docs: muddying the waters a bit

2016-05-06 Thread Markus Heiser
Hi Mauro, Am 04.05.2016 um 18:15 schrieb Mauro Carvalho Chehab : > Em Wed, 4 May 2016 11:34:08 +0200 > Markus Heiser escreveu: > >> Hi all, (hi Jonathan, please take note of my offer below) >> >> Am 03.05.2016 um 16:31 schrieb Daniel Vetter

Re: Kernel docs: muddying the waters a bit

2016-05-06 Thread Markus Heiser
Hi Mauro, Am 04.05.2016 um 18:15 schrieb Mauro Carvalho Chehab : > Em Wed, 4 May 2016 11:34:08 +0200 > Markus Heiser escreveu: > >> Hi all, (hi Jonathan, please take note of my offer below) >> >> Am 03.05.2016 um 16:31 schrieb Daniel Vetter : >> >>> Hi all, >>> >>> So sounds like moving

Re: Kernel docs: muddying the waters a bit

2016-05-05 Thread Mauro Carvalho Chehab
Em Thu, 5 May 2016 07:02:10 -0600 Jonathan Corbet escreveu: > On Wed, 4 May 2016 14:57:38 -0300 > Mauro Carvalho Chehab wrote: > > > Also, media documentation is not just one more documentation. It is > > the biggest one we have, and that has more

Re: Kernel docs: muddying the waters a bit

2016-05-05 Thread Mauro Carvalho Chehab
Em Thu, 5 May 2016 07:02:10 -0600 Jonathan Corbet escreveu: > On Wed, 4 May 2016 14:57:38 -0300 > Mauro Carvalho Chehab wrote: > > > Also, media documentation is not just one more documentation. It is > > the biggest one we have, and that has more changes than any other > > documentation under

Re: Kernel docs: muddying the waters a bit

2016-05-05 Thread Jonathan Corbet
On Wed, 4 May 2016 14:57:38 -0300 Mauro Carvalho Chehab wrote: > Also, media documentation is not just one more documentation. It is > the biggest one we have, and that has more changes than any other > documentation under Documentation/DocBook: > > $ git lg --since

Re: Kernel docs: muddying the waters a bit

2016-05-05 Thread Jonathan Corbet
On Wed, 4 May 2016 14:57:38 -0300 Mauro Carvalho Chehab wrote: > Also, media documentation is not just one more documentation. It is > the biggest one we have, and that has more changes than any other > documentation under Documentation/DocBook: > > $ git lg --since 01/01/2015 ` ls *.tmpl|grep

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Mauro Carvalho Chehab
Em Wed, 4 May 2016 10:59:36 -0600 Jonathan Corbet escreveu: > On Wed, 4 May 2016 13:50:35 -0300 > Mauro Carvalho Chehab wrote: > > > Em Wed, 4 May 2016 19:13:21 +0300 > > Jani Nikula escreveu: > > > I think we should go for

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Mauro Carvalho Chehab
Em Wed, 4 May 2016 10:59:36 -0600 Jonathan Corbet escreveu: > On Wed, 4 May 2016 13:50:35 -0300 > Mauro Carvalho Chehab wrote: > > > Em Wed, 4 May 2016 19:13:21 +0300 > > Jani Nikula escreveu: > > > I think we should go for vanilla sphinx at first, to make the setup step > > > as easy as

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Jonathan Corbet
On Wed, 4 May 2016 13:50:35 -0300 Mauro Carvalho Chehab wrote: > Em Wed, 4 May 2016 19:13:21 +0300 > Jani Nikula escreveu: > > I think we should go for vanilla sphinx at first, to make the setup step > > as easy as possible for everyone. > >

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Jonathan Corbet
On Wed, 4 May 2016 13:50:35 -0300 Mauro Carvalho Chehab wrote: > Em Wed, 4 May 2016 19:13:21 +0300 > Jani Nikula escreveu: > > I think we should go for vanilla sphinx at first, to make the setup step > > as easy as possible for everyone. > > Vanilla Sphinx doesn't work, as reST markup

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Mauro Carvalho Chehab
Em Wed, 4 May 2016 19:13:21 +0300 Jani Nikula escreveu: > On Wed, 04 May 2016, Markus Heiser wrote: > > Correct my, if I'am wrong. I'am a bit unfamiliar with DOCPROC in > > particular with your "MARKDOWNREADY := gpu.xml" process. > > > > As I

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Mauro Carvalho Chehab
Em Wed, 4 May 2016 19:13:21 +0300 Jani Nikula escreveu: > On Wed, 04 May 2016, Markus Heiser wrote: > > Correct my, if I'am wrong. I'am a bit unfamiliar with DOCPROC in > > particular with your "MARKDOWNREADY := gpu.xml" process. > > > > As I understood, you convert markdown to docbook within

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Mauro Carvalho Chehab
Em Wed, 4 May 2016 08:57:13 -0600 Jonathan Corbet escreveu: > On Wed, 4 May 2016 16:18:27 +0200 > Daniel Vetter wrote: > > > > I'd really like to converge on the markup question, so that we can start > > > using all the cool stuff with impunity in gpu

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Mauro Carvalho Chehab
Em Wed, 4 May 2016 08:57:13 -0600 Jonathan Corbet escreveu: > On Wed, 4 May 2016 16:18:27 +0200 > Daniel Vetter wrote: > > > > I'd really like to converge on the markup question, so that we can start > > > using all the cool stuff with impunity in gpu documentations. > > > > Aside: If we

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Daniel Vetter
On Wed, May 4, 2016 at 5:02 PM, Daniel Vetter wrote: > On Wed, May 04, 2016 at 08:57:13AM -0600, Jonathan Corbet wrote: >> On Wed, 4 May 2016 16:18:27 +0200 >> Daniel Vetter wrote: >> >> > > I'd really like to converge on the markup question, so that we

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Daniel Vetter
On Wed, May 4, 2016 at 5:02 PM, Daniel Vetter wrote: > On Wed, May 04, 2016 at 08:57:13AM -0600, Jonathan Corbet wrote: >> On Wed, 4 May 2016 16:18:27 +0200 >> Daniel Vetter wrote: >> >> > > I'd really like to converge on the markup question, so that we can start >> > > using all the cool stuff

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Mauro Carvalho Chehab
Em Wed, 4 May 2016 11:34:08 +0200 Markus Heiser escreveu: > Hi all, (hi Jonathan, please take note of my offer below) > > Am 03.05.2016 um 16:31 schrieb Daniel Vetter : > > > Hi all, > > > > So sounds like moving ahead with rst/sphinx is the

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Mauro Carvalho Chehab
Em Wed, 4 May 2016 11:34:08 +0200 Markus Heiser escreveu: > Hi all, (hi Jonathan, please take note of my offer below) > > Am 03.05.2016 um 16:31 schrieb Daniel Vetter : > > > Hi all, > > > > So sounds like moving ahead with rst/sphinx is the option that should > > allow us to address

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Jani Nikula
On Wed, 04 May 2016, Markus Heiser wrote: > Correct my, if I'am wrong. I'am a bit unfamiliar with DOCPROC in > particular with your "MARKDOWNREADY := gpu.xml" process. > > As I understood, you convert markdown to docbook within the kernel-doc > script using pandoc's

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Jani Nikula
On Wed, 04 May 2016, Markus Heiser wrote: > Correct my, if I'am wrong. I'am a bit unfamiliar with DOCPROC in > particular with your "MARKDOWNREADY := gpu.xml" process. > > As I understood, you convert markdown to docbook within the kernel-doc > script using pandoc's executable? ... I don't face

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Markus Heiser
Am 04.05.2016 um 15:43 schrieb Daniel Vetter : > On Wed, May 04, 2016 at 02:40:29PM +0200, Markus Heiser wrote: >>> On Wed, 04 May 2016, Markus Heiser wrote: >>> I'd be *very* hesitant about adding the kind of things you do in >>> reformat_block_rst to

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Markus Heiser
Am 04.05.2016 um 15:43 schrieb Daniel Vetter : > On Wed, May 04, 2016 at 02:40:29PM +0200, Markus Heiser wrote: >>> On Wed, 04 May 2016, Markus Heiser wrote: >>> I'd be *very* hesitant about adding the kind of things you do in >>> reformat_block_rst to kernel-doc. IMO the extraction from

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Jani Nikula
On Wed, 04 May 2016, Jonathan Corbet wrote: > The sphinx/rst approach does seem, to me, to be the right one, with the > existing DocBook structure remaining in place for those who want/need > it. I'm inclined toward my stuff as a base to work with, obviously :) But > it's hackish

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Jani Nikula
On Wed, 04 May 2016, Jonathan Corbet wrote: > The sphinx/rst approach does seem, to me, to be the right one, with the > existing DocBook structure remaining in place for those who want/need > it. I'm inclined toward my stuff as a base to work with, obviously :) But > it's hackish at best and

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Daniel Vetter
On Wed, May 04, 2016 at 08:57:13AM -0600, Jonathan Corbet wrote: > On Wed, 4 May 2016 16:18:27 +0200 > Daniel Vetter wrote: > > > > I'd really like to converge on the markup question, so that we can start > > > using all the cool stuff with impunity in gpu documentations.

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Daniel Vetter
On Wed, May 04, 2016 at 08:57:13AM -0600, Jonathan Corbet wrote: > On Wed, 4 May 2016 16:18:27 +0200 > Daniel Vetter wrote: > > > > I'd really like to converge on the markup question, so that we can start > > > using all the cool stuff with impunity in gpu documentations. > > > > Aside: If we

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Jonathan Corbet
On Wed, 04 May 2016 16:41:50 +0300 Jani Nikula wrote: > On Wed, 04 May 2016, Markus Heiser wrote: > > In reST the directive might look like: > > > > - > > Device Instance and Driver Handling > > === > > > >

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Jonathan Corbet
On Wed, 04 May 2016 16:41:50 +0300 Jani Nikula wrote: > On Wed, 04 May 2016, Markus Heiser wrote: > > In reST the directive might look like: > > > > - > > Device Instance and Driver Handling > > === > > > > .. kernel-doc:: drivers/gpu/drm/drm_drv.c > >

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Jonathan Corbet
On Wed, 4 May 2016 16:18:27 +0200 Daniel Vetter wrote: > > I'd really like to converge on the markup question, so that we can start > > using all the cool stuff with impunity in gpu documentations. > > Aside: If we decide this now I could send in a pull request for the

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Jonathan Corbet
On Wed, 4 May 2016 16:18:27 +0200 Daniel Vetter wrote: > > I'd really like to converge on the markup question, so that we can start > > using all the cool stuff with impunity in gpu documentations. > > Aside: If we decide this now I could send in a pull request for the > rst/sphinx kernel-doc

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Daniel Vetter
On Wed, May 4, 2016 at 3:43 PM, Daniel Vetter wrote: > I'd really like to converge on the markup question, so that we can start > using all the cool stuff with impunity in gpu documentations. Aside: If we decide this now I could send in a pull request for the rst/sphinx

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Daniel Vetter
On Wed, May 4, 2016 at 3:43 PM, Daniel Vetter wrote: > I'd really like to converge on the markup question, so that we can start > using all the cool stuff with impunity in gpu documentations. Aside: If we decide this now I could send in a pull request for the rst/sphinx kernel-doc support still

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Daniel Vetter
On Wed, May 04, 2016 at 02:40:29PM +0200, Markus Heiser wrote: > > On Wed, 04 May 2016, Markus Heiser wrote: > > I'd be *very* hesitant about adding the kind of things you do in > > reformat_block_rst to kernel-doc. IMO the extraction from kernel-doc > > comments must

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Daniel Vetter
On Wed, May 04, 2016 at 02:40:29PM +0200, Markus Heiser wrote: > > On Wed, 04 May 2016, Markus Heiser wrote: > > I'd be *very* hesitant about adding the kind of things you do in > > reformat_block_rst to kernel-doc. IMO the extraction from kernel-doc > > comments must be as simple as possible

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Jani Nikula
On Wed, 04 May 2016, Markus Heiser wrote: >> What do you mean by ".tmpl workflow"? > > Sorry for bad naming, I addressed the DOCPROC build process which builds > the .xml files from .tmpl files ... Yeah, I know more about this part than I care. I was just wondering

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Jani Nikula
On Wed, 04 May 2016, Markus Heiser wrote: >> What do you mean by ".tmpl workflow"? > > Sorry for bad naming, I addressed the DOCPROC build process which builds > the .xml files from .tmpl files ... Yeah, I know more about this part than I care. I was just wondering what you refer to with that in

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Markus Heiser
Hi Jani, Am 04.05.2016 um 11:58 schrieb Jani Nikula : > On Wed, 04 May 2016, Markus Heiser wrote: >> but I think this will not by very helpful, as long as you miss >> a similar ".tmpl" workflow for reST documents. >> >> I'am working on a reST

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Markus Heiser
Hi Jani, Am 04.05.2016 um 11:58 schrieb Jani Nikula : > On Wed, 04 May 2016, Markus Heiser wrote: >> but I think this will not by very helpful, as long as you miss >> a similar ".tmpl" workflow for reST documents. >> >> I'am working on a reST directive (named: "kernel-doc") to provide a >>

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Jani Nikula
On Wed, 04 May 2016, Markus Heiser wrote: > but I think this will not by very helpful, as long as you miss > a similar ".tmpl" workflow for reST documents. > > I'am working on a reST directive (named: "kernel-doc") to provide a > similar ".tmpl" workflow within plain

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Jani Nikula
On Wed, 04 May 2016, Markus Heiser wrote: > but I think this will not by very helpful, as long as you miss > a similar ".tmpl" workflow for reST documents. > > I'am working on a reST directive (named: "kernel-doc") to provide a > similar ".tmpl" workflow within plain reST. The first step towards

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Markus Heiser
Hi all, (hi Jonathan, please take note of my offer below) Am 03.05.2016 um 16:31 schrieb Daniel Vetter : > Hi all, > > So sounds like moving ahead with rst/sphinx is the option that should > allow us to address everyone's concerns eventually? Of course the > first one

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Markus Heiser
Hi all, (hi Jonathan, please take note of my offer below) Am 03.05.2016 um 16:31 schrieb Daniel Vetter : > Hi all, > > So sounds like moving ahead with rst/sphinx is the option that should > allow us to address everyone's concerns eventually? Of course the > first one won't have it all (media

Re: Kernel docs: muddying the waters a bit

2016-05-03 Thread Keith Packard
Daniel Vetter writes: > So sphinx/rst y/n? Jon, is that ok with you from the doc maintainer > pov? I think the right answer for today is to use sphinx to generate docs From inline comments, to encourage outline docs to give it a try but to allow doc writers to use

Re: Kernel docs: muddying the waters a bit

2016-05-03 Thread Keith Packard
Daniel Vetter writes: > So sphinx/rst y/n? Jon, is that ok with you from the doc maintainer > pov? I think the right answer for today is to use sphinx to generate docs From inline comments, to encourage outline docs to give it a try but to allow doc writers to use whatever works for them. That

Re: Kernel docs: muddying the waters a bit

2016-05-03 Thread Daniel Vetter
Hi all, So sounds like moving ahead with rst/sphinx is the option that should allow us to address everyone's concerns eventually? Of course the first one won't have it all (media seems really tricky), but I'd like to get something awesome in this area closer to mainline. I'm stalling on typing

Re: Kernel docs: muddying the waters a bit

2016-05-03 Thread Daniel Vetter
Hi all, So sounds like moving ahead with rst/sphinx is the option that should allow us to address everyone's concerns eventually? Of course the first one won't have it all (media seems really tricky), but I'd like to get something awesome in this area closer to mainline. I'm stalling on typing

Re: Kernel docs: muddying the waters a bit

2016-04-27 Thread Grant Likely
On Tue, Apr 12, 2016 at 4:46 PM, Jonathan Corbet wrote: > On Fri, 8 Apr 2016 17:12:27 +0200 > Markus Heiser wrote: > >> motivated by this MT, I implemented a toolchain to migrate the kernel’s >> DocBook XML documentation to reST markup. >> >> It

Re: Kernel docs: muddying the waters a bit

2016-04-27 Thread Grant Likely
On Tue, Apr 12, 2016 at 4:46 PM, Jonathan Corbet wrote: > On Fri, 8 Apr 2016 17:12:27 +0200 > Markus Heiser wrote: > >> motivated by this MT, I implemented a toolchain to migrate the kernel’s >> DocBook XML documentation to reST markup. >> >> It converts 99% of the docs well ... to gain an

Re: Kernel docs: muddying the waters a bit

2016-04-18 Thread Mauro Carvalho Chehab
Em Mon, 18 Apr 2016 10:10:17 +0200 Markus Heiser escreveu: > Hi Mauro, hi kernel-doc authors, > > Am 12.04.2016 um 15:58 schrieb Mauro Carvalho Chehab > : > > > Em Fri, 8 Apr 2016 17:12:27 +0200 > > Markus Heiser

Re: Kernel docs: muddying the waters a bit

2016-04-18 Thread Mauro Carvalho Chehab
Em Mon, 18 Apr 2016 10:10:17 +0200 Markus Heiser escreveu: > Hi Mauro, hi kernel-doc authors, > > Am 12.04.2016 um 15:58 schrieb Mauro Carvalho Chehab > : > > > Em Fri, 8 Apr 2016 17:12:27 +0200 > > Markus Heiser escreveu: > > > >> Hi kernel-doc authors, > >> > >> motivated by this MT,

Re: Kernel docs: muddying the waters a bit

2016-04-18 Thread Markus Heiser
Hi Jonahtan, Am 12.04.2016 um 17:46 schrieb Jonathan Corbet : > On Fri, 8 Apr 2016 17:12:27 +0200 > Markus Heiser wrote: > >> motivated by this MT, I implemented a toolchain to migrate the kernel’s >> DocBook XML documentation to reST markup. >> >>

Re: Kernel docs: muddying the waters a bit

2016-04-18 Thread Markus Heiser
Hi Jonahtan, Am 12.04.2016 um 17:46 schrieb Jonathan Corbet : > On Fri, 8 Apr 2016 17:12:27 +0200 > Markus Heiser wrote: > >> motivated by this MT, I implemented a toolchain to migrate the kernel’s >> DocBook XML documentation to reST markup. >> >> It converts 99% of the docs well ... to

Re: Kernel docs: muddying the waters a bit

2016-04-18 Thread Markus Heiser
Hi Mauro, hi kernel-doc authors, Am 12.04.2016 um 15:58 schrieb Mauro Carvalho Chehab : > Em Fri, 8 Apr 2016 17:12:27 +0200 > Markus Heiser escreveu: > >> Hi kernel-doc authors, >> >> motivated by this MT, I implemented a toolchain to

Re: Kernel docs: muddying the waters a bit

2016-04-18 Thread Markus Heiser
Hi Mauro, hi kernel-doc authors, Am 12.04.2016 um 15:58 schrieb Mauro Carvalho Chehab : > Em Fri, 8 Apr 2016 17:12:27 +0200 > Markus Heiser escreveu: > >> Hi kernel-doc authors, >> >> motivated by this MT, I implemented a toolchain to migrate the kernel’s >> DocBook XML documentation to

Re: Kernel docs: muddying the waters a bit

2016-04-12 Thread Jonathan Corbet
On Fri, 8 Apr 2016 17:12:27 +0200 Markus Heiser wrote: > motivated by this MT, I implemented a toolchain to migrate the kernel’s > DocBook XML documentation to reST markup. > > It converts 99% of the docs well ... to gain an impression how > kernel-docs could

Re: Kernel docs: muddying the waters a bit

2016-04-12 Thread Jonathan Corbet
On Fri, 8 Apr 2016 17:12:27 +0200 Markus Heiser wrote: > motivated by this MT, I implemented a toolchain to migrate the kernel’s > DocBook XML documentation to reST markup. > > It converts 99% of the docs well ... to gain an impression how > kernel-docs could benefit from, visit my

Re: Kernel docs: muddying the waters a bit

2016-04-12 Thread Hans Verkuil
Hi Markus, On 04/08/16 17:12, Markus Heiser wrote: > Hi kernel-doc authors, > > motivated by this MT, I implemented a toolchain to migrate the kernel’s > DocBook XML documentation to reST markup. > > It converts 99% of the docs well ... to gain an impression how > kernel-docs could benefit

Re: Kernel docs: muddying the waters a bit

2016-04-12 Thread Hans Verkuil
Hi Markus, On 04/08/16 17:12, Markus Heiser wrote: > Hi kernel-doc authors, > > motivated by this MT, I implemented a toolchain to migrate the kernel’s > DocBook XML documentation to reST markup. > > It converts 99% of the docs well ... to gain an impression how > kernel-docs could benefit

Re: Kernel docs: muddying the waters a bit

2016-04-08 Thread Markus Heiser
Hi kernel-doc authors, motivated by this MT, I implemented a toolchain to migrate the kernel’s DocBook XML documentation to reST markup. It converts 99% of the docs well ... to gain an impression how kernel-docs could benefit from, visit my sphkerneldoc project page on github:

Re: Kernel docs: muddying the waters a bit

2016-04-08 Thread Markus Heiser
Hi kernel-doc authors, motivated by this MT, I implemented a toolchain to migrate the kernel’s DocBook XML documentation to reST markup. It converts 99% of the docs well ... to gain an impression how kernel-docs could benefit from, visit my sphkerneldoc project page on github:

Re: Kernel docs: muddying the waters a bit

2016-03-13 Thread Markus Heiser
Am 10.03.2016 um 16:21 schrieb Mauro Carvalho Chehab : > Em Thu, 10 Mar 2016 12:25:58 +0200 > Jani Nikula escreveu: > >> TL;DR? Skip to the last paragraph. >> >> On Wed, 09 Mar 2016, Mauro Carvalho Chehab wrote: >>> I

Re: Kernel docs: muddying the waters a bit

2016-03-13 Thread Markus Heiser
Am 10.03.2016 um 16:21 schrieb Mauro Carvalho Chehab : > Em Thu, 10 Mar 2016 12:25:58 +0200 > Jani Nikula escreveu: > >> TL;DR? Skip to the last paragraph. >> >> On Wed, 09 Mar 2016, Mauro Carvalho Chehab wrote: >>> I guess the conversion to asciidoc format is now in good shape, >>> at least

Re: Kernel docs: muddying the waters a bit

2016-03-10 Thread Mauro Carvalho Chehab
Em Thu, 10 Mar 2016 12:25:58 +0200 Jani Nikula escreveu: > TL;DR? Skip to the last paragraph. > > On Wed, 09 Mar 2016, Mauro Carvalho Chehab wrote: > > I guess the conversion to asciidoc format is now in good shape, > > at least to demonstrate

Re: Kernel docs: muddying the waters a bit

2016-03-10 Thread Mauro Carvalho Chehab
Em Thu, 10 Mar 2016 12:25:58 +0200 Jani Nikula escreveu: > TL;DR? Skip to the last paragraph. > > On Wed, 09 Mar 2016, Mauro Carvalho Chehab wrote: > > I guess the conversion to asciidoc format is now in good shape, > > at least to demonstrate that it is possible to use this format for the > >

Re: Kernel docs: muddying the waters a bit

2016-03-10 Thread Jani Nikula
TL;DR? Skip to the last paragraph. On Wed, 09 Mar 2016, Mauro Carvalho Chehab wrote: > I guess the conversion to asciidoc format is now in good shape, > at least to demonstrate that it is possible to use this format for the > media docbook. Still, there are lots of

Re: Kernel docs: muddying the waters a bit

2016-03-10 Thread Jani Nikula
TL;DR? Skip to the last paragraph. On Wed, 09 Mar 2016, Mauro Carvalho Chehab wrote: > I guess the conversion to asciidoc format is now in good shape, > at least to demonstrate that it is possible to use this format for the > media docbook. Still, there are lots of broken references. Getting

Re: Kernel docs: muddying the waters a bit

2016-03-09 Thread Mauro Carvalho Chehab
Em Tue, 8 Mar 2016 12:39:21 -0300 Mauro Carvalho Chehab escreveu: > Pandoc failed to fully convert it, but at least it left all the texts, > with prevented rewriting it from scratch. This is the manual fix > I applied to it: > >

Re: Kernel docs: muddying the waters a bit

2016-03-09 Thread Mauro Carvalho Chehab
Em Tue, 8 Mar 2016 12:39:21 -0300 Mauro Carvalho Chehab escreveu: > Pandoc failed to fully convert it, but at least it left all the texts, > with prevented rewriting it from scratch. This is the manual fix > I applied to it: > >

Re: Kernel docs: muddying the waters a bit

2016-03-09 Thread Jani Nikula
On Wed, 09 Mar 2016, Dan Allen wrote: > On Tue, Mar 8, 2016 at 6:58 AM, Jani Nikula wrote: > >> I need to look into this again. Is there a specific option or directive >> to produce split output for includes? When I tried this, the result was >> just

Re: Kernel docs: muddying the waters a bit

2016-03-09 Thread Jani Nikula
On Wed, 09 Mar 2016, Dan Allen wrote: > On Tue, Mar 8, 2016 at 6:58 AM, Jani Nikula wrote: > >> I need to look into this again. Is there a specific option or directive >> to produce split output for includes? When I tried this, the result was >> just one big output file. (And indeed we'd need

Re: Kernel docs: muddying the waters a bit

2016-03-08 Thread Mauro Carvalho Chehab
Em Tue, 8 Mar 2016 10:39:22 -0300 Mauro Carvalho Chehab escreveu: > Em Tue, 08 Mar 2016 05:13:13 -0700 > Dan Allen escreveu: > > > On Tue, Mar 8, 2016 at 4:29 AM, Mauro Carvalho Chehab < > > mche...@osg.samsung.com> wrote: > > > > > pandoc

Re: Kernel docs: muddying the waters a bit

2016-03-08 Thread Mauro Carvalho Chehab
Em Tue, 8 Mar 2016 10:39:22 -0300 Mauro Carvalho Chehab escreveu: > Em Tue, 08 Mar 2016 05:13:13 -0700 > Dan Allen escreveu: > > > On Tue, Mar 8, 2016 at 4:29 AM, Mauro Carvalho Chehab < > > mche...@osg.samsung.com> wrote: > > > > > pandoc did a really crap job on the conversion. To

Re: Kernel docs: muddying the waters a bit

2016-03-08 Thread Jani Nikula
On Tue, 08 Mar 2016, Dan Allen wrote: > That's not entirely true. First, you can pre-split at the source level > using includes and generate output for each of the masters. That's what I > tend to do and it works really well since these are logical split points. I need to

Re: Kernel docs: muddying the waters a bit

2016-03-08 Thread Jani Nikula
On Tue, 08 Mar 2016, Dan Allen wrote: > That's not entirely true. First, you can pre-split at the source level > using includes and generate output for each of the masters. That's what I > tend to do and it works really well since these are logical split points. I need to look into this again.

Re: Kernel docs: muddying the waters a bit

2016-03-08 Thread Mauro Carvalho Chehab
Em Tue, 08 Mar 2016 05:13:13 -0700 Dan Allen escreveu: > On Tue, Mar 8, 2016 at 4:29 AM, Mauro Carvalho Chehab < > mche...@osg.samsung.com> wrote: > > > pandoc did a really crap job on the conversion. To convert this > > into something useful, we'll need to spend a lot of

Re: Kernel docs: muddying the waters a bit

2016-03-08 Thread Mauro Carvalho Chehab
Em Tue, 08 Mar 2016 05:13:13 -0700 Dan Allen escreveu: > On Tue, Mar 8, 2016 at 4:29 AM, Mauro Carvalho Chehab < > mche...@osg.samsung.com> wrote: > > > pandoc did a really crap job on the conversion. To convert this > > into something useful, we'll need to spend a lot of time, as it lost > >

Re: Kernel docs: muddying the waters a bit

2016-03-08 Thread Mauro Carvalho Chehab
Em Tue, 08 Mar 2016 05:09:40 -0700 Dan Allen escreveu: > Jani wrote: > > > there was no support for chunked, or split > > to chapters, HTML, and the single page result was simply way too big. > > > > That's not entirely true. First, you can pre-split at the source level >

Re: Kernel docs: muddying the waters a bit

2016-03-08 Thread Mauro Carvalho Chehab
Em Tue, 08 Mar 2016 05:09:40 -0700 Dan Allen escreveu: > Jani wrote: > > > there was no support for chunked, or split > > to chapters, HTML, and the single page result was simply way too big. > > > > That's not entirely true. First, you can pre-split at the source level > using includes and

Re: Kernel docs: muddying the waters a bit

2016-03-08 Thread Mauro Carvalho Chehab
Em Tue, 08 Mar 2016 11:49:35 +0200 Jani Nikula escreveu: > On Tue, 08 Mar 2016, Dan Allen wrote: > > One of the key goals of the Asciidoctor project is to be able to directly > > produce a wide variety of outputs from the same source (without DocBook).

Re: Kernel docs: muddying the waters a bit

2016-03-08 Thread Mauro Carvalho Chehab
Em Tue, 08 Mar 2016 11:49:35 +0200 Jani Nikula escreveu: > On Tue, 08 Mar 2016, Dan Allen wrote: > > One of the key goals of the Asciidoctor project is to be able to directly > > produce a wide variety of outputs from the same source (without DocBook). > > We've added flexibility and best

  1   2   >