Re: [Mesa-dev] [PATCH v3 3/4] drm/i915/uapi: convert i915_query and friend to kernel doc

2021-04-16 Thread Jonathan Corbet
Daniel Vetter writes: > On Fri, Apr 16, 2021 at 12:25 AM Ian Romanick wrote: >> Since we just had a big discussion about this on mesa-dev w.r.t. Mesa >> code and documentation... does the kernel have a policy about which >> flavor (pun intended) of English should be used? > > I'm not finding it

Re: [PATCH v6 00/16] Fix several bad kernel-doc markups

2021-01-21 Thread Jonathan Corbet
On Thu, 14 Jan 2021 09:04:36 +0100 Mauro Carvalho Chehab wrote: > 1) 10 remaining fixup patches from the series I sent back on Dec, 1st: > >parport: fix a kernel-doc markup >rapidio: fix kernel-doc a markup >fs: fix kernel-doc markups >pstore/zone: fix a kernel-doc markup >f

Re: [PATCH] doc: use KCFLAGS instead of EXTRA_CFLAGS to pass flags from command line

2021-02-22 Thread Jonathan Corbet
Masahiro Yamada writes: > You should use KCFLAGS to pass additional compiler flags from the > command line. Using EXTRA_CFLAGS is wrong. > > EXTRA_CFLAGS is supposed to specify flags applied only to the current > Makefile (and now deprecated in favor of ccflags-y). > > It is still used in arch/mi

Re: [PATCH 00/10] Documentation build warning fixes

2021-05-20 Thread Jonathan Corbet
Mauro Carvalho Chehab writes: > Hi Jon, > > This small series contain a series of fixes for the documentation. it is > against your docs-next branch. > > Three of the patches fix duplicated symbols at the ABI documents. > There are still some ABI warnings from IIO, but all but one were > already

[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

rst htmldocs on kernel.org

2016-08-15 Thread Jonathan Corbet
On Thu, 11 Aug 2016 21:13:29 +0200 Lukas Wunner wrote: > not sure if this is already on your radar or if you're at all the > right person to contact, but I just noticed that the gpu htmldocs > are gone from https://www.kernel.org/doc/htmldocs/gpu/ > > Actually all the rst-formatted docs are miss

linux-next: manual merge of the jc_docs tree with the drm-misc tree

2016-08-19 Thread Jonathan Corbet
On Fri, 19 Aug 2016 11:52:15 +1000 Stephen Rothwell wrote: > Today's linux-next merge of the jc_docs tree got a conflict in: > > Documentation/gpu/index.rst > > between commit: > > b754b35b089d ("vgaarbiter: rst-ifiy and polish kerneldoc") > > from the drm-misc tree and commit: > > 505

[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 v3 15/18] Documentation: kunit: add documentation for KUnit

2019-05-14 Thread Jonathan Corbet
On Mon, 13 May 2019 22:42:49 -0700 Brendan Higgins wrote: > Add documentation for KUnit, the Linux kernel unit testing framework. > - Add intro and usage guide for KUnit > - Add API reference > > Signed-off-by: Felix Guo > Signed-off-by: Brendan Higgins > Reviewed-by: Greg Kroah-Hartman > Rev

Re: [PATCH v3 15/18] Documentation: kunit: add documentation for KUnit

2019-05-14 Thread Jonathan Corbet
On Tue, 14 May 2019 11:08:10 -0700 Brendan Higgins wrote: > > Naturally, though, I have one request: I'd rather not see this at the top > > level, which is more than crowded enough as it is. Can this material > > please go into the development tools book, alongside the kselftest > > documentatio

Re: [PATCH v3 15/18] Documentation: kunit: add documentation for KUnit

2019-05-15 Thread Jonathan Corbet
On Tue, 14 May 2019 16:19:02 -0700 Brendan Higgins wrote: > Hmmm...probably premature to bring this up, but Documentation/dev-tools/ > is kind of thrown together. Wait a minute, man... *I* created that directory, are you impugning my work? :) But yes, "kind of thrown together" is a good descrip

[PATCH] drm/i915: Maintain consistent documentation subsection ordering

2019-05-23 Thread Jonathan Corbet
included in the heading hierarchy, but I don't see a better way around it). Signed-off-by: Jonathan Corbet --- [If I can possibly get an ack for this, I would like to send it up soon with the other Sphinx-related fixes.] drivers/gpu/drm/i915/i915_reg.h | 6 +++--- drivers/gpu/

Re: Avoiding merge conflicts while adding new docs - Was: Re: [PATCH 00/57] Convert files to ReST

2019-04-19 Thread Jonathan Corbet
On Thu, 18 Apr 2019 09:42:23 -0300 Mauro Carvalho Chehab wrote: > After thinking a little bit and doing some tests, I think a good solution > would be to add ":orphan:" markup to the new .rst files that were not > added yet into the main body (e. g. something like the enclosed example). Interest

Re: [PATCH v2 56/79] docs: Documentation/*.txt: rename all ReST files to *.rst

2019-04-24 Thread Jonathan Corbet
On Tue, 23 Apr 2019 15:01:32 +0200 Peter Zijlstra wrote: > But yes, I have 0 motivation to learn or abide by rst. It simply doesn't > give me anything in return. There is no upside, only worse text files :/ So I believe it gives even you one thing in return: documentation that is more accessible

Re: [PATCH v2 56/79] docs: Documentation/*.txt: rename all ReST files to *.rst

2019-04-24 Thread Jonathan Corbet
On Tue, 23 Apr 2019 19:11:58 +0200 Peter Zijlstra wrote: > When writing, I now have to be bothered about this format crap over just > trying to write a coherent document. Just write text, it'll all work out in the end :) > Look at crap like this: > > "The memory allocations via :c:func:`kmallo

Re: [PATCH v2 56/79] docs: Documentation/*.txt: rename all ReST files to *.rst

2019-04-24 Thread Jonathan Corbet
On Tue, 23 Apr 2019 17:19:44 -0300 Mauro Carvalho Chehab wrote: > Anyway, one of the things that occurred to me is that maybe > some scripting work or a ReST extension could do something to parse > "Documentation/foo" as :doc:`Documentation/foo` without needing to > explicitly use any ReST speci

Re: [PATCH v2 56/79] docs: Documentation/*.txt: rename all ReST files to *.rst

2019-04-24 Thread Jonathan Corbet
On Tue, 23 Apr 2019 23:38:16 +0200 Borislav Petkov wrote: > But exactly this - *having* to do rst formatting would mean a lot of > getting used to and people writing something which is not necessarily > correct rst and someone else fixing up after them. Remember that most of our docs are 99% RST

[PATCH] dma-buf: Fix kerneldoc comment for struct dma_fence_array

2019-01-16 Thread Jonathan Corbet
n and make the warning go away. Signed-off-by: Jonathan Corbet --- Hopefully I've sent this to the right place; perhaps this file needs to be added to the MAINTAINERS entry? include/linux/dma-fence-array.h | 1 + 1 file changed, 1 insertion(+) diff --git a/include/linux/dma-fence-array.

Re: [PATCH v3 33/33] docs: EDID/HOWTO.txt: convert it and rename to howto.rst

2019-06-11 Thread Jonathan Corbet
On Tue, 11 Jun 2019 06:02:15 -0300 Mauro Carvalho Chehab wrote: > Jon, please correct me if I' wrong, bu I guess the plan is to place them > somewhere under Documentation/admin-guide/. That makes sense to me. > If so, perhaps creating a Documentation/admin-guide/drm dir there and > place docs

Re: [PATCH v5] docs: power: convert docs to ReST and rename to *.rst

2019-06-14 Thread Jonathan Corbet
On Thu, 13 Jun 2019 07:10:36 -0300 Mauro Carvalho Chehab wrote: > Convert the PM documents to ReST, in order to allow them to > build with Sphinx. > > The conversion is actually: > - add blank lines and identation in order to identify paragraphs; > - fix tables markups; > - add some lists

Re: [PATCH v4 14/28] docs: locking: convert docs to ReST and rename to *.rst

2019-06-14 Thread Jonathan Corbet
On Wed, 12 Jun 2019 14:52:50 -0300 Mauro Carvalho Chehab wrote: > Convert the locking documents to ReST and add them to the > kernel development book where it belongs. > > Most of the stuff here is just to make Sphinx to properly > parse the text file, as they're already in good shape, > not req

Re: [PATCH v1 12/22] docs: driver-api: add .rst files from the main dir

2019-06-19 Thread Jonathan Corbet
On Wed, 19 Jun 2019 12:42:39 +0200 Peter Zijlstra wrote: > No, the other way around, Sphinx can recognize local files and treat > them special. That way we keep the text readable. > > Same with that :c:func:'foo' crap, that needs to die, and Sphinx needs > to be taught about foo(). I did a patc

Re: [PATCH] docs: fix some broken references due to txt->rst renames

2019-06-20 Thread Jonathan Corbet
On Tue, 18 Jun 2019 10:33:58 -0300 Mauro Carvalho Chehab wrote: > here are three left-overs from the recent file renames, > probably due to some other conflicting patch. > > Fix them. > > Signed-off-by: Mauro Carvalho Chehab > --- > > This patch is against today's next-20190617 branch. Not su

Re: [PATCH] drm: fix a reference for a renamed file: fb/modedb.rst

2019-06-27 Thread Jonathan Corbet
On Wed, 26 Jun 2019 23:27:35 +0200 Daniel Vetter wrote: > On Wed, Jun 26, 2019 at 01:14:13PM -0300, Mauro Carvalho Chehab wrote: > > Due to two patches being applied about the same time, the > > reference for modedb.rst file got wrong: > > > > Documentation/fb/modedb.txt is now Documentation

Re: [PATCH] drm/doc: Custom Kconfig for KUnit is no longer needed

2022-09-06 Thread Jonathan Corbet
Michał Winiarski writes: > On Tue, Sep 06, 2022 at 08:37:00AM +0700, Bagas Sanjaya wrote: >> On 9/6/22 01:47, Michał Winiarski wrote: >> > References: commit 6fc3a8636a7b ("kunit: tool: Enable virtio/PCI by >> > default on UML") >> >> Use Fixes: tag for bugfix patches instead. > > Can documenta

Re: [PATCH v2] Documentation: fb: udlfb: clean up text and formatting

2022-09-21 Thread Jonathan Corbet
; Cc: Helge Deller > Cc: Jonathan Corbet > Cc: linux-...@vger.kernel.org > Cc: Bagas Sanjaya > --- > v2: use some text suggestions from Bagas Sanjaya (Thanks); > add a '.' at the end of a sentence. > > Documentation/fb/udlfb.rst | 23 +++ &g

Re: [PATCH v2 5/5] Documentation: driver-api: visconti: add a description of DNN driver.

2022-07-22 Thread Jonathan Corbet
Yuji Ishikawa writes: No changelog? > Signed-off-by: Yuji Ishikawa > --- > v1 -> v2: > - newly added documents > --- > Documentation/driver-api/visconti/common.rst | 115 ++ > Documentation/driver-api/visconti/dnn.rst| 394 +++ > 2 files changed, 509 insertions(+) >

Re: [PATCH v2] kernel-doc: rename the kernel-doc directive 'functions' to 'identifiers'

2019-10-29 Thread Jonathan Corbet
On Tue, 29 Oct 2019 08:31:22 +0800 Changbin Du wrote: > Here python is different from C. Both empty string and None are False in > python. > Note such condition is common in python. Treating both as a False value is reasonably common. Treating them elsewhere in the same code block as separate

Re: [PATCH v9 10/25] mm/gup: introduce pin_user_pages*() and FOLL_PIN

2019-12-11 Thread Jonathan Corbet
On Tue, 10 Dec 2019 18:53:03 -0800 John Hubbard wrote: > Introduce pin_user_pages*() variations of get_user_pages*() calls, > and also pin_longterm_pages*() variations. Just a couple of nits on the documentation patch > +++ b/Documentation/core-api/pin_user_pages.rst > @@ -0,0 +1,232 @@ > +.. S

Re: [PATCH] kernel-doc: rename the kernel-doc directive 'functions' to 'specific'

2019-10-15 Thread Jonathan Corbet
On Sun, 13 Oct 2019 13:53:59 +0800 Changbin Du wrote: > The 'functions' directive is not only for functions, but also works for > structs/unions. So the name is misleading. This patch renames it to > 'specific', so now we have export/internal/specific directives to limit > the functions/types to

Re: [PATCH v2] kernel-doc: rename the kernel-doc directive 'functions' to 'identifiers'

2019-10-24 Thread Jonathan Corbet
On Sun, 20 Oct 2019 21:17:17 +0800 Changbin Du wrote: > The 'functions' directive is not only for functions, but also works for > structs/unions. So the name is misleading. This patch renames it to > 'identifiers', which specific the functions/types to be included in > documentation. We keep the

Re: New sysfs interface for privacy screens

2019-10-02 Thread Jonathan Corbet
On Tue, 1 Oct 2019 10:09:46 -0600 Mat King wrote: > I have been looking into adding Linux support for electronic privacy > screens which is a feature on some new laptops which is built into the > display and allows users to turn it on instead of needing to use a > physical privacy filter. In disc

Re: [PATCH] drm/doc: Drop :c:func: markup

2019-12-10 Thread Jonathan Corbet
On Tue, 10 Dec 2019 11:33:16 +0100 Daniel Vetter wrote: > Jon, any plans to also add the other auto-markup eventually? We have quite > an impressive pile of :c:type: noise in our docs ... It's on the list...but the list is long. As in I'm shopping for a new cloud provider that offers storage op

Re: Best practice for embedded code samles? [Was: drm/drv: Use // for comments in example code]

2019-08-13 Thread Jonathan Corbet
On Sun, 11 Aug 2019 23:32:15 +0200 Sam Ravnborg wrote: > I wonder if there is a better way to embed a code sample > than reverting to // style comments. > > As the kernel do not like // comments we should try to avoid them in > examples. If you're embedding a code sample *into a code comment* t

Re: [PATCH] dma-buf: Add "dma-buf" to title of documentation

2023-01-31 Thread Jonathan Corbet
Jonathan Neuschäfer writes: > To make it easier to find the dma-buf documentation when looking through > tables-of-contents etc., put the name "dma-buf" in the title. > > Signed-off-by: Jonathan Neuschäfer > --- > Documentation/driver-api/dma-buf.rst | 4 ++-- > 1 file changed, 2 insertions(+),

Re: [PATCH v2 0/8] Docs: Add missing SPDX license identifiers of

2023-01-23 Thread Jonathan Corbet
SeongJae Park writes: > Some subsystem documents are missing SPDX license identifiers on index > files. This patchset adds those. Documentation/ is far behind on the SPDX front, and I'm all in favor of fixing that. I do worry, though, about sticking license declarations onto files that did not

Re: [PATCH] docs: accel: Fix debugfs path

2023-01-24 Thread Jonathan Corbet
Jeffrey Hugo writes: > The device specific directory in debugfs does not have "accel". For > example, the documentation says device 0 should have a debugfs entry as > /sys/kernel/debug/accel/accel0/ but in reality the entry is > /sys/kernel/debug/accel/0/ > > Fix the documentation to match the i

Re: [PATCH v2 1/1] Docs/subsystem-apis: Remove '[The ]Linux' prefixes from titles of listed documents

2023-01-24 Thread Jonathan Corbet
SeongJae Park writes: > Some documents that listed on subsystem-apis have 'Linux' or 'The Linux' > title prefixes. It's duplicated information, and makes finding the > document of interest with human eyes not easy. Remove the prefixes from > the titles. > > Signed-off-by: SeongJae Park > --- >

Re: [PATCH v2 0/8] Docs: Add missing SPDX license identifiers of

2023-01-24 Thread Jonathan Corbet
SeongJae Park writes: > Some subsystem documents are missing SPDX license identifiers on index > files. This patchset adds those. > > Changes from v1 > (https://lore.kernel.org/lkml/20230114194741.115855-2...@kernel.org/) > - Separate from index file content changes > - Separate patch for each s

Re: [PATCH v2] dma-buf: cma_heap: Fix typo in comment

2022-10-28 Thread Jonathan Corbet
Mark-PK Tsai writes: >> [-- Attachment #1: Type: text/plain, Size: 349 bytes --] >> >> On Fri, Oct 28, 2022 at 09:44:17AM +0800, Mark-PK Tsai wrote: >> > Remove duplicated "by" from comment in cma_heap_allocate(). >> > >> >> This patch isn't typofix but duplicate word stripping, right? If so,

Re: [PATCH] docs/sphinx: More depth in the rtd sidebar toc

2022-10-28 Thread Jonathan Corbet
esn't have > the sidebar) nor on the various :toctree: rendered inline in the > output. > > Signed-off-by: Daniel Vetter > Cc: Jonathan Corbet > Cc: linux-...@vger.kernel.org > --- > Documentation/conf.py | 4 > 1 file changed, 4 insertions(+) > > diff --gi

Re: [PATCH] docs/sphinx: More depth in the rtd sidebar toc

2022-11-09 Thread Jonathan Corbet
s a much > simpler sidebar toc which doesn't show the entire hierarchy, only > what's in the local rendered file) nor on the various :toctree: > rendered inline in the output. > > Signed-off-by: Daniel Vetter > Cc: Jonathan Corbet > Cc: linux-...@vger.kernel.org &

Re: [PATCH v3 11/11] Documentation: iio: Document high-speed DMABUF based API

2023-04-03 Thread Jonathan Corbet
Paul Cercueil writes: One nit: > Document the new DMABUF based API. > > Signed-off-by: Paul Cercueil > Cc: Jonathan Corbet > Cc: linux-...@vger.kernel.org > > --- > v2: - Explicitly state that the new interface is optional and is > not implemented by all driv

Re: [PATCH 1/2] docs: process: allow Closes tags with links

2023-03-15 Thread Jonathan Corbet
Matthieu Baerts writes: > +In the same category as linking web pages, a special tag is also used to > close > +issues but only when the mentioned ticketing system can do this operation > +automatically:: > + > +Closes: https://example.com/issues/1234 > + > +Please use this 'Closes:' tag

Re: [PATCH v2 1/2] docs: process: allow Closes tags with links

2023-03-27 Thread Jonathan Corbet
Thorsten Leemhuis writes: >> If we do that, would it be blocking to have this included in v6.3? > > You mean if this still can go in for 6.3? Well, the patches afaics needs > to be ACKed by the right people first (Joe for checkpatch I guess, Jon > for docs). It likely also depends on how this dis

Re: [PATCH 02/37] drm/xlnx/zynqmp_disp: Use correct kerneldoc formatting in zynqmp_disp

2023-08-02 Thread Jonathan Corbet
Laurent Pinchart writes: > I haven't seen anything either. I tried moving the documentation inline, > and the scripts/kernel-doc script ignores the comment blocks for the > inner fields. > > Mauro, Jon, is this a known issue ? If so, are there plans to fix it ? > What's the recommended way to pro

[PATCH] DRM: Fix an incorrectly formatted table

2017-06-23 Thread Jonathan Corbet
The "supported input formats" table in dw_hdmi.h was incorrectly formatted, using "+" signs where "|" needs to be. That, in turn, causes the PDF build to fail. Fixes: def23aa7e9821a3dfe3fb7b139dd0229a89fdeb0 Signed-off-by: Jonathan Corbet --- inc

Re: [PATCH 2/6] docs-rst: automatically convert Graphviz and SVG images

2017-03-02 Thread Jonathan Corbet
On Thu, 2 Mar 2017 16:11:08 +0100 Daniel Vetter wrote: > I'll give it a shot at implementing it, but I can't (easily at least) test > on sphinx 1.3. Virtualenv makes that kind of thing pretty easy to do. Maybe we should add a script to create and populate a suitable venv for this kind of thing.

Re: [PATCH 2/6] docs-rst: automatically convert Graphviz and SVG images

2017-03-02 Thread Jonathan Corbet
On Thu, 2 Mar 2017 19:16:47 +0100 Markus Heiser wrote: > This is very easy, if we use a requiremts.txt file where we > stick the versions and run the sphinx in this build in a > virtualenv which is build up by this requirements.txt. > > https://pip.pypa.io/en/stable/user_guide/#requirements-f

Re: docutils borkage (was: [PATCH 2/6] docs-rst: automatically convert Graphviz and SVG images)

2017-03-04 Thread Jonathan Corbet
On Thu, 2 Mar 2017 16:09:21 -0300 Mauro Carvalho Chehab wrote: > IMHO, the way Python and python libraries break compatibility is crazy. > > Good packaging sense says that, if APIs can break on every single new > release (with seems to be the case of docutils), then a package > depending on such

Re: [PATCH 1/6] doc: Explain light-handed markup preference a bit better

2017-03-07 Thread Jonathan Corbet
On Tue, 7 Mar 2017 17:40:35 +0100 Daniel Vetter wrote: > Jon, can you pls pick this one up, or want me to resend stand-alone? I got it; I should get both applied before too long. jon ___ dri-devel mailing list dri-devel@lists.freedesktop.org https://l

[PATCH] drm: Add gpu.tmpl docbook to MAINTAINERS entry

2016-05-05 Thread Jonathan Corbet
On Thu, 5 May 2016 12:55:19 +0100 Emil Velikov wrote: > Any ideas when the sphinx and/or other work might be > kicking in, or it's still in very early stage ? We've started talking about it again; I sure hope we'll have something ready to pull for 4.8. jon

[PATCH 1/1] apple-gmux: Add initial documentation

2016-01-08 Thread Jonathan Corbet
On Mon, 4 Jan 2016 12:21:40 -0800 Darren Hart wrote: > Any concerns with this series? If not, I'll take it in via the pdx86 tree. > Well, it's built around the asciidoc patch, which isn't in the mainline at this point. Should things go a different direction, that could force some changes here;

[PATCH 5/5] drm: Enable markdown^Wasciidoc for gpu.tmpl

2016-01-11 Thread Jonathan Corbet
On Sat, 12 Dec 2015 12:13:45 +0100 Daniel Vetter wrote: > I just figured there's no way this could get it, and I'd > much rather improve the docs themselves than trying to convince core > kernel folks that this might be useful. So I'm not quite sure why you figured that; I never said it, certain

[PATCH 5/5] drm: Enable markdown^Wasciidoc for gpu.tmpl

2016-01-14 Thread Jonathan Corbet
On Thu, 14 Jan 2016 22:03:26 +0200 Jani Nikula wrote: > What if we added support for some markup language as an alternative to > DocBook for the high level documentation? What if we taught kernel-doc > to output said markup natively, and included those generated pieces into > the high level docum

Re: [PATCH 00/20] Documentation: eliminate duplicated words

2020-07-13 Thread Jonathan Corbet
On Tue, 7 Jul 2020 11:03:54 -0700 Randy Dunlap wrote: > Documentation/admin-guide/mm/numaperf.rst |2 +- > Documentation/block/pr.rst|2 +- > Documentation/core-api/printk-basics.rst |2 +- > Documentation/dev-tools/kgdb.rst

Re: [PATCH -resend] Documentation: fb, fix path to modedb.c

2020-07-23 Thread Jonathan Corbet
On Thu, 23 Jul 2020 12:34:54 +0200 Jiri Slaby wrote: > modedb.c was moved twice since the modedb documentation was written. > Update the path to the current one. > > Signed-off-by: Jiri Slaby > Cc: Bartlomiej Zolnierkiewicz > Cc: Jonathan Corbet > Cc: dri-devel@lists

Re: [PATCH] dma-buf: Couple of documentation typo fixes

2020-04-21 Thread Jonathan Corbet
On Tue, 21 Apr 2020 14:38:37 +0200 Daniel Vetter wrote: > On Mon, Apr 20, 2020 at 05:00:59PM -0600, Jonathan Corbet wrote: > > On Mon, 20 Apr 2020 10:41:15 +0300 > > Gal Pressman wrote: > > > > > Fix a couple of typos: "as" -> "has" and &q

Re: [PATCH 00/22] ReST conversion patches (final?)

2020-06-19 Thread Jonathan Corbet
On Mon, 15 Jun 2020 08:50:05 +0200 Mauro Carvalho Chehab wrote: > That's my final(*) series of conversion patches from .txt to ReST. > > (*) Well, running the script I'm using to check, I noticed a couple of new > *.txt files. > If I have some time, I'll try to address those last pending things

Re: [PATCH v3 0/7] Convert the remaining text files to ReST

2020-06-26 Thread Jonathan Corbet
On Tue, 23 Jun 2020 15:31:33 +0200 Mauro Carvalho Chehab wrote: > The main goal of this series is to finish the ReST conversion. After this > series, we have just those files still in plain old format: > > - Documentation/RCU/RTFP.txt > - Documentation/atomic_bitops.txt > - Doc

Re: [PATCH v2 00/33] Documentation fixes for Kernel 5.8

2020-04-20 Thread Jonathan Corbet
On Tue, 14 Apr 2020 18:48:26 +0200 Mauro Carvalho Chehab wrote: > Patches 1 to 5 contain changes to the documentation toolset: > > - The first 3 patches help to reduce a lot the number of reported > kernel-doc issues, by making the tool more smart. > > - Patches 4 and 5 are meant to partially

Re: [PATCH] dma-buf: Couple of documentation typo fixes

2020-04-20 Thread Jonathan Corbet
On Mon, 20 Apr 2020 10:41:15 +0300 Gal Pressman wrote: > Fix a couple of typos: "as" -> "has" and "int" -> "in". > > Signed-off-by: Gal Pressman Applied, thanks. jon ___ dri-devel mailing list dri-devel@lists.freedesktop.org https://lists.freedeskto

Re: [PATCH 0/3] Fix Kernel-doc warnings introduced on next-20200921

2020-09-22 Thread Jonathan Corbet
On Tue, 22 Sep 2020 20:52:06 +0300 Ville Syrjälä wrote: > Mea culpa. My doc test build was foiled by the sphinx 2 vs. 3 > regression and I was too lazy to start downgrading things. > Any ETA for getting that fixed btw? There's a fix of sorts in docs-next (and thus linux-next) now, has been there

Re: [PATCH] docs: fb: Correcting the location of FRAMEBUFFER_CONSOLE option.

2020-08-26 Thread Jonathan Corbet
On Wed, 26 Aug 2020 23:47:31 +0500 Bilal Wasim wrote: > On Mon, 24 Aug 2020 19:51:55 +0500 > Bilal Wasim wrote: [...] > > Can this simple patch be merged? You sent it two days ago. During a major community conference. Please be patient, somebody will get to it when they have a chance. jonv

Re: [PATCH 11/14] docs: move other kAPI documents to core-api

2020-05-15 Thread Jonathan Corbet
On Fri, 1 May 2020 17:37:55 +0200 Mauro Carvalho Chehab wrote: > There are a number of random documents that seem to be > describing some aspects of the core-api. Move them to such > directory, adding them at the core-api/index.rst file. > > Signed-off-by: Mauro Carvalho Chehab > --- > Docume

[PATCH 1/2] doc/sphinx: Enable keep_warnings

2016-07-19 Thread Jonathan Corbet
On Tue, 19 Jul 2016 13:42:54 +0200 Daniel Vetter wrote: > Unfortunately warnings generated after parsing in sphinx can end up > with entirely bogus files and line numbers as sources. Strangely for > outright errors this is not a problem. Trying to convert warnings to > errors also doesn't fix it.

[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

[PATCH 0/5] sphinxification for dma-buf docs

2016-12-09 Thread Jonathan Corbet
On Fri, 9 Dec 2016 19:53:04 +0100 Daniel Vetter wrote: > Not yet everything in this area, I still want to sprinkle nice docs around all > the fence code. Especially some text to explain implicit vs. explicit fencing > and how it's all supposed to work. > > But just cleanup in the dma-buf part w

[PATCH 0/5] sphinxification for dma-buf docs

2016-12-11 Thread Jonathan Corbet
On Sun, 11 Dec 2016 13:35:49 +0100 Daniel Vetter wrote: > > It seems like just the sort of thing we want to be doing to pull the docs > > together in a more rational way. > > Ok if we pull this in through gfx trees? Will miss 4.10 though, that's > already finished and in bugfix-only mode. I'v

[PATCH 0/5] sphinxification for dma-buf docs

2016-12-11 Thread Jonathan Corbet
On Sun, 11 Dec 2016 18:35:42 +0100 Daniel Vetter wrote: > > Here's a thought, though: how about if we slip in a little version of > > dma-buf.rst now with a "coming soon, don't miss it!!" message? Then the > > rest of the set could go through your tree without touching > > driver-api/index.rst a

[PATCH 1/5] dma-buf: Extract dma-buf.rst

2016-12-11 Thread Jonathan Corbet
On Fri, 9 Dec 2016 19:53:05 +0100 Daniel Vetter wrote: > Just prep work to polish and consolidate all the dma-buf related > documenation. > > Unfortunately I didn't discover a way to both integrate this new file > into the overall toc while keeping it at the current place. Work > around that by

[PATCH 0/4] Add support for Hyperlinks and Markup on kernel-doc

2015-08-13 Thread Jonathan Corbet
On Thu, 13 Aug 2015 20:09:35 -0300 Danilo Cesar Lemes de Paula wrote: > Did you find time to take a look on this? No. Just when I thought things couldn't get crazier, my laptop died. https://plus.google.com/+JonathanCorbet/posts/FBHp48dPb95 What spare time I had has been dedicated t

[PATCH v2 1/4] scripts/kernel-doc: Adding cross-reference links to html documentation.

2015-08-16 Thread Jonathan Corbet
On Tue, 28 Jul 2015 16:45:15 -0300 Danilo Cesar Lemes de Paula wrote: > Functions, Structs and Parameters definitions on kernel documentation > are pure cosmetic, it only highlights the element. > > To ease the navigation in the documentation we should use inside > those tags so readers can eas

[RFC] Docs: drm: Move KMS properties table out to source files

2015-09-28 Thread Jonathan Corbet
On Mon, 28 Sep 2015 10:36:59 +0100 Graham Whaley wrote: > I've still not thought of a way of tweaking the kernel-doc and pandoc > processing to work around this either, as they are done as different > passes/phases that neither has knowledge about the others > requirements. > > As it stands, I'm

Re: [PATCH 3/3] drm/amdgpu: Add documentation for PRIME related code

2018-06-01 Thread Jonathan Corbet
On Fri, 1 Jun 2018 15:40:44 +0200 Michel Dänzer wrote: > Thanks. Is it okay to merge all of these via the amdgpu tree, or should > I wait for an ack from Jon and/or core DRM maintainers for that? I've been assuming they would go through a DRM tree, no need to wait for me. Thanks, jon _

Re: [PATCH 00/18] Fix some build warnings/errors with Sphinx

2018-05-08 Thread Jonathan Corbet
On Mon, 7 May 2018 06:35:36 -0300 Mauro Carvalho Chehab wrote: > I decided to give a try with Sphinx last stable version > (1.17.4), and noticed several issues. The worse one was > with the networking book: a non-standard footnote there > with [*] instead of a number causes it to break PDF build

Re: [PATCH 0/2] Docs/EDID: Fixed and improved EDID documentation

2018-11-06 Thread Jonathan Corbet
On Mon, 5 Nov 2018 09:48:33 +0100 Christoph Niedermaier wrote: > A problem was found when EDID data sets for displays other > than the provided samples were generated. The patch series has > no effect on the provided samples that still match the data > used in drivers/gpu/drm/drm_edid_load.c. > T

Re: [PATCH] Documentation/fb/vesafb.txt: "inverse" option corrections

2018-08-31 Thread Jonathan Corbet
On Thu, 16 Aug 2018 21:12:07 -0700 Randy Dunlap wrote: > From: Randy Dunlap > > Spell the vesafb "inverse" option correctly and tell what it does. > Applied, thanks. This is the first nontrivial change to this file since 2005... jon ___ dri-devel m

Re: [PATCH] [RFC v2] Drop all 00-INDEX files from Documentation/

2018-09-06 Thread Jonathan Corbet
On Tue, 4 Sep 2018 09:59:08 -0400 Steven Rostedt wrote: > On Tue, 4 Sep 2018 13:30:30 +0200 > Pavel Machek wrote: > > > I'd say this is still quite valueable, and it might be worth fixing, > > rather then removing completely. > > I agree. Perhaps we should have a 00-DESCRIPTION file in each

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 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 v2] Drop all 00-INDEX files from Documentation/

2018-09-09 Thread Jonathan Corbet
On Tue, 4 Sep 2018 00:15:23 +0200 Henrik Austad wrote: > I don't really have an opinion to whether or not we /should/ have 00-INDEX, > but the above 00-INDEX should either be removed or be kept up to date. If > we should keep the files, I can try to keep them updated, but I rather not > if we ju

Re: [PATCH] Documentation/gpu: Fix typo in Documentation/gpu/komeda-kms.rst

2024-09-05 Thread Jonathan Corbet
Aryabhatta Dey writes: > Change 'indenpendently' to 'independently'. > > Signed-off-by: Aryabhatta Dey > --- > Documentation/gpu/komeda-kms.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/Documentation/gpu/komeda-kms.rst > b/Documentation/gpu/komeda-kms.rst > index

Re: [PATCH] accel/qaic: Fix a typo

2024-09-06 Thread Jonathan Corbet
Andrew Kreimer writes: > Fix a typo in documentation. > > Signed-off-by: Andrew Kreimer > --- > Documentation/accel/qaic/qaic.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/Documentation/accel/qaic/qaic.rst > b/Documentation/accel/qaic/qaic.rst > index efb7771273b

Re: [PATCH 0/2] Add support for inlined documentation for kunit and kselftests

2023-10-07 Thread Jonathan Corbet
Mauro Carvalho Chehab writes: > Should I wait for you to take a look at patch 1/2 before sending > a new version? Go ahead and resend whenever...I'm still digging out from the last few weeks. Thanks, jon

Re: [PATCH 0/2] Add support for inlined documentation for kunit and kselftests

2023-10-03 Thread Jonathan Corbet
Mauro Carvalho Chehab writes: > This is a follow-up of the discussions taken here: > > > https://lore.kernel.org/linux-doc/20230704132812.02ba97ba@maurocar-mobl2/T/#t > > I sent a previous version as RFC. This is basically what we had there, with > some > improvements at test_list.py. > > It

Re: [PATCH 2/2] drm: add documentation for drm_buddy_test kUnit test

2023-10-03 Thread Jonathan Corbet
One other little thing... Mauro Carvalho Chehab writes: > As an example for the new documentation tool, add a documentation > for drm_buddy_test. > > I opted to place this on a completely different directory, in order > to make easier to test the feature with: > > $ make SPHINXDIRS="tests"

Re: [PATCH v1] docs: gpu: rfc: i915_scheduler.rst remove unused directives for namespacing

2023-11-06 Thread Jonathan Corbet
Jani Nikula writes: > Looks like this is because namespacing was introduced in Sphinx 3.1 > [1]. With earlier Sphinx, you get a warning about the namespace > directives. > > However, with newer Sphinx, you get the warning mentioned in commit > f6757dfcfde7 ("drm/doc: fix duplicate declaration war

Re: [PATCH 0/2] kernel-doc: Do not pre-process comments

2024-01-30 Thread Jonathan Corbet
Anna-Maria Behnsen writes: > Hi, > > this is a repost of the RFC queue > https://lkml.kernel.org/r/20240116151456.48238-1-anna-ma...@linutronix.de > > Jonathan Corbet is fine with this change and mentioned in an answer the > following: > > "The kernel-doc chang

Re: [PATCH] kernel-doc: document object-like preprocessor macros

2024-01-30 Thread Jonathan Corbet
b6229ba...@infradead.org/ > Cc: Randy Dunlap > Cc: Thomas Zimmermann > Cc: Maxime Ripard > Cc: Daniel Vetter > Cc: "Steven Rostedt (Google)" > Cc: Jonathan Corbet > Cc: linux-...@vger.kernel.org > Signed-off-by: Daniel Vetter > --- > Documentation/doc-guide/k

Re: [PATCH] docs: document python version used for compilation

2024-05-09 Thread Jonathan Corbet
Dmitry Baryshkov writes: > The drm/msm driver had adopted using Python3 script to generate register > header files instead of shipping pre-generated header files. Document > the minimal Python version supported by the script. > > Signed-off-by: Dmitry Baryshkov > --- > Documentation/process/cha

Re: [PATCH 0/6] Add support for in-line nested struct comments

2018-02-18 Thread Jonathan Corbet
On Fri, 16 Feb 2018 11:48:14 -0200 Mauro Carvalho Chehab wrote: > his series fix two bugs at kernel-doc.rst examples and add support > for in-line nested struct comments. > > It also converts one documentation at intel_dpio_phy to use it, > in order to give a practical example about how to use i

Re: [RESEND PATCH v2] Documentation/ABI: add sysfs interface for s6e63m0 lcd driver

2018-02-23 Thread Jonathan Corbet
On Fri, 23 Feb 2018 18:53:52 +0530 Aishwarya Pant wrote: > Document sysfs attributes of s6e63m0 lcd panel driver by looking through > git logs and reading code. > > Signed-off-by: Aishwarya Pant Applied, thanks. jon ___ dri-devel mailing list dri-de

Re: [PATCH v2 0/3] backlight: document sysfs interfaces

2018-02-23 Thread Jonathan Corbet
On Tue, 6 Feb 2018 13:08:41 +0530 Aishwarya Pant wrote: > Patchset contains documentation of the sysfs interfaces for the > following five backlight drivers- > 1) lm3639 > 2) adp5520 > 3) adp8860 > > It was compiled from data sheets, reading code and git history logs. In v2 of > the patches, doc

[PATCH 0/7] Documentation warning reduction

2017-07-17 Thread Jonathan Corbet
is took a bit of git archeology to do; hopefully I got it right. Each patch stands alone, so if the DRM folks want to carry the last two themselves, that's fine, just let me know. Jonathan Corbet (7): docs: Get module_init() docs from module.h docs: Do not include kerneldoc comments from ke

[PATCH 2/7] docs: Do not include kerneldoc comments from kernel/sys.c

2017-07-17 Thread Jonathan Corbet
...because there are none there, and I cannot figure out what would ever have been of interest there. This eliminates this warning: ./kernel/sys.c:1: warning: no structured comments found from the build. Signed-off-by: Jonathan Corbet --- Documentation/driver-api/basics.rst | 3 --- 1

[PATCH 1/7] docs: Get module_init() docs from module.h

2017-07-17 Thread Jonathan Corbet
The docs build complains: ./include/linux/init.h:1: warning: no structured comments found The problem is that the comments in question were moved to module.h in commit 0fd972a7d91d (module: relocate module_init from init.h to module.h). Fix basics.rst to match. Signed-off-by: Jonathan

[PATCH 3/7] docs: Do not include from .../seqno-fence.c

2017-07-17 Thread Jonathan Corbet
There are no kerneldoc comments in drivers/dma-buf/seqno-fence.c, and it appears there never have been. Stop looking for comments there to eliminate this warning: ./drivers/dma-buf/seqno-fence.c:1: warning: no structured comments found Signed-off-by: Jonathan Corbet --- Documentation

[PATCH 7/7] docs: Use :internal: for include/drm/drm_syncobj.h

2017-07-17 Thread Jonathan Corbet
file. Switch to :internal: instead to make both problems go away. Cc: dri-devel@lists.freedesktop.org Signed-off-by: Jonathan Corbet --- Documentation/gpu/drm-mm.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/gpu/drm-mm.rst b/Documentation/gpu/drm-mm.rst

[PATCH 4/7] docs: Get the struct cmbdata kernel doc from the right file

2017-07-17 Thread Jonathan Corbet
...and no documentation for that structure. Update the docs to get the information from the right place. Signed-off-by: Jonathan Corbet --- Documentation/driver-api/s390-drivers.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/driver-api/s390-drivers.rst b

  1   2   >