From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: David Howells <dhowells@redhat.com>
Cc: Jonathan Corbet <corbet@lwn.net>, linux-doc@vger.kernel.org
Subject: Re: [PATCH 2/9] docs: watch_queue.rst: supress some Sphinx warnings
Date: Wed, 11 Mar 2020 13:11:02 +0100 [thread overview]
Message-ID: <20200311131102.65943e1b@onda.lan> (raw)
In-Reply-To: <765154.1583864958@warthog.procyon.org.uk>
Em Tue, 10 Mar 2020 18:29:18 +0000
David Howells <dhowells@redhat.com> escreveu:
> Jonathan Corbet <corbet@lwn.net> wrote:
>
> > - We *really* don't want to be adding more files like this to the top
> > level; we have a directory hierarchy for a reason. This looks like it
> > belongs (mostly) in the core-api manual.
>
> Sure. Btw, the core-api/ is a bit of a miscellaneous bag - errseq, for
> example, should probably be in filesystems/.
>
> > - Can the user-space example be instead turned into a working program
> > under samples (or perhaps a test under tests/)?
>
> There is a working sample under samples/ also. See:
>
> https://lore.kernel.org/linux-fsdevel/158375623086.334846.16121725232323108842.stgit@warthog.procyon.org.uk/T/#t
>
> patches 7, 14 and 17.
Well, you could include the complete example from samples at the end of
this file, using a code block with:
.. literalinclude:: /samples/foo.c
:language: c
This will display the Sphinx output files there at the html/pdf output,
as if it is part of the watch_queue.rst, and use the C code highlight.
>
> But no, this needs to be documented in the documentation also. Manual pages
> and testing (at least of key notifications) are available in a branch of the
> keyutils package.
>
> Actually, I need to amend my document to remove references to usb and block
> notifications.
>
> David
>
next prev parent reply other threads:[~2020-03-11 12:11 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-03-03 15:50 [PATCH 1/9] docs: trace: events.rst: convert some new stuff to ReST format Mauro Carvalho Chehab
2020-03-03 15:50 ` [PATCH 2/9] docs: watch_queue.rst: supress some Sphinx warnings Mauro Carvalho Chehab
2020-03-10 17:53 ` Jonathan Corbet
2020-03-10 18:29 ` David Howells
2020-03-11 12:11 ` Mauro Carvalho Chehab [this message]
2020-03-03 15:50 ` [PATCH 3/9] docs: dmaengine: provider.rst: get rid of some warnings Mauro Carvalho Chehab
2020-03-06 13:39 ` Vinod Koul
2020-03-03 15:50 ` [PATCH 4/9] docs: driver.rst: supress two ReSt warnings Mauro Carvalho Chehab
2020-03-10 17:54 ` Jonathan Corbet
2020-03-03 15:50 ` [PATCH 5/9] docs: gpio: driver.rst: don't mark literal blocks twice Mauro Carvalho Chehab
2020-03-04 14:20 ` Bartosz Golaszewski
2020-03-03 15:50 ` [PATCH 6/9] docs: translations: it: avoid duplicate refs at programming-language.rst Mauro Carvalho Chehab
2020-03-03 17:19 ` Nick Desaulniers
2020-03-04 8:34 ` Federico Vaga
2020-03-10 17:55 ` Jonathan Corbet
2020-03-03 15:50 ` [PATCH 7/9] docs: filesystems: fuse.rst: supress a Sphinx warning Mauro Carvalho Chehab
2020-03-10 17:55 ` Jonathan Corbet
2020-03-03 15:50 ` [PATCH 8/9] docs: perf: imx-ddr.rst: get rid of a warning Mauro Carvalho Chehab
2020-03-03 15:50 ` Mauro Carvalho Chehab
2020-03-10 17:56 ` Jonathan Corbet
2020-03-10 17:56 ` Jonathan Corbet
2020-03-03 15:50 ` [PATCH 9/9] docs: hw-vuln: tsx_async_abort.rst: get rid of an unused ref Mauro Carvalho Chehab
2020-03-10 17:57 ` Jonathan Corbet
2020-03-03 20:42 ` [PATCH 1/9] docs: trace: events.rst: convert some new stuff to ReST format Tom Zanussi
2020-03-03 20:48 ` Steven Rostedt
2020-03-10 17:49 ` Jonathan Corbet
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200311131102.65943e1b@onda.lan \
--to=mchehab+huawei@kernel.org \
--cc=corbet@lwn.net \
--cc=dhowells@redhat.com \
--cc=linux-doc@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.