Re: rst2pdf (was [PATCH 00/10] Documentation/Sphinx)

On Mon, 30 May 2016 23:05:34 +0300 Jani Nikula wrote: > > I can't recommend to use rst2pdf (it is less maintained), use default > > sphinx LaTeX toolchain. > > I think we'll use whatever works, rst2pdf seemed to work for now, but we > can change if needed. I really

Re: [PATCH 00/10] Documentation/Sphinx

On Mon, 30 May 2016 23:05:34 +0300 Jani Nikula wrote: > To be clear, the "sphinx-for-docs-next" branch of [1], [2] is what I > propose to merge at this time. There's the Sphinx configuration, kernel > build integration, Sphinx kernel-doc extension, tons of kernel-doc >

Re: [PATCH 0/7] add reST/sphinx-doc to linux documentation

So I've finally gotten a chance to make another pass over this stuff. Markus, your enthusiasm is great; I'm hoping you'll do great things helping us to improve the kernel's documentation toolchain. But please, at this point, let's build on Jani's work and go from there. Things have waited for

Re: [PATCH v2 29/38] kernel-doc: limit the "section header:" detection to a select few

On Sat, 4 Jun 2016 14:37:30 +0300 Jani Nikula wrote: > kernel-doc currently identifies anything matching "section header:" > (specifically a string of word characters and spaces followed by a > colon) as a new section in the documentation comment, and renders the >

Re: [PATCH] docs: self-protection: rename "leak" to "exposure"

On Wed, 18 May 2016 06:37:47 -0700 Kees Cook wrote: > The meaning of "leak" can be both "untracked resource allocation" and > "memory content disclosure". This document's use was entirely of the > latter meaning, so avoid the confusion by using the Common Weakness >

Re: [PATCH] docs: fix "interruptible" misspellings

On Wed, 18 May 2016 06:55:45 -0700 Kees Cook wrote: > A common misspelling of "interruptible" is "interruptable". This fixes > them in the tree and adds the two most common variations to spelling.txt. > > Suggested-by: Randy Dunlap > Signed-off-by:

Re: [PATCH v2 00/38] Documentation/sphinx

On Sat, 4 Jun 2016 14:37:01 +0300 Jani Nikula wrote: > When this lands in docs-next and we can backmerge to drm, we'll plunge > ahead and convert gpu.tmpl to rst, and have that ready for v4.8. That is now done — thanks for running with this! I'm looking forward to

Re: [PATCH v2 00/38] Documentation/sphinx

On Tue, 14 Jun 2016 10:15:00 +0200 Daniel Vetter wrote: > Hi Jon, > > On Fri, Jun 10, 2016 at 10:41 PM, Dave Airlie wrote: > > > It would be best if Jon can give us a known tag that won't get rebased, > > and will end up in docs-next and drm-next,

Re: [PULL v4.6-rc1] bcache: documentation updates

On Mon, 30 May 2016 07:43:09 -0700 Marc MERLIN wrote: > > There is a bcache documentation update available: > > > > > > git pull https://bitbucket.org/ewheelerinc/linux > > > > v4.6-rc1-bcache-documentation > > > > Is this the right list to submit such documentation? >

Re: [PATCH 00/10] Documentation/Sphinx

On Mon, 30 May 2016 11:10:26 +0200 Daniel Vetter wrote: > I think next steps is to get this merged into docs-next, with a stable > tag, so that I can pull it into drm-misc. So, I want to take another look at this, which probably will need another day or two before it can

Re: [PATCH] Documentation: fix wrong value in md.txt

On Fri, 17 Jun 2016 09:40:02 +0800 (CST) "Tiezhu Yang" wrote: > I read drivers/md/raid5.c and find the following related code: > 1) in function 'raid5_set_cache_size': > if (size <= 16 || size > 32768) > return -EINVAL; > 2) #define NR_STRIPES 256 > > So the

Re: [docs-next PATCH v2 00/11] Documentation/sphinx follow-up, again

On Thu, 23 Jun 2016 15:28:00 +0300 Jani Nikula wrote: > The first 9 patches are just a resend of [1], there's two patches on top > here. OK, these all look good to me. Applied to the docs tree, sorry for the delay. jon -- To unsubscribe from this list: send the line

Re: [PATCH] Documentation: tiny typo fix in usb/gadget_multi.txt

On Sat, 11 Jun 2016 02:56:37 +0200 Michal Nazarewicz wrote: > -For the gadget two work under Windows two conditions have to be met: > +For the gadget to work under Windows two conditions have to be met: Applied to the docs tree, thanks. jon -- To unsubscribe from this list:

Re: [PATCH] Doc: ja_JP: Fix a typo in HOWTO

On Mon, 1 Feb 2016 13:03:27 +0900 Masanari Iida wrote: > This patch fix a typo witin HOWTO, which was translated in Japanese. > Replace a word "kernlehacker" with "kernelhacker". Wouldn't want to misspell Mr. Kernelhacker's name! Applied, thanks. jon -- To unsubscribe

Re: [RFC] A first shot at asciidoc-based formatted docs

On Wed, 10 Feb 2016 09:07:22 +0100 Daniel Vetter wrote: > I think for 4.6 it'd be best to go with the hybrid asciidoc->docbook > toolchain, since that's less disruptive. And with that we can also > fully concentrating on the frontend, and how it'll look and behave. That

Kernel docs: muddying the waters a bit

So I fear you all are going to hate me for this... Asciidoc is a credible solution to the formatted documentation problem, but it's not the only such; I'd like to be sure that we pick the right one. I worry that asciidoc seems to be aimed mostly at small documents, and that the project itself

Re: [PATCH] kernel-doc: add support for asciidoc output

On Mon, 18 Jan 2016 10:41:17 +0200 Jani Nikula wrote: > Add new -asciidoc option to produce asciidoc output from kernel-doc. The > output is formatted internally, with no dependencies on external > tools. Any asciidoc formatting present in kernel-doc will naturally be >

[PATCH 3/4] Docs: Makefile tweaks for asciidoc templates

This is a hatchet job, but it's something to start with. Generalize some of the string manipulation to not assume that templates have a ".tmpl" suffix, and add rules to translate asciidoc templates to HTML. Nothing for any other output formats at this point. Signed-off-by: Jonathan C

Re: Kernel docs: muddying the waters a bit

On Tue, 16 Feb 2016 10:25:49 +0200 Jani Nikula wrote: > However I didn't think Sphinx could produce docbook, and a quick search > doesn't convince me otherwise. Do you have some links to back this up? Somehow I was really sure of it, but I'm not finding it now. There is

Re: [PATCH v2] Documentation: Chinese translation of arm64/silicon-errata.txt

On Tue, 16 Feb 2016 16:40:39 +0800 w...@redhat.com wrote: > This is a Chinese translated version of Documentation/arm64/silicon-errata.txt Applied to the docs tree, thanks. jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to

Re: [PATCH] Documentation/ko_KR: update maintainer information

On Sun, 14 Feb 2016 11:51:23 +0900 SeongJae Park wrote: > Maintainer informations of Documentation/ko_KR is outdated. This commit > update the informations to the latest ones. Applied to the docs tree, thanks. jon -- To unsubscribe from this list: send the line

V4L docs and docbook

Hey, Mauro, There's been a conversation going on that I keep meaning to bring you into. In short, there's a fair amount of interest in improving our formatted kernel documentation, and, in particular, making it easier to write; I'd like to be sure that work doesn't leave media behind. Work

Re: [PATCH] modsign: Fix documentation on module signing enforcement parameter.

On Mon, 7 Mar 2016 01:45:17 - "James Johnston" wrote: > Modify the documentation to match the actual parameter as implemented in > kernel/module.c:273. So I was going to apply this to the docs tree, but it's been white-space mangled. Care to fix your mail

Re: [PATCH] Doc: nfs: Fix typos in Documentation/filesystems/nfs

On Thu, 18 Feb 2016 12:26:13 +0900 Masanari Iida wrote: > This patch fix spelling typos found in Documentation/filesystems/nfs I've applied this to the docs tree. I fixed the two "reacquire" instances that Randy pointed out; it would have been nice to get an updated

[PULL] Documentation for 4.6

The following changes since commit 92e963f50fc74041b5e9e744c330dca48e04f08d: Linux 4.5-rc1 (2016-01-24 13:06:47 -0800) are available in the git repository at: git://git.lwn.net/linux.git tags/docs-for-linus for you to fetch changes up to abfa6cd8cda71b9071191e72711bd474e539b1b2:

Re: [PATCH] Documentation: Howto: Fixed subtitles style

On Mon, 7 Mar 2016 02:36:18 +0100 Philippe Loctaux wrote: > Fixed subtitles style, aligned them with their header. Applied to the docs tree, thanks. jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to

Re: [PATCH] doc: fix grammar

On Thu, 25 Feb 2016 11:19:56 + Javi Merino wrote: > Some minor typos: > > - make is unbindable -> make it unbindable > - a underlying -> an underlying > - different version -> different versions Applied to the docs tree, thanks. jon -- To unsubscribe from this

Re: [PATCH] modsign: Fix documentation on module signing enforcement parameter.

On Thu, 10 Mar 2016 03:38:48 - "James Johnston" wrote: > My mail client is determined to embarrass me. :( Trying again... Worked this time! Applied to the docs tree, thanks. jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the

Re: [PATCH] Documentation: update missing index files in block/00-INDEX

On Mon, 21 Mar 2016 19:42:19 +0800 Wei Fang wrote: > Update missing index files in block/00-INDEX. Applied to the docs tree, thanks. jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majord...@vger.kernel.org More

Re: [PATCH 1/5] Documentation: add Linux Kernel Development book

On Sat, 19 Mar 2016 12:51:20 + Luis de Bethencourt wrote: > The Linux Kernel Development book by Robert Love has been recommended to me > by multiple kernel hackers. Worth having in the list of books in > kernel-docs.txt for newbies looking for good learning

Re: [PATCH 2/5] Documentation: update URL for Michael K. Johnson's articles

On Sat, 19 Mar 2016 12:51:21 + Luis de Bethencourt wrote: > The URL for "Writing Linux Device Drivers" hasn't been available in some > time. Updating it to the URL of Michael K. Johnson's "Linux Kernel Hackers' > Guide" But that's a different work, I don't think it

Re: [PATCH 3/5] Documentation: update URL of Analysis of the Ext2fs structure

On Sat, 19 Mar 2016 12:51:22 + Luis de Bethencourt wrote: > The current URL has been down for some time, updating it to a working one. Applied to the docs tree, thanks. jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a

Re: [PATCH 4/5] Documentation: update URLs for Richard Gooch's articles

On Sat, 19 Mar 2016 12:51:23 + Luis de Bethencourt wrote: > Current URL for "Kernel API changes from 2.0 to 2.2" hasn't been available > for some time, updating. The second article about changes from 2.2 to 2.4 > is missing a URL, adding it. Applied to the docs tree,

Re: [PATCH 0/9] serial: doc: Low Level Serial API Documentation Improvements

On Mon, 14 Mar 2016 16:16:08 +0100 Geert Uytterhoeven wrote: > This patch series contains improvements to the low level serial driver > API documentation. Hearing no objections, I've applied the set to the docs tree, thanks. jon -- To unsubscribe from this list: send

Re: [PATCH] bpf: doc: "neg" opcode has no operands

On Mon, 28 Mar 2016 14:56:47 -0700 Kees Cook wrote: > From: Dave Anderson > > Fixes a copy-paste-o in the BPF opcode table: "neg" takes no arguments > and thus has no addressing modes. I've applied this to the docs tree, thanks. jon -- To

Re: [PATCH] Documentation/IRQ-domain.txt: Document irq_domain_create_{linear, tree}

On Sun, 27 Mar 2016 11:51:20 +0800 Jianyu Zhan wrote: > They have the same functionalities as irq_domain_add_{linear, tree}, > except fro accepting different first argument. > > Signed-off-by: Jianyu Zhan > --- > v1->v2: >Fix spelling error. Applied

Re: [RFC v2] Documentation: mmc: Add the introduction for mmc-utils

On Wed, 16 Mar 2016 20:02:49 +0800 Baolin Wang wrote: > This patch introduces one mmc test tools called mmc-utils, which is convenient > if someone wants to exercise and test MMC/SD devices from userspace. I've applied this to the docs tree, thanks. jon -- To

Re: Kernel docs: muddying the waters a bit

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

Re: Kernel docs: muddying the waters a bit

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

Re: [PATCH 40/41] Documentation: x86: fix spelling mistakes

On Mon, 25 Apr 2016 07:37:06 +0100 Eric Engestrom wrote: > Documentation/x86/intel_mpx.txt | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-) Applied to the docs tree, thanks. jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body

Re: [PATCH] Changed the path from to the incorrect drivers/char/sysrq.c to drivers/tty/sysrq.c

On Thu, 28 Apr 2016 10:15:24 +0200 René Nyffenegger wrote: > You're right, the lines were wrapped at character 78. I have fixed that > and sent the patch to myself. The attached patch should work now. The patch applies, but the above text is not a proper commit message,

Re: [PATCH 32/41] Documentation: pps: fix spelling mistake

On Mon, 25 Apr 2016 07:36:58 +0100 Eric Engestrom wrote: > Documentation/pps/pps.txt | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) Applied to the docs tree, thanks. jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a

Re: [PATCH 39/41] Documentation: vm: fix spelling mistakes

On Mon, 25 Apr 2016 07:37:05 +0100 Eric Engestrom wrote: > Documentation/vm/transhuge.txt | 6 +++--- > 1 file changed, 3 insertions(+), 3 deletions(-) Applied to the docs tree, thanks. jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body

Re: [PATCH 39/41] Documentation: vm: fix spelling mistakes

On Thu, 28 Apr 2016 07:31:43 -0600 Jonathan Corbet <cor...@lwn.net> wrote: > On Mon, 25 Apr 2016 07:37:05 +0100 > Eric Engestrom <e...@engestrom.ch> wrote: > > > Documentation/vm/transhuge.txt | 6 +++--- > > 1 file changed, 3 insertions(+), 3 deletions(-

Re: [PATCH 41/41] Documentation: xillybus: fix spelling mistake

On Mon, 25 Apr 2016 07:37:07 +0100 Eric Engestrom wrote: > Documentation/xillybus.txt | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) Applied to the docs tree, thanks. jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a

Re: [PATCH v2] Documentation: fix common spelling mistakes

On Tue, 26 Apr 2016 16:41:21 -0700 Kees Cook wrote: > This fixes several spelling mistakes in the Documentation/ tree, which > are caught by checkpatch.pl's spell checking. I've applied this to the docs tree, thanks. jon -- To unsubscribe from this list: send the line

Re: [PATCH 29/41] Documentation: lzo: fix spelling mistakes

On Mon, 25 Apr 2016 07:36:55 +0100 Eric Engestrom wrote: > Documentation/lzo.txt | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-) Applied to the docs tree, thanks. jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a

Re: [PATCH 27/41] Documentation: laptops: fix spelling mistake

On Mon, 25 Apr 2016 07:36:53 +0100 Eric Engestrom wrote: > -laptops, being called "Toshiba HDD Protection - Shock Sensor" officialy, > +laptops, being called "Toshiba HDD Protection - Shock Sensor" officially, Applied to the docs tree, thanks. jon -- To unsubscribe from this

Re: [PATCH v2] hrtimers: doc cleanup

On Thu, 21 Apr 2016 21:39:15 +0800 Cao jin wrote: > It has: > a tense correction(led->leads); > a typo(unevitably->inevitably); I've applied this to the docs tree, thanks. jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a

Re: [PATCH 34/41] Documentation: robust-futexes: fix spelling mistakes

On Mon, 25 Apr 2016 07:37:00 +0100 Eric Engestrom wrote: > Documentation/robust-futexes.txt | 6 +++--- > 1 file changed, 3 insertions(+), 3 deletions(-) Applied to the docs tree, thanks. jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the

Re: [PATCH 35/41] Documentation: scsi: fix spelling mistakes

On Mon, 25 Apr 2016 07:37:01 +0100 Eric Engestrom wrote: > Documentation/scsi/ChangeLog.megaraid_sas | 16 > 1 file changed, 8 insertions(+), 8 deletions(-) Applied to the docs tree (after fixing trailing whitespace errors - the new and the old ones). jon

Re: [PATCH v2 0/2] moves samples out of Documentation directory

On Mon, 25 Apr 2016 18:03:07 +0200 Arnd Bergmann wrote: > As suggested by Nicolas Pitre, here is a resend of two patches to > move the kernel modules from Documentation/*/ to samples/*/. > > With Nico's changes in place, it's no longer necessary to do this, > but it seems like a

Re: [PATCH] Changed the path from to the incorrect drivers/char/sysrq.c to drivers/tty/sysrq.c

On Fri, 22 Apr 2016 21:17:23 +0200 René Nyffenegger wrote: > This is my first patch submission. Please let me know if I have made a > mistake anywhere. Thank you for improving the documentation! Unfortunately, the patch was corrupted by your mail client and does not

Re: [PATCH] Mark "Out of Date" addresses as undeliverable

On Thu, 21 Apr 2016 23:04:26 +0800 Zhigang Gao wrote: > Chinese maintainer for help. Contact the Chinese maintainer, if this > translation is outdated or there is problem with translation. > > -Chinese maintainer: Zhang Le > +Chinese maintainer:

Re: [PATCH v2] doc: clarify that trace_events= takes a comma-separated list

On Mon, 23 May 2016 16:54:51 -0400 Steven Rostedt wrote: > This version looks good to me. Jonathan, you want to take this patch? Sure, I'll take it. Thanks, jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to

Re: [PATCH 0038/1529] Fix typo

Did you really just broadcast out 1,500 patches? I appreciate you're trying to help, but it's not really going to be possible for anybody to take a serious look at something like this. Especially since... On Sat, 21 May 2016 13:40:47 +0200 Andrea Gelmini wrote: >

Re: [PATCH] Documentation/memcg: update kmem limit doc as codes behavior

On Wed, 11 May 2016 14:07:31 +0800 Qiang Huang wrote: > The restriction of kmem setting is not there anymore because the > accounting is enabled by default even in the cgroup v1 - see > b313aeee2509 ("mm: memcontrol: enable kmem accounting for all > cgroups in the legacy

Re: [PATCH -trivial 1/3] Documentation: vm: Spelling s/paltform/platform/g

On Tue, 10 May 2016 20:59:56 +0200 Geert Uytterhoeven wrote: > diff --git a/Documentation/vm/hugetlbpage.txt > b/Documentation/vm/hugetlbpage.txt > index 54dd9b9c6c31aeed..6f3b3fa35613d900 100644 > --- a/Documentation/vm/hugetlbpage.txt > +++

Re: [PATCH 0/9] kernel-doc/docproc prep work for reStructuredText

On Thu, 12 May 2016 16:15:35 +0300 Jani Nikula wrote: > Jon, I was hoping we could consider nudging things forward a bit in the > kernel-doc and docproc reStructuredText front already in 4.7. I know > it's a bit close to the merge window, but this should not interfere with

Re: Kernel docs: muddying the waters a bit

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

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

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: [PATCH 4/4] serial: doc: .break_ctl() may sleep

On Fri, 15 Apr 2016 15:31:30 -0700 Peter Hurley wrote: > The only caller of the uart driver's break_ctl() method is > uart_break_ctl(), which is serial core's proxy tty driver break_ctl() > method. uart_break_ctl() claims the struct tty_port::mutex to prevent >

Re: [PATCH v2 2/5] Documentation: update Michael K. Johnson's work

On Thu, 31 Mar 2016 12:10:30 +0100 Luis de Bethencourt wrote: > The URL for "Writing Linux Device Drivers" hasn't been available in some > time. Updating the entry to Michael K. Johnson's "Linux Kernel Hackers' > Guide" OK, I've applied this one to the docs tree.

Re: [PATCH v3] ARM64: ACPI: Update documentation for latest specification version

On Mon, 28 Mar 2016 18:06:42 -0600 Al Stone wrote: > This patch reflects going back through and examining the specs in detail > and updating content appropriately. Whilst there, a few odds and ends of > typos were caught as well. This brings the documentation up to date

Re: [PATCH 4/4] serial: doc: .break_ctl() may sleep

On Thu, 14 Apr 2016 11:08:11 +0200 Geert Uytterhoeven wrote: > As mutex_lock() must not be called with interrupts disabled, > .break_ctl() may sleep. So I've applied the first three to the docs tree, but this one stopped me. The changelog doesn't really say why the

Re: [PATCH] documentation: trivial typo: adding-syscalls.txt: s/statat/fstatat/

On Mon, 18 Apr 2016 20:30:56 +0300 Askar Safin wrote: > -page; for an example of AT_EMPTY_PATH, see the statat(2) man page.) > +page; for an example of AT_EMPTY_PATH, see the fstatat(2) man page.) Applied to the docs tree, thanks. jon -- To unsubscribe from this list: send

Re: [PATCH] Documentatio: HOWTO: remove regression postings info from translations

On Sat, 16 Apr 2016 09:18:46 +0900 SeongJae Park wrote: > Obsolete info about regression postings were removed by commit > 5645a717c6ee61e67d38aa9f15cb9db074e1e99d ("Documentation: HOWTO: remove > obsolete info about regression postings") but not applied to > translations.

Re: [PATCH] hrtimers: doc cleanup

On Thu, 21 Apr 2016 18:25:41 +0800 Cao jin wrote: > > This change is incorrect - "unacceptable" is exactly what the writer > > wanted to say here. > > > *it cannot be 'designed out' without inevitably degrading other portions > of the timers.c code in an unacceptable

Re: [PATCH] hrtimers: doc cleanup

On Thu, 21 Apr 2016 17:09:54 +0800 Cao jin wrote: > - wheel concept, it cannot be 'designed out' without unevitably > - degrading other portions of the timers.c code in an unacceptable way. > + wheel concept, it cannot be 'designed out' without inevitably > +

[PULL] Documentation for 4.8

Martinez Canillas (1): Documentation: Fix some grammar mistakes in sync_file.txt Jerome Marchand (1): Documentation: add watermark_scale_factor to the list of vm systcl file Jonathan Corbet (7): sphinx: cheesy script to convert .tmpl files Merge branch 'sphinx-for-docs-next' into doc/4.8

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

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

Re: Visualizing linux kernel datastructures

On Mon, 25 Jul 2016 16:56:46 +0200 Charlemagne Lasse wrote: > So my questions would be: > > 1. is there a standard (machine readable?) how to correctly document > (kernel-doc?) in the code if a struct list_head is the head/root of a > list or the anchor of the item

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

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

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

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

Re: [PATCH] Revert "Revert "doc/sphinx: Enable keep_warnings""

On Thu, 11 Aug 2016 12:02:31 +0200 Markus Heiser wrote: > "bump" ... may my mail got lost ... > > It's about the default highlight language in the conf.py. I suggested > to set it to the value 'guess', since this might solve most of our > problems discussed in this

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

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

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

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

Re: [PATCH] CodingStyle: Clarify and complete chapter 7

On Mon, 25 Jul 2016 14:29:06 +0200 Jean Delvare wrote: > Chapter 7 (Centralized exiting of functions) of the coding style > documentation is unclear at times, and lacks some information (such > as the possibility to indent labels with a single space.) Clarify and > complete it.

Re: [PATCH v2] Documentation: clk: update file names containing referenced structures

On Fri, 12 Aug 2016 14:41:25 +0200 Geert Uytterhoeven wrote: > From: Andi Shyti > > Commit 'b09d6d991' removes include/linux/clk-private.h and > re-arranges the clock related structures contained in it in > different files. The documentation has

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

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,

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

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]. > >

Re: [PATCH] CodingStyle: Remove "Don't use C99-style comments"

On Thu, 04 Aug 2016 10:55:14 -0700 Joe Perches wrote: > > Because Linus may still be reading source code on greenbar paper > > instead of color terminals with code syntax highlighting and > > appropriate font decorations. > > > > Link: > >

Re: [RFC PATCH 0/3] Documentation: switch to pdflatex and fix pdf build

On Wed, 10 Aug 2016 18:54:06 +0300 Jani Nikula wrote: > With these you should be able to get started with pdf generation. It's a > quick transition to pdflatex, the patches are not very pretty, but the > pdf output is. Patch 3/3 works as an example where to add your stuff

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

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

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

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

Re: [PATCH] doc-rst: kernel-doc directive, fix state machine reporter

On Wed, 20 Jul 2016 12:38:58 +0200 Markus Heiser wrote: > Add a reporter replacement that assigns the correct source name and line > number to a system message, as recorded in a ViewList. This is clearly a worthwhile fix, and I've applied it. A couple of little

Re: [PATCH] docs: Remove kernel-doc-nano-HOWTO.txt

" that kernel-doc-nano-HOWTO.txt is there, and various other docs had pointers to it. So I've just committed this instead, hope it's OK... jon --- >From 8ed292fe864e9ed7d335515e97590122a56d7cba Mon Sep 17 00:00:00 2001 From: Jonathan Corbet <cor...@lwn.net> Date: Wed, 20 Jul 2016

Re: [PATCH v5 2/2] Doc/memory-barriers: Add Korean translation

On Thu, 21 Jul 2016 07:23:46 -0700 "Paul E. McKenney" <paul...@linux.vnet.ibm.com> wrote: > If Minchan is OK with this version, if Ingo and Jon have no objections, > and given the small change below, I will take it. None here. Acked-by: Jonathan Corbet <cor...@lwn.ne

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

On Thu, 21 Jul 2016 16:41:53 +0200 Markus Heiser <markus.hei...@darmarit.de> wrote: > Am 21.07.2016 um 01:28 schrieb Jonathan Corbet <cor...@lwn.net>: > > > I would hope that most people wouldn't have to worry about it, and would > > be able to just use what their

Re: [PATCH] Documentation: add watermark_scale_factor to the list of vm systcl file

On Tue, 12 Jul 2016 12:05:59 +0200 "Jerome Marchand" wrote: > Commit 795ae7a0de6b ("mm: scale kswapd watermarks in proportion to > memory") properly added the description of the new knob to > Documentation/sysctl/vm.txt, but forgot to add it to the list of files > in

[PATCH] docs: Get rid of some kernel-documentation warnings

Sphinx wants to interpret all literal blocks as being in the chosen language and complains when an attempt to parse a block fails. kernel-documentation.rst has a few blocks that are not in C; make that explicit to shut down the associated warnings. Signed-off-by: Jonathan Corbet <cor...@lwn.

Re: [PATCH] kernel-doc: Fix up warning output

On Fri, 15 Jul 2016 10:19:30 +0200 Daniel Vetter wrote: > While trying to make gpu docs warning free I stumbled over one output > which wasn't following proper compiler error output standards. Fix it > up for more quickfix awesomeness. Applied to the docs tree -

Re: Troubles with kernel-doc and RST files

[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

Re: Troubles with kernel-doc and RST files

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:

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

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 >

Re: Troubles with kernel-doc and RST files

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

Re: [PATCH v4] Documentation: Move samples from doc to samples/

On Mon, 18 Jul 2016 15:55:00 -0400 Mahesh Khanwalkar wrote: > Moved sample code found in Documentation/ to samples/ but kept actual > documentation where it is, while updating any in-text references to the > moved code. Updated the Documentation/Makefile and

Re: Troubles with kernel-doc and RST files

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

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

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

  1   2   3   4   5   6   7   8   >