Re: [Ksummit-discuss] [PATCH] media: add a subsystem profile documentation

2019-09-23 Thread Jonathan Corbet
On Mon, 23 Sep 2019 08:58:28 -0700 Doug Anderson wrote: > I swear that I was involved in a conversation in the past where > someone suggested to stop CCing LKML on patches and Jonathan Corbet > jumped in and said that he supported CCing LKML on all patches. I don't *think* I sai

Re: [Ksummit-discuss] single maintainer profile directory (was Re: [PATCH] media: add a subsystem profile documentation)

2019-09-21 Thread Jonathan Corbet
On Wed, 18 Sep 2019 08:23:26 -0300 Mauro Carvalho Chehab wrote: > A simple/lazy solution would be to apply the enclosed patch - or a > variant of it that would place the contents of MAINTAINERS outside > process/index.html, and add instructions about how to use > get_maintainers.pl. > > Jon, >

Re: [PATCH RFC 00/15] Zero ****s, hugload of hugs <3

2018-11-30 Thread Jonathan Corbet
On Fri, 30 Nov 2018 14:12:19 -0800 Jarkko Sakkinen wrote: > As a maintainer myself (and based on somewhat disturbed feedback from > other maintainers) I can only make the conclusion that nobody knows what > the responsibility part here means. > > I would interpret, if I read it like at lawyer at

Re: [PATCH RFC 00/15] Zero ****s, hugload of hugs <3

2018-11-30 Thread Jonathan Corbet
On Fri, 30 Nov 2018 12:55:21 -0800 Jarkko Sakkinen wrote: > This a direct quote from the CoC: > > "Harassment includes the use of abusive, offensive or degrading > language, intimidation, stalking, harassing photography or recording, > inappropriate physical contact, sexual imagery and unwelcome

Re: [PATCH v4 00/18] kernel-doc: add supported to document nested structs

2017-12-21 Thread Jonathan Corbet
On Mon, 18 Dec 2017 10:30:01 -0200 Mauro Carvalho Chehab wrote: > This is a rebased version of my patch series that add support for > nested structs on kernel-doc. With this version, it won't produce anymore > hundreds of identical warnings, as patch 17 removes the warning > duplication. > > Exc

Re: [PATCH v2] kernel-doc: parse DECLARE_KFIFO and DECLARE_KFIFO_PTR()

2017-12-11 Thread Jonathan Corbet
On Fri, 8 Dec 2017 09:05:12 -0500 Mauro Carvalho Chehab wrote: > So, teach kernel-doc how to parse DECLARE_KFIFO() and DECLARE_KFIFO_PTR(). > > While here, relax at the past DECLARE_foo() macros, accepting a random > number of spaces after comma. Applied, thanks. jon

Re: [PATCH v3 00/17] kernel-doc: add supported to document nested structs/

2017-10-07 Thread Jonathan Corbet
On Wed, 4 Oct 2017 08:48:38 -0300 Mauro Carvalho Chehab wrote: > Right now, it is not possible to document nested struct and nested unions. > kernel-doc simply ignore them. > > Add support to document them. So I've finally found some time to actually look at these; sorry for being so absent fr

Re: [PATCH 09/10] scripts: kernel-doc: parse next structs/unions

2017-09-28 Thread Jonathan Corbet
On Tue, 26 Sep 2017 17:29:47 -0300 Mauro Carvalho Chehab wrote: > This patch actually need a fixup, in order to handle pointer, > array and bitmask IDs. Can you send a new series with the fixed patch? I sure do like the shrinking of kernel-doc that comes with this series! Thanks, jon

Re: [PATCH 1/2] docs: kernel-doc comments are ASCII

2017-08-31 Thread Jonathan Corbet
On Thu, 31 Aug 2017 10:56:26 -0300 Mauro Carvalho Chehab wrote: > It should have something to do with python version and/or to some > locale info at the system, as neither I or Jon can reproduce it. I can't reproduce it here, but I have certainly seen situations where Python 2 wants to run with

Re: [PATCH 1/2] docs: kernel-doc comments are ASCII

2017-08-30 Thread Jonathan Corbet
On Wed, 30 Aug 2017 19:15:53 -0300 Mauro Carvalho Chehab wrote: > I suspect that the problem is not related to the version, but to > what you might have set on LANG. > > Maybe if we add something like: > LANG=C.utf-8 > > to the Documentation/Makefile That's worth a try; Randy, can you g

Re: [PATCH 2/2] media: dvb-core: fix demux.h non-ASCII characters

2017-08-30 Thread Jonathan Corbet
On Mon, 28 Aug 2017 16:10:16 -0700 Randy Dunlap wrote: > Fix non-ASCII charactes in kernel-doc comment to prevent the kernel-doc > build warning below. > > WARNING: kernel-doc '../scripts/kernel-doc -rst -enable-lineno > ../drivers/media/dvb-core/demux.h' processing failed with: 'ascii' codec

Re: [PATCH 1/2] docs: kernel-doc comments are ASCII

2017-08-30 Thread Jonathan Corbet
On Mon, 28 Aug 2017 16:10:09 -0700 Randy Dunlap wrote: > kernel-doc parsing uses as ASCII codec, so let people know that > kernel-doc comments should be in ASCII characters only. > > WARNING: kernel-doc '../scripts/kernel-doc -rst -enable-lineno > ../drivers/media/dvb-core/demux.h' processing f

Re: [PATCH 0/4] Fix problems on building documentation with Sphinx 1.6

2017-08-26 Thread Jonathan Corbet
On Sat, 26 Aug 2017 06:28:24 -0300 Mauro Carvalho Chehab wrote: > IMHO, the best is if I apply patch 2 on my trees. Please apply > patches 1 and 3 on your tree. > > Patch 4 can only be applied after patch 2 gets merged, but it > is just a cleanup patch that can be applied any time later. OK, I

Re: [PATCH v2 4/4] docs-rst: Allow Sphinx version 1.6

2017-08-24 Thread Jonathan Corbet
On Thu, 24 Aug 2017 13:26:28 -0600 Jonathan Corbet wrote: > > - % To allow adjusting table sizes > > - \\usepackage{adjustbox} > > - > > ''' > > } > > So this change doesn't quite match the changelog...what's the story

Re: [PATCH v2 4/4] docs-rst: Allow Sphinx version 1.6

2017-08-24 Thread Jonathan Corbet
On Wed, 23 Aug 2017 05:56:57 -0300 Mauro Carvalho Chehab wrote: > Now that the PDF building issues with Sphinx 1.6 got fixed, > update the documentation and scripts accordingly. > > Signed-off-by: Mauro Carvalho Chehab > --- > Documentation/conf.py | 3 --- > Documentation/doc-gui

Re: [PATCH v2 00/21] Convert USB documentation to ReST format

2017-04-11 Thread Jonathan Corbet
On Tue, 11 Apr 2017 16:58:40 +0200 Greg Kroah-Hartman wrote: > Nope, they don't apply to my tree, it was probably based on yours. And > the first two are ones I shouldn't be taking. > > So, feel free to take all of these with a: > Acked-by: Greg Kroah-Hartman > for the USB-related patche

Re: [PATCH v2 00/21] Convert USB documentation to ReST format

2017-04-08 Thread Jonathan Corbet
On Wed, 5 Apr 2017 10:22:54 -0300 Mauro Carvalho Chehab wrote: > Currently, there are several USB core documents that are at either > written in plain text or in DocBook format. Convert them to ReST > and add to the driver-api book. Greg, do you see any reason not to apply these for 4.12? A fe

Re: [PATCH v2 01/22] tmplcvt: make the tool more robust

2017-04-02 Thread Jonathan Corbet
On Thu, 30 Mar 2017 07:45:35 -0300 Mauro Carvalho Chehab wrote: > Currently, the script just assumes to be called at > Documentation/sphinx/. Change it to work on any directory, > and make it abort if something gets wrong. > > Also, be sure that both parameters are specified. > > That should av

Re: [PATCH 0/9] convert genericirq.tmpl and kernel-api.tmpl to DocBook

2017-04-02 Thread Jonathan Corbet
On Thu, 30 Mar 2017 17:11:27 -0300 Mauro Carvalho Chehab wrote: > This series converts just two documents, adding them to the > core-api.rst book. It addresses the errors/warnings that popup > after the conversion. > > I had to add two fixes to scripts/kernel-doc, in order to solve > some of the

Re: [PATCH 5/9] kernel-api.tmpl: convert it to ReST

2017-03-31 Thread Jonathan Corbet
On Thu, 30 Mar 2017 17:11:32 -0300 Mauro Carvalho Chehab wrote: > Brainless conversion of genericirq.tmpl book to ReST, via > Documentation/sphinx/tmplcvt This one kind of showcases why I'm nervous about bulk conversions. It's a bit of a dumping-ground document, with a bit of everything,

Re: [PATCH 3/9] genericirq.tmpl: convert it to ReST

2017-03-31 Thread Jonathan Corbet
On Thu, 30 Mar 2017 17:11:30 -0300 Mauro Carvalho Chehab wrote: [Reordering things a bit] > +== > +Linux generic IRQ handling > +== > + > +:Copyright: |copy| 2005-2010: Thomas Gleixner > +:Copyright: |copy| 2005-2006: Ingo Molnar It seems maybe t

Re: [PATCH 02/22] docs-rst: convert usb docbooks to ReST

2017-03-31 Thread Jonathan Corbet
On Thu, 30 Mar 2017 11:20:14 +0200 Markus Heiser wrote: > @Jon: what do you think about a bulk conversion? I'm a bit leery of it, to tell the truth. We're trying to create a better set of kernel docs, and I'm far from convinced that dumping a bunch of unloved stuff there in a mechanical way wil

Re: [PATCH] docs-rst: Don't use explicit Makefile rules to build SVG and DOT files

2017-03-13 Thread Jonathan Corbet
On Thu, 9 Mar 2017 15:14:52 -0300 Mauro Carvalho Chehab wrote: > Now that we have an extension to handle images, use it. Applied, finally - thanks. jon

Re: [PATCH] doc-rst: fixed cleandoc target when used with O=dir

2017-02-01 Thread Jonathan Corbet
On Tue, 31 Jan 2017 10:57:41 +0100 Markus Heiser wrote: > The cleandocs target won't work if I use a different output folder:: > > $ make O=/tmp/kernel SPHINXDIRS="process" cleandocs > make[1]: Entering directory '/tmp/kernel' > make[3]: *** No rule to make target 'clean'. Stop. > ... D

Re: [PATCH] Doc: Correct typo, "Introdution" => "Introduction"

2016-12-01 Thread Jonathan Corbet
On Thu, 1 Dec 2016 23:36:00 +0800 Sanjeev wrote: > This corrects a set of spelling mistakes, probably from an > automated conversion. That does indeed seem worth fixing. Applied to the docs tree, thanks. jon -- To unsubscribe from this list: send the line "unsubscribe linux-media" in the body

Re: [Ksummit-discuss] Including images on Sphinx documents

2016-11-19 Thread Jonathan Corbet
On Thu, 17 Nov 2016 08:02:50 -0800 Linus Torvalds wrote: > We have makefiles, but more importantly, few enough people actually > *generate* the documentation, that I think if it's an option to just > fix sphinx, we should do that instead. If it means that you have to > have some development versi

Re: Including images on Sphinx documents

2016-11-13 Thread Jonathan Corbet
On Mon, 7 Nov 2016 09:46:48 -0200 Mauro Carvalho Chehab wrote: > When running LaTeX in interactive mode, building just the media > PDF file with: > > $ cls;make cleandocs; make SPHINXOPTS="-j5" DOCBOOKS="" > SPHINXDIRS=media latexdocs > $ PDFLATEX=xelatex LATEXOPTS="-interaction=in

Re: Including images on Sphinx documents

2016-11-13 Thread Jonathan Corbet
On Mon, 7 Nov 2016 07:55:24 -0200 Mauro Carvalho Chehab wrote: > So, we have a few alternatives: > > 1) copy (or symlink) all rst files to Documentation/output (or to the >build dir specified via O= directive) and generate the *.pdf there, >and produce those converted images via Makefile

Re: [PATCH 0/4] reST-directive kernel-cmd / include contentent from scripts

2016-10-22 Thread Jonathan Corbet
On Sat, 22 Oct 2016 08:56:29 -0200 Mauro Carvalho Chehab wrote: > The security implications will be the same if either coded as an > "ioctl()" or as "syscall", the scripts should be audited. Actually, > if we force the need of a "syscall" for every such script, we have > twice the code to audit,

Re: [PATCH 0/4] reST-directive kernel-cmd / include contentent from scripts

2016-10-21 Thread Jonathan Corbet
On Tue, 11 Oct 2016 09:26:48 +0200 Markus Heiser wrote: > If the kernel-cmd directive gets acked, I will add a description to > kernel-documentation.rst and I request Mauro to document the parse-headers.pl > also. > > But, let's hear what Jon says. Sigh. I've been shunting this discussion asid

Re: [PATCH v2 0/3] doc-rst:c-domain: fix some issues in the c-domain

2016-09-20 Thread Jonathan Corbet
On Tue, 20 Sep 2016 20:56:35 +0200 Markus Heiser wrote: > > I submitted one patch fixing it. Not sure if it got merged by Jon > > or not. > > Ups, I might have overseen this patch .. as Jon said, its hard to > follow you ;) > > I tested the above with Jon's docs-next, so it seems your patch i

Re: [PATCH v2 0/3] doc-rst:c-domain: fix some issues in the c-domain

2016-09-16 Thread Jonathan Corbet
On Wed, 7 Sep 2016 09:12:55 +0200 Markus Heiser wrote: > according to your remarks I fixed the first and second patch. The third patch > is > resend unchanged; OK, I've applied the first two, finally. > > Am 06.09.2016 um 14:28 schrieb Jonathan Corbet : > > > >

Re: [PATCH 00/47] Fix most of Sphinx warnings in nitpick mode

2016-09-08 Thread Jonathan Corbet
ch at the parse-headers.pl > script, as, currently, the only user for it is media. I'm also OK if you > prefer > to merge patches 2 and 3 on your tree instead. Go ahead and keep them with the rest. Acked-by: Jonathan Corbet jon -- To unsubscribe from this list: send the line &qu

Re: [PATCH 1/3] doc-rst:c-domain: fix sphinx version incompatibility

2016-09-06 Thread Jonathan Corbet
On Tue, 6 Sep 2016 14:24:11 +0200 Markus Heiser wrote: > Should I send a new patch .. or could you fix it? Please just regenerate the series and I'll apply it. Thanks, jon -- To unsubscribe from this list: send the line "unsubscribe linux-media" in the body of a message to majord...@vger.kerne

Re: [PATCH 3/3] doc-rst:c-domain: function-like macros index entry

2016-09-06 Thread Jonathan Corbet
On Wed, 31 Aug 2016 17:29:32 +0200 Markus Heiser wrote: > For function-like macros, sphinx creates 'FOO (C function)' entries. > With this patch 'FOO (C macro)' are created for function-like macros, > which is the same for object-like macros. As others have pointed out, we generally want to hide

Re: [PATCH 2/3] doc-rst:c-domain: function-like macros arguments

2016-09-06 Thread Jonathan Corbet
So I'm going into total nit-picking territory here, but since I'm looking at it and I think the series needs a respin anyway... On Wed, 31 Aug 2016 17:29:31 +0200 Markus Heiser wrote: > +m = c_funcptr_sig_re.match(sig) > +if m is None: > +m = c_sig_re.match(sig) > +

Re: [PATCH 1/3] doc-rst:c-domain: fix sphinx version incompatibility

2016-09-06 Thread Jonathan Corbet
On Wed, 31 Aug 2016 17:29:30 +0200 Markus Heiser wrote: > +if major >= 1 and minor < 4: > +# indexnode's tuple changed in 1.4 > +# > https://github.com/sphinx-doc/sphinx/commit/e6a5a3a92e938fcd75866b4227db9e0524d58f7c > +self.indexnode[

Re: [PATCH 0/3] doc-rst: generic way to build PDF of sub-folder

2016-09-01 Thread Jonathan Corbet
On Thu, 1 Sep 2016 08:53:34 -0600 Jonathan Corbet wrote: > > here is a small patch series which extends the method to build only > > sub-folders > > to the targets "latexdocs" and "pdfdocs". > > Well this doesn't seem to break anything, so I

Re: [PATCH 0/3] doc-rst: generic way to build PDF of sub-folder

2016-09-01 Thread Jonathan Corbet
On Wed, 24 Aug 2016 17:36:13 +0200 Markus Heiser wrote: > here is a small patch series which extends the method to build only > sub-folders > to the targets "latexdocs" and "pdfdocs". Well this doesn't seem to break anything, so I went ahead and applied it :) Thanks, jon -- To unsubscribe fro

Re: [PATCH] doc-rst:sphinx-extensions: add metadata parallel-safe

2016-09-01 Thread Jonathan Corbet
On Wed, 24 Aug 2016 15:35:24 +0200 Markus Heiser wrote: > With metadata "parallel_read_safe = True" a extension is marked as > save for "parallel reading of source". This is needed if you want > build in parallel with N processes. E.g.: > > make SPHINXOPTS=-j4 htmldocs A definite improvement;

Re: [PATCH 0/3] Fix kernel-doc parser for typedef functions

2016-09-01 Thread Jonathan Corbet
On Tue, 30 Aug 2016 20:20:56 -0300 Mauro Carvalho Chehab wrote: > The other two patches better fit on your tree, IMHO. > > Mauro Carvalho Chehab (3): > docs-rst: improve typedef parser > docs-rst: kernel-doc: fix typedef output in RST format I've just applied them, thanks. jon -- To unsubs

Re: [PATCH v2] docs-rst: kernel-doc: better output struct members

2016-08-24 Thread Jonathan Corbet
On Mon, 22 Aug 2016 22:02:57 -0300 Mauro Carvalho Chehab wrote: > So, change kernel-doc, for it to produce the output on a different way: > > **Members** > > ``prios[4]`` > > array with elements to store the array priorities > > Also, as the type is not part of LaTeX "item

Re: [PATCH v2 2/2] Documentation/sphinx: link dma-buf rsts

2016-08-23 Thread Jonathan Corbet
On Tue, 23 Aug 2016 15:28:55 +0200 Daniel Vetter wrote: > I think the more interesting story is, what's your plan with all the > other driver related subsystem? Especially the ones which already have > full directories of their own, like e.g. Documentation/gpio/. I think > those should be really

Re: [PATCH v2 2/2] Documentation/sphinx: link dma-buf rsts

2016-08-23 Thread Jonathan Corbet
On Tue, 23 Aug 2016 08:01:35 +0200 Daniel Vetter wrote: > I'm also not too sure about whether dma-buf really should be it's own > subdirectory. It's plucked from the device-drivers.tmpl, I think an > overall device-drivers/ for all the misc subsystems and support code would > be better. Then one

Re: [PATCH] docs-rst: kernel-doc: better output struct members

2016-08-22 Thread Jonathan Corbet
On Sun, 21 Aug 2016 09:11:57 -0300 Mauro Carvalho Chehab wrote: > So, change kernel-doc, for it to produce the output on a different way: > > **Members** > > ``prios[4]`` > - **type**: ``atomic_t`` > > array with elements to store the array priorities > > With such

Re: [PATCH] docs-rst: conf.py: adjust the size of .. note:: tag

2016-08-22 Thread Jonathan Corbet
On Fri, 19 Aug 2016 09:49:38 -0300 Mauro Carvalho Chehab wrote: > While the current implementation works well when using as a > paragraph, it doesn't work properly if inside a table. As we > have quite a few such cases, fix the logic to take the column > size into account. Applied to the docs tr

Re: [PATCH] docs-rst: add support for LaTeX output

2016-08-22 Thread Jonathan Corbet
On Thu, 18 Aug 2016 11:53:39 -0300 Mauro Carvalho Chehab wrote: > Sphinx supports LaTeX output. Sometimes, it is interesting to > call it directly, instead of also generating a PDF. As it comes > for free, add a target for it. > Applied to the docs tree, thanks. jon -- To unsubscribe from this

Re: [RFC PATCH 0/5] doc-rst: improvements Sphinx's C-domain

2016-08-22 Thread Jonathan Corbet
On Mon, 15 Aug 2016 16:08:23 +0200 Markus Heiser wrote: > this is my approach to eliminate some distortions we have with the c/cpp > Sphinx > domains. The C domain is simple: it assumes that all functions, enums, etc > are global, e. g. there should be just one function called "ioctl", or "open"

Re: [PATCH 1/7] doc-rst: generic way to build only sphinx sub-folders

2016-08-18 Thread Jonathan Corbet
On Sat, 13 Aug 2016 16:12:42 +0200 Markus Heiser wrote: > Add a generic way to build only a reST sub-folder with or > without a individual *build-theme*. > > * control *sub-folders* by environment SPHINXDIRS > * control *build-theme* by environment SPHINX_CONF > > Folders with a conf.py file, m

Re: [PATCH 0/9] Prepare Sphinx to build media PDF books

2016-08-18 Thread Jonathan Corbet
On Tue, 16 Aug 2016 13:25:34 -0300 Mauro Carvalho Chehab wrote: > I think this patch series belong to docs-next. Feel free to merge them there, > if > you agree. There's one extra patch that touches Documentation/conf.py, > re-adding the media book to the PDF build, but IMHO this one would be be

Re: [RFC PATCH 0/5] doc-rst: improvements Sphinx's C-domain

2016-08-18 Thread Jonathan Corbet
On Mon, 15 Aug 2016 16:08:23 +0200 Markus Heiser wrote: > this is my approach to eliminate some distortions we have with the c/cpp > Sphinx > domains. The C domain is simple: it assumes that all functions, enums, etc > are global, e. g. there should be just one function called "ioctl", or "open"

Re: [PATCH 0/7] doc-rst: sphinx sub-folders & parseheaders directive

2016-08-15 Thread Jonathan Corbet
On Mon, 15 Aug 2016 10:21:07 +0200 Markus Heiser wrote: > Jonathan, we had this already, I gave you the links to "python community > norms" and tools, please read/use them. > > * https://www.python.org/dev/peps/pep-0008/ > * https://www.pylint.org/ > > Some of these norms might be unusual for C

Re: [PATCH] doc-rst: customize RTD theme, drop padding of inline literal

2016-08-14 Thread Jonathan Corbet
On Fri, 5 Aug 2016 11:27:07 +0200 Hans Verkuil wrote: > On 08/05/2016 11:19 AM, Markus Heiser wrote: > > From: Markus Heiser > > > > Remove the distracting (left/right) padding of inline literals. (HTML > > ). Requested and discussed in [1]. > > > > [1] http://www.spinics.net/lists/linux-media

Re: [PATCH 0/7] doc-rst: sphinx sub-folders & parseheaders directive

2016-08-14 Thread Jonathan Corbet
On Sat, 13 Aug 2016 16:12:41 +0200 Markus Heiser wrote: > this series is a consolidation on Jon's docs-next branch. It merges the > "sphinx > sub-folders" patch [1] and the "parseheaders directive" patch [2] on top of > Jon's docs-next. > > In sense of consolidation, it also includes: > > * d

Re: [PATCH 1/3] doc-rst: generic way to build only sphinx sub-folders

2016-08-12 Thread Jonathan Corbet
On Mon, 8 Aug 2016 15:14:58 +0200 Markus Heiser wrote: > Remove the 'DOC_NITPIC_TARGETS' from main $(srctree)/Makefile and add a > more generic way to build only a reST sub-folder. > > * control *sub-folders* by environment SPHINXDIRS > * control *build-theme* by environment SPHINX_CONF > > Fo

Re: [RFC 0/4] doc: dma-buf: sphinx conversion and cleanup

2016-08-11 Thread Jonathan Corbet
On Thu, 11 Aug 2016 16:17:56 +0530 Sumit Semwal wrote: > Convert dma-buf documentation over to sphinx; also cleanup to > address sphinx warnings. > > While at that, convert dma-buf-sharing.txt as well, and make it the > dma-buf API guide. Thanks for working to improve the documentation! I do h

Re: parts of media docs sphinx re-building every time?

2016-08-10 Thread Jonathan Corbet
On Wed, 10 Aug 2016 12:23:16 +0300 Jani Nikula wrote: > >> I just noticed running 'make htmldocs' rebuilds parts of media docs > >> every time on repeated runs. This shouldn't happen. Please investigate. > > > > I was unable to reproduce it here. Are you passing any special options > > to the b

Re: [PATCH 0/3] doc-rst: more generic way to build only sphinx sub-folders

2016-08-09 Thread Jonathan Corbet
On Mon, 8 Aug 2016 15:14:57 +0200 Markus Heiser wrote: > this is my approach for a more generic way to build only sphinx sub-folders, > we > discussed in [1]. The last patch adds a minimal conf.py to the gpu folder, if > you don't want to patch the gpu folder drop it. I haven't had a chance to

Re: [PATCH] DocBook: use DOCBOOKS="" to ignore DocBooks instead of IGNORE_DOCBOOKS=1

2016-08-04 Thread Jonathan Corbet
On Thu, 4 Aug 2016 11:48:26 +0300 Jani Nikula wrote: > Instead of a separate ignore flag, use the obvious DOCBOOKS="" to ignore > all DocBook files. Makes sense, applied. Thanks, jon -- To unsubscribe from this list: send the line "unsubscribe linux-media" in the body of a message to majord..

Re: [PATCH] doc-rst: Remove the media docbook

2016-08-01 Thread Jonathan Corbet
On Mon, 1 Aug 2016 08:19:14 -0300 Mauro Carvalho Chehab wrote: > My general impression is that it is now a way easier to maintain the > media documentation and make it more consistent than with DocBook. Music to my ears - maybe this whole thing was worth it :) Seriously, though, this whole thi

Re: [PATCH] doc-rst: Remove the media docbook

2016-07-27 Thread Jonathan Corbet
On Wed, 27 Jul 2016 06:32:31 -0300 Mauro Carvalho Chehab wrote: > This patch should be applied after Linus handle my media documentation > pull request. Do you prefer to send the patch yourself, or if I do it? If you want it to go up for 4.8, just go ahead and send it in, no need for a middleman

Re: [PATCH] doc-rst: kernel-doc: fix handling of address_space tags

2016-07-22 Thread Jonathan Corbet
On Fri, 22 Jul 2016 11:46:36 -0300 Mauro Carvalho Chehab wrote: > The RST cpp:function handler is very pedantic: it doesn't allow any > macros like __user on it: > [...] > So, we have to remove it from the function prototype. Sigh, this is the kind of thing where somehow there's always more mole

Re: [PATCH 00/18] Complete moving media documentation to ReST format

2016-07-21 Thread Jonathan Corbet
On Thu, 21 Jul 2016 16:41:53 +0200 Markus Heiser wrote: > Am 21.07.2016 um 01:28 schrieb Jonathan Corbet : > > > I would hope that most people wouldn't have to worry about it, and would > > be able to just use what their distribution provides - that's the reason &

Re: [PATCH 00/18] Complete moving media documentation to ReST format

2016-07-20 Thread Jonathan Corbet
On Wed, 20 Jul 2016 08:07:54 +0200 Markus Heiser wrote: > Jon, what do you think ... could we serve this 1.2 doc > on https://www.kernel.org/doc/ as reference? Seems like a good idea. I don't really know who controls that directory, though; I can ping Konstantin and see what can be done there.

Re: [PATCH] doc-rst: get rid of warnings at kernel-documentation.rst

2016-07-20 Thread Jonathan Corbet
On Wed, 20 Jul 2016 11:41:11 -0300 Mauro Carvalho Chehab wrote: > > The thing with that is that a lot of literal blocks *do* have C code, even > > in kernel-documentation.rst. Setting that in conf.py would turn off all C > > highlighting. I think that might actually be a desirable outcome, but

Re: [PATCH] doc-rst: get rid of warnings at kernel-documentation.rst

2016-07-20 Thread Jonathan Corbet
On Wed, 20 Jul 2016 16:23:28 +0200 Markus Heiser wrote: > Am 20.07.2016 um 16:11 schrieb Mauro Carvalho Chehab > : > > > Sphinx 1.4.5 complains about some literal blocks at > > kernel-documentation.rst: > > > > Documentation/kernel-documentation.rst:373: WARNING: Could not lex > > literal

Re: Troubles with kernel-doc and RST files

2016-07-19 Thread Jonathan Corbet
On Sun, 17 Jul 2016 10:01:54 -0300 Mauro Carvalho Chehab wrote: > 4) There are now several errors when parsing functions. Those seems to > happen when an argument is a function pointer, like: > > /devel/v4l/patchwork/Documentation/media/kapi/v4l2-core.rst:757: WARNING: > Error when parsing func

Re: Troubles with kernel-doc and RST files

2016-07-19 Thread Jonathan Corbet
On Sun, 17 Jul 2016 10:01:54 -0300 Mauro Carvalho Chehab wrote: > 3) When there's an asterisk inside the source code, for example, to > document a pointer, or when something else fails when parsing a > header file, kernel-doc handler just outputs: > /devel/v4l/patchwork/Documentation/media/

Re: Troubles with kernel-doc and RST files

2016-07-19 Thread Jonathan Corbet
On Sun, 17 Jul 2016 10:01:54 -0300 Mauro Carvalho Chehab wrote: > 2) For functions, kernel-doc is now an all or nothing. If not all > functions are declared, it outputs this warning: > > ./include/media/media-devnode.h:1: warning: no structured comments > > And give up. No functions are e

Re: Troubles with kernel-doc and RST files

2016-07-19 Thread Jonathan Corbet
On Tue, 19 Jul 2016 12:00:24 +0200 Markus Heiser wrote: > I recommend to consider to switch to the python version of the parser. > I know, that there is a natural shyness about a reimplementation in python > and thats why I offer to support it for a long time period .. it would > be a joy for me

Re: [PATCH 00/18] Complete moving media documentation to ReST format

2016-07-19 Thread Jonathan Corbet
On Tue, 19 Jul 2016 11:53:19 -0300 Mauro Carvalho Chehab wrote: > So, I guess we should set the minimal requirement to 1.2.x. *sigh*. I hate to do that; things are happening quickly enough with Sphinx that it would be nice to be able to count on a newer version. That said, one of my goals in t

Re: Troubles with kernel-doc and RST files

2016-07-17 Thread Jonathan Corbet
[Back home and trying to get going on stuff for real. I'll look at the issues listed in this message one at a time.] On Sun, 17 Jul 2016 10:01:54 -0300 Mauro Carvalho Chehab wrote: > 1) We now need to include each header file with documentation twice, > one to get the enums, structs, typedefs,

Re: [PATCH v2] doc-rst: add an option to ignore DocBooks when generating docs

2016-07-09 Thread Jonathan Corbet
On Sat, 9 Jul 2016 13:12:45 -0300 Mauro Carvalho Chehab wrote: > Sometimes, we want to do a partial build, instead of building > everything. However, right now, if one wants to build just > Sphinx books, it will build also the DocBooks. > > Add an option to allow to ignore all DocBooks when bui

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

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

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

Re: Kernel docs: muddying the waters a bit

2016-03-06 Thread Jonathan Corbet
On Thu, 03 Mar 2016 16:03:14 +0200 Jani Nikula wrote: > This stalled a bit, but the waters are still muddy... So I've been messing with this a bit; wanted to do a proper patch posting but I'm fried and mostly out of time for the moment. The results I'm getting now can be seen at: http:

Re: Kernel docs: muddying the waters a bit

2016-03-03 Thread Jonathan Corbet
On Thu, 3 Mar 2016 14:34:25 + One Thousand Gnomes wrote: > We only have docbook because it was the tool of choice rather a lot of > years ago to then get useful output formats. It was just inherited when > borrowed the original scripts from Gnome/Gtk. It's still the most > effective way IMHO

Re: Kernel docs: muddying the waters a bit

2016-03-03 Thread Jonathan Corbet
On Thu, 03 Mar 2016 16:03:14 +0200 Jani Nikula wrote: > This stalled a bit, but the waters are still muddy... I've been dealing with real-world obnoxiousness, something which won't come to an immediate end, unfortunately. But I have been taking some time to mess with things, and hope to have so

Re: [PATCH v2 2/4] scripts/kernel-doc: Replacing highlights hash by an array

2015-11-17 Thread Jonathan Corbet
On Tue, 17 Nov 2015 13:29:49 -0200 Mauro Carvalho Chehab wrote: > The enclosed patch should do the trick. I tested it with perl 5.10 and > perl 5.22 it worked fine with both versions. Indeed it seems to work - thanks! Applied to the docs tree, I'll get it upstream before too long. jon -- To u

Re: [PATCH v2 2/4] scripts/kernel-doc: Replacing highlights hash by an array

2015-11-17 Thread Jonathan Corbet
On Tue, 17 Nov 2015 08:40:46 -0200 Mauro Carvalho Chehab wrote: > The above causes some versions of perl to fail, as keys expect a > hash argument: > > Execution of .//scripts/kernel-doc aborted due to compilation errors. > Type of arg 1 to keys must be hash (not private array) at > .//scripts/

Re: [RFC] Documentation: dontdiff: remove media from dontdiff

2015-11-11 Thread Jonathan Corbet
On Fri, 30 Oct 2015 01:15:39 +0800 Wang YanQing wrote: > media will hide all the changes in drivers/media. > > Signed-off-by: Wang YanQing > --- > I don't know whether it is still acceptable to patch dontdiff, > so I add Linus to CC list. As long as the file is there, its contents should mak

Re: How to fix DocBook parsers for private fields inside #ifdefs

2015-10-11 Thread Jonathan Corbet
On Mon, 5 Oct 2015 09:03:48 -0300 Mauro Carvalho Chehab wrote: > Patch enclosed. ...and applied, thanks! jon -- To unsubscribe from this list: send the line "unsubscribe linux-media" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-i

Re: How to fix DocBook parsers for private fields inside #ifdefs

2015-10-05 Thread Jonathan Corbet
On Thu, 1 Oct 2015 14:21:07 -0300 Mauro Carvalho Chehab wrote: > They're all after a private comment: > /* Private: internal use only */ > > So, according with Documentation/kernel-doc-nano-HOWTO.txt, they shold > have been ignored. > > Still, the scripts produce warnings for them: Sorry

Re: [PATCH 00/39] Document the kABI for the media subsystem

2015-08-23 Thread Jonathan Corbet
On Sat, 22 Aug 2015 14:27:45 -0300 Mauro Carvalho Chehab wrote: > Jon, > > As most of the changes here are inside the media drivers, I > prefer to merge this series via my tree, if this is ok for > you. That's fine, feel free to stick my ack in if you want. Hopefully we'll not run into conflic

Re: [PATCH] [media] DocBook: Fix typo in intro.xml

2015-07-24 Thread Jonathan Corbet
On Fri, 24 Jul 2015 10:33:51 +0200 Hans Verkuil wrote: > Jon, would you mind if I take this patch and let it go through the media > tree? I'd like to apply a patch on top of this one that removes the mention of > devfs. Fine, I'll drop it. > It makes more sense in general to take patches to Doc

Re: [PATCH] [media] DocBook: Fix typo in intro.xml

2015-07-14 Thread Jonathan Corbet
On Tue, 14 Jul 2015 08:36:50 +0900 Masanari Iida wrote: > This patch fix spelling typos in intro.xml. > This xml file is not created from comments within source, > I fix the xml file. Applied to the docs tree, thanks. jon -- To unsubscribe from this list: send the line "unsubscribe linux-media"

Re: [PATCH] Doc: pps: Fix file name in pps.txt

2015-07-14 Thread Jonathan Corbet
On Mon, 13 Jul 2015 12:29:11 +0900 Masanari Iida wrote: > This patch fix a file name of example code. Applied to the docs tree, thanks. jon -- To unsubscribe from this list: send the line "unsubscribe linux-media" in the body of a message to majord...@vger.kernel.org More majordomo info at htt

Re: [PATCH] Doc: pps: Fix file name in pps.txt

2015-07-13 Thread Jonathan Corbet
On Mon, 13 Jul 2015 08:23:15 +0200 Rodolfo Giometti wrote: > On Mon, Jul 13, 2015 at 12:29:11PM +0900, Masanari Iida wrote: > > This patch fix a file name of example code. > > > > Signed-off-by: Masanari Iida > > Signed-off-by: Rodolfo Giometti Why Signed-off-by? Did you maybe mean Acked-

Re: [PATCH] Doc:nfc: Fix typo in nfc-hci.txt

2015-06-05 Thread Jonathan Corbet
On Fri, 5 Jun 2015 21:38:19 +0900 Masanari Iida wrote: > This patch fix a spelling typo in nfc-hci.txt Applied to the docs tree, thanks. jon -- To unsubscribe from this list: send the line "unsubscribe linux-media" in the body of a message to majord...@vger.kernel.org More majordomo info at h

Re: [PATCH 00/35] Improve DVB frontend API documentation

2015-06-02 Thread Jonathan Corbet
On Tue, 2 Jun 2015 06:26:13 -0300 Mauro Carvalho Chehab wrote: > I prefer to send it via my tree, if you don't mind. That's fine. jon -- To unsubscribe from this list: send the line "unsubscribe linux-media" in the body of a message to majord...@vger.kernel.org More majordomo info at http://v

Re: [PATCH 00/35] Improve DVB frontend API documentation

2015-06-01 Thread Jonathan Corbet
On Thu, 28 May 2015 18:49:03 -0300 Mauro Carvalho Chehab wrote: > This is the first series of patches that will improve the DVB > documentation. I've done a *quick* pass over these and sent a few comments, but they are all on the trivial-detail side of things. Looks good in general. Would you

Re: [PATCH 32/35] DocBook: Provide a high-level description for DVB frontend

2015-06-01 Thread Jonathan Corbet
On Thu, 28 May 2015 18:49:35 -0300 Mauro Carvalho Chehab wrote: > +Please notice that several statistics require the demodulator to be fully > +locked (e. g. with FE_HAS_LOCK bit set). See s/notice/note/ jon -- To unsubscribe from this list: send the line "unsubscribe linux-media" in th

Re: [PATCH 15/35] DocBook: Improve the description of the properties API

2015-06-01 Thread Jonathan Corbet
A few minor corrections here. jon On Thu, 28 May 2015 18:49:18 -0300 Mauro Carvalho Chehab wrote: > Make the text clearer about what the properties API does. > > Signed-off-by: Mauro Carvalho Chehab > > diff --git a/Documentation/DocBook/media/dvb/dvbproperty.xml > b/Documentation/DocBook/m

Re: [PATCH 04/35] DocBook: fix emphasis at the DVB documentation

2015-06-01 Thread Jonathan Corbet
On Thu, 28 May 2015 18:49:07 -0300 Mauro Carvalho Chehab wrote: > Currently, it is using 'role="tt"', but this is not defined at > the DocBook 4.5 spec. The net result is that no emphasis happens. > > So, replace them to bold emphasis. Nit: I suspect the intent of the "emphasis" here was to get

Re: [PATCH 02/35] DocBook: add a note about the ALSA API

2015-06-01 Thread Jonathan Corbet
On Thu, 28 May 2015 18:49:05 -0300 Mauro Carvalho Chehab wrote: > + It should also be noticed that a media device may also have audio > + components, like mixers, PCM capture, PCM playback, etc, with > + are controlled via ALSA API. How about s/noticed/noted/ and s/with/w

Re: [PATCH 08/27] ov7670: check read error also for REG_AECHH on ov7670_s_exp()

2015-04-30 Thread Jonathan Corbet
he read operation should succeed. > > So, fix the code to also check if this succeeded. > > This fixes this smatch report: > drivers/media/i2c/ov7670.c:1366 ov7670_s_exp() warn: inconsistent > indenting That's why I like programming in Python...:) Silly mistake, go

Re: [PATCH] marvell-ccic: fix RGB444 format

2015-04-24 Thread Jonathan Corbet
s > sense in this case. > > Since the RGB444 pixel format is deprecated due to the ambiguous specification > of the alpha component we use the XRGB444 pixel format instead (specified as > having > no alpha channel). Seems good to me. Acked-by: Jonathan Corbet jon -- To unsubs

  1   2   3   4   >