On Thu, May 19, 2016 at 02:34:00PM +0530, Vignesh R wrote:
> There are rotary-encoders where GPIO lines reflect the actual position
> of the rotary encoder dial. For example, if dial points to 9, then four
> GPIO lines connected to the rotary encoder will read HLLH(1001b = 9).
> Add support for suc
On Thu, May 19, 2016 at 02:34:00PM +0530, Vignesh R wrote:
> There are rotary-encoders where GPIO lines reflect the actual position
> of the rotary encoder dial. For example, if dial points to 9, then four
> GPIO lines connected to the rotary encoder will read HLLH(1001b = 9).
> Add support for suc
From: Jonathan Corbet
This script uses pandoc to convert existing DocBook template files to RST
templates. A couple of sed scripts are need to massage things both before
and after the conversion, but the result is then usable with no hand
editing.
[Jani: Change usage to tmplcvt . Fix escaping
I'm not quite sure why the errors below are happening, but this fixes
them.
Use of uninitialized value in string ne at ./scripts/kernel-doc line 1819,
line 6494.
Use of uninitialized value $_[0] in join or string at ./scripts/kernel-doc line
1759, line 6494.
Signed-off-by: Jani Nikula
---
s
Currently we use docproc to figure out which symbols are exported, and
then docproc calls kernel-doc on specific functions, to get
documentation on exported functions. According to git blame and docproc
comments, this is due to historical reasons, as functions and their
corresponding EXPORT_SYMBOL*
Crude conversion. This one doesn't use kernel-doc.
Signed-off-by: Jani Nikula
---
Documentation/index.rst | 5 +-
Documentation/kernel-hacking.rst | 795 +++
2 files changed, 799 insertions(+), 1 deletion(-)
create mode 100644 Documentation/kernel-
Tell Sphinx where to find the extension, and pass on the kernel src tree
and kernel-doc paths to the extension.
With this, any .rst files under Documentation may contain the kernel-doc
rst directive to include kernel-doc documentation from any source file.
While building, it may be handy to pass
Add an extension to handle kernel-doc directives, to call kernel-doc
according to the arguments and parameters given to the reStructuredText
directive.
The syntax for the kernel-doc directive is:
.. kernel-doc:: FILENAME
:export:
:internal:
:functions: FUNCTION [FUNCTION ...]
:doc: SE
The Sphinx output directory is generated.
Signed-off-by: Jani Nikula
---
Documentation/.gitignore | 1 +
1 file changed, 1 insertion(+)
create mode 100644 Documentation/.gitignore
diff --git a/Documentation/.gitignore b/Documentation/.gitignore
new file mode 100644
index ..53752db2
Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.
At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be
Crude conversion. This one uses kernel-doc.
Signed-off-by: Jani Nikula
---
Documentation/index.rst | 1 +
Documentation/kernel-api.rst | 419 +++
2 files changed, 420 insertions(+)
create mode 100644 Documentation/kernel-api.rst
diff --git a/Docum
Hi Jon, all -
I've had a few moments of spare time to look into Sphinx. This is a sort
of status report on the progress.
I suppose we all thought it would be easiest to use docproc for the
Sphinx toolchain, for starters. I tried it, hard, and even sent a bunch
of docproc prep patches. However I r
12 matches
Mail list logo