From: Stephan Mueller <smueller@chronox.de>
To: Markus Heiser <markus.heiser@darmarit.de>
Cc: linux-doc@vger.kernel.org, linux-crypto@vger.kernel.org
Subject: Re: SPHINX: no structured comments
Date: Sun, 16 Oct 2016 00:12:05 +0200 [thread overview]
Message-ID: <16408240.aHQPdhiSNO@positron.chronox.de> (raw)
In-Reply-To: <D10CA7D8-CE8A-4C32-BDA8-1641D166649C@darmarit.de>
Am Samstag, 15. Oktober 2016, 18:12:36 CEST schrieb Markus Heiser:
Hi Markus,
> I suppose you have a typo in one of your kernel-doc
> directives. E.g.::
>
> .. kernel-doc:: include/linux/crypto.h
>
> :functions: fooTypo
>
> will produce those error messages:
>
> $ ./scripts/kernel-doc -function fooTypo -rst ./include/linux/crypto.h
> ./include/linux/crypto.h:1: warning: no structured comments found
>
> hope that helps.
Thanks for the hint. The issue was a removed API call.
...
>
> The next hint might be a bit to late for you, but there is a
> *automatic* DocBook to reST migration of the crypto API:
>
> https://github.com/return42/sphkerneldoc/tree/master/doc/Documentation/book
> s_migrated/crypto-API
Thanks for the hint. You are right, it is a bit late, but the DocBook to
Sphinx converter helped me.
With Sphinx now, I also split up the document into more manageable chunks and
fixed some small issues.
Thanks for your help.
Ciao
Stephan
prev parent reply other threads:[~2016-10-15 22:12 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-10-15 15:05 SPHINX: no structured comments Stephan Mueller
2016-10-15 16:12 ` Markus Heiser
2016-10-15 22:12 ` Stephan Mueller [this message]
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=16408240.aHQPdhiSNO@positron.chronox.de \
--to=smueller@chronox.de \
--cc=linux-crypto@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=markus.heiser@darmarit.de \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox