Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]
Groups > linux.kernel > #1404432 > unrolled thread
| Started by | Jani Nikula <jani.nikula@intel.com> |
|---|---|
| First post | 2016-05-20 15:50 +0200 |
| Last post | 2016-05-31 10:10 +0200 |
| Articles | 20 — 4 participants |
Back to article view | Back to linux.kernel
[PATCH 00/10] Documentation/Sphinx Jani Nikula <jani.nikula@intel.com> - 2016-05-20 15:50 +0200
[PATCH 08/10] Documentation: add kernel hacking rst Jani Nikula <jani.nikula@intel.com> - 2016-05-20 15:50 +0200
[PATCH 03/10] Documentation/sphinx: add basic working Sphinx configuration and build Jani Nikula <jani.nikula@intel.com> - 2016-05-20 15:50 +0200
[PATCH 09/10] Documentation: add kernel api rst Jani Nikula <jani.nikula@intel.com> - 2016-05-20 15:50 +0200
[PATCH 04/10] Documentation: add .gitignore Jani Nikula <jani.nikula@intel.com> - 2016-05-20 15:50 +0200
[PATCH 02/10] kernel-doc: support printing exported and non-exported symbols Jani Nikula <jani.nikula@intel.com> - 2016-05-20 15:50 +0200
[PATCH 05/10] Documentation/sphinx: add Sphinx kernel-doc directive extension Jani Nikula <jani.nikula@intel.com> - 2016-05-20 15:50 +0200
[PATCH 06/10] Documentation/sphinx: configure the kernel-doc extension Jani Nikula <jani.nikula@intel.com> - 2016-05-20 15:50 +0200
[PATCH 07/10] sphinx: cheesy script to convert .tmpl files Jani Nikula <jani.nikula@intel.com> - 2016-05-20 15:50 +0200
[PATCH 01/10] kernel-doc: fix use of uninitialized value Jani Nikula <jani.nikula@intel.com> - 2016-05-20 15:50 +0200
Re: [PATCH 00/10] Documentation/Sphinx Jani Nikula <jani.nikula@intel.com> - 2016-05-29 22:40 +0200
Re: [PATCH 00/10] Documentation/Sphinx Daniel Vetter <daniel.vetter@ffwll.ch> - 2016-05-30 11:20 +0200
Re: [PATCH 00/10] Documentation/Sphinx Markus Heiser <markus.heiser@darmarit.de> - 2016-05-30 12:50 +0200
Re: [PATCH 00/10] Documentation/Sphinx Jani Nikula <jani.nikula@intel.com> - 2016-05-30 16:50 +0200
Re: [PATCH 00/10] Documentation/Sphinx Daniel Vetter <daniel.vetter@ffwll.ch> - 2016-05-30 17:30 +0200
Re: [PATCH 00/10] Documentation/Sphinx Markus Heiser <markus.heiser@darmarit.de> - 2016-05-30 18:50 +0200
Re: [PATCH 00/10] Documentation/Sphinx Jani Nikula <jani.nikula@intel.com> - 2016-05-30 22:10 +0200
Re: [PATCH 00/10] Documentation/Sphinx Mauro Carvalho Chehab <mchehab@osg.samsung.com> - 2016-05-30 23:30 +0200
Re: [PATCH 00/10] Documentation/Sphinx Markus Heiser <markus.heiser@darmarit.de> - 2016-05-31 09:30 +0200
Re: [PATCH 00/10] Documentation/Sphinx Daniel Vetter <daniel.vetter@ffwll.ch> - 2016-05-31 10:10 +0200
| From | Jani Nikula <jani.nikula@intel.com> |
|---|---|
| Date | 2016-05-20 15:50 +0200 |
| Subject | [PATCH 00/10] Documentation/Sphinx |
| Message-ID | <rASYp-68P-3@gated-at.bofh.it> |
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 ran into some problems. Out-of-tree
builds were a nightmare, as Sphinx has trouble to pick up some of the
files from $(srctree) and some from $(objtree). Having dependencies on
the source files work without rebuilding everything was getting tricky
too.
I decided to look into writing a Sphinx extension for kernel-doc, and it
turns out to be a really nice solution. We can keep all the .rst files
in $(srctree), we don't have to explicitly specify the .rst files to
process, there are no intermediate files, and Sphinx runs the kernel-doc
script using the extension based on the directives in the .rst
files. The extension tells Sphinx about the dependencies on the source
files, and Sphinx handles rebuilding as needed. Out-of-tree builds just
work. Sites like https://readthedocs.org/ can build the documentation,
including kernel-doc, without extra tweaks. As a whole, the build
becomes much simpler.
There are a few tradeoffs, of course. First, this requires that the
EXPORT_SYMBOL markers are placed immediately after the function being
exported, as kernel-doc will only look at one file at a time. This is
the recommendation anyway. See the corresponding patch for further
details ("kernel-doc: support printing exported and non-exported
symbols"). Second, we lose support for the !C docproc directive to check
that all kernel-doc comments in a file are used. This is probably
something we'd like to have back in the future, but at this time I think
it's an acceptable tradeoff wrt the gains.
With this, we can put any .rst files (including ones that have
kernel-doc directives) anywhere under Documentation, add a link to them
in Documentation/index.rst table of contents, and it will just work. It
can't get much simpler than that.
At this time I've put most effort into the configuration and build side
of things, solving the problems described above, and handling missing
tools and packages gracefully. There are still issues to be ironed out
in a) the kernel-doc script rst output and b) the xml template to rst
conversion. These are somewhat orthogonal from each other and the build,
and I expect some hand-editing will be required in the end.
The patches are available in the "sphinx" branch of [1], and I've set up
a project at Read the Docs to build that into documentation [2] (mostly
to test this approach also works and so I don't have to host this
anywhere).
Any comments are welcome, but please do remember that I've focused on
polishing the toolchain and build, not the output quality, with release
early, release often in mind.
BR,
Jani.
[1] git://people.freedesktop.org/~jani/drm
[2] https://kernel.readthedocs.io/
Jani Nikula (9):
kernel-doc: fix use of uninitialized value
kernel-doc: support printing exported and non-exported symbols
Documentation/sphinx: add basic working Sphinx configuration and build
Documentation: add .gitignore
Documentation/sphinx: add Sphinx kernel-doc directive extension
Documentation/sphinx: configure the kernel-doc extension
Documentation: add kernel hacking rst
Documentation: add kernel api rst
Documentation: moar files
Jonathan Corbet (1):
sphinx: cheesy script to convert .tmpl files
Documentation/.gitignore | 1 +
Documentation/DocBook/Makefile | 7 +-
Documentation/Makefile.sphinx | 63 +
Documentation/conf.py | 384 +++++
Documentation/crypto-API.rst | 1870 +++++++++++++++++++++
Documentation/filesystems.rst | 314 ++++
Documentation/gpu.rst | 2556 +++++++++++++++++++++++++++++
Documentation/index.rst | 30 +
Documentation/kernel-api.rst | 419 +++++
Documentation/kernel-hacking.rst | 795 +++++++++
Documentation/sphinx/convert_template.sed | 14 +
Documentation/sphinx/kernel-doc.py | 99 ++
Documentation/sphinx/post_convert.sed | 19 +
Documentation/sphinx/tmplcvt | 19 +
Makefile | 5 +-
scripts/kernel-doc | 32 +-
16 files changed, 6619 insertions(+), 8 deletions(-)
create mode 100644 Documentation/.gitignore
create mode 100644 Documentation/Makefile.sphinx
create mode 100644 Documentation/conf.py
create mode 100644 Documentation/crypto-API.rst
create mode 100644 Documentation/filesystems.rst
create mode 100644 Documentation/gpu.rst
create mode 100644 Documentation/index.rst
create mode 100644 Documentation/kernel-api.rst
create mode 100644 Documentation/kernel-hacking.rst
create mode 100644 Documentation/sphinx/convert_template.sed
create mode 100644 Documentation/sphinx/kernel-doc.py
create mode 100644 Documentation/sphinx/post_convert.sed
create mode 100755 Documentation/sphinx/tmplcvt
--
2.1.4
[toc] | [next] | [standalone]
| From | Jani Nikula <jani.nikula@intel.com> |
|---|---|
| Date | 2016-05-20 15:50 +0200 |
| Subject | [PATCH 08/10] Documentation: add kernel hacking rst |
| Message-ID | <rASYp-68P-1@gated-at.bofh.it> |
| In reply to | #1404432 |
Crude conversion. This one doesn't use kernel-doc.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
---
Documentation/index.rst | 5 +-
Documentation/kernel-hacking.rst | 795 +++++++++++++++++++++++++++++++++++++++
2 files changed, 799 insertions(+), 1 deletion(-)
create mode 100644 Documentation/kernel-hacking.rst
diff --git a/Documentation/index.rst b/Documentation/index.rst
index 71a276f34c7f..1ed1c4e91c27 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -6,13 +6,16 @@
Welcome to The Linux Kernel's documentation!
============================================
-Nothing for you to see here *yet*. Please move along.
+This is a hacked together set of pages generated from the kernel .tmpl files
+using sphinx. There's lots of glitches and such still - lots of details to work
+out, but at least it's a start.
Contents:
.. toctree::
:maxdepth: 2
+ kernel-hacking
Indices and tables
==================
diff --git a/Documentation/kernel-hacking.rst b/Documentation/kernel-hacking.rst
new file mode 100644
index 000000000000..1b539677db20
--- /dev/null
+++ b/Documentation/kernel-hacking.rst
@@ -0,0 +1,795 @@
+============================================
+Unreliable Guide To Hacking The Linux Kernel
+============================================
+
+:Author: Rusty Russell
+
+Introduction
+============
+
+Welcome, gentle reader, to Rusty's Remarkably Unreliable Guide to Linux
+Kernel Hacking. This document describes the common routines and general
+requirements for kernel code: its goal is to serve as a primer for Linux
+kernel development for experienced C programmers. I avoid implementation
+details: that's what the code is for, and I ignore whole tracts of
+useful routines.
+
+Before you read this, please understand that I never wanted to write
+this document, being grossly under-qualified, but I always wanted to
+read it, and this was the only way. I hope it will grow into a
+compendium of best practice, common starting points and random
+information.
+
+The Players
+===========
+
+At any time each of the CPUs in a system can be:
+
+- not associated with any process, serving a hardware interrupt;
+
+- not associated with any process, serving a softirq or tasklet;
+
+- running in kernel space, associated with a process (user context);
+
+- running a process in user space.
+
+There is an ordering between these. The bottom two can preempt each
+other, but above that is a strict hierarchy: each can only be preempted
+by the ones above it. For example, while a softirq is running on a CPU,
+no other softirq will preempt it, but a hardware interrupt can. However,
+any other CPUs in the system execute independently.
+
+We'll see a number of ways that the user context can block interrupts,
+to become truly non-preemptable.
+
+User Context
+------------
+
+User context is when you are coming in from a system call or other trap:
+like userspace, you can be preempted by more important tasks and by
+interrupts. You can sleep, by calling :c:func:`schedule`.
+
+ **Note**
+
+ You are always in user context on module load and unload, and on
+ operations on the block device layer.
+
+In user context, the ``current`` pointer (indicating the task we are
+currently executing) is valid, and :c:func:`in_interrupt`
+(``include/linux/interrupt.h``) is false.
+
+ **Caution**
+
+ Beware that if you have preemption or softirqs disabled (see below),
+ :c:func:`in_interrupt` will return a false positive.
+
+Hardware Interrupts (Hard IRQs)
+-------------------------------
+
+Timer ticks, network cards and keyboard are examples of real hardware
+which produce interrupts at any time. The kernel runs interrupt
+handlers, which services the hardware. The kernel guarantees that this
+handler is never re-entered: if the same interrupt arrives, it is queued
+(or dropped). Because it disables interrupts, this handler has to be
+fast: frequently it simply acknowledges the interrupt, marks a 'software
+interrupt' for execution and exits.
+
+You can tell you are in a hardware interrupt, because
+:c:func:`in_irq` returns true.
+
+ **Caution**
+
+ Beware that this will return a false positive if interrupts are
+ disabled (see below).
+
+Software Interrupt Context: Softirqs and Tasklets
+-------------------------------------------------
+
+Whenever a system call is about to return to userspace, or a hardware
+interrupt handler exits, any 'software interrupts' which are marked
+pending (usually by hardware interrupts) are run (``kernel/softirq.c``).
+
+Much of the real interrupt handling work is done here. Early in the
+transition to SMP, there were only 'bottom halves' (BHs), which didn't
+take advantage of multiple CPUs. Shortly after we switched from wind-up
+computers made of match-sticks and snot, we abandoned this limitation
+and switched to 'softirqs'.
+
+``include/linux/interrupt.h`` lists the different softirqs. A very
+important softirq is the timer softirq (``include/linux/timer.h``): you
+can register to have it call functions for you in a given length of
+time.
+
+Softirqs are often a pain to deal with, since the same softirq will run
+simultaneously on more than one CPU. For this reason, tasklets
+(``include/linux/interrupt.h``) are more often used: they are
+dynamically-registrable (meaning you can have as many as you want), and
+they also guarantee that any tasklet will only run on one CPU at any
+time, although different tasklets can run simultaneously.
+
+ **Caution**
+
+ The name 'tasklet' is misleading: they have nothing to do with
+ 'tasks', and probably more to do with some bad vodka Alexey
+ Kuznetsov had at the time.
+
+You can tell you are in a softirq (or tasklet) using the
+:c:func:`in_softirq` macro (``include/linux/interrupt.h``).
+
+ **Caution**
+
+ Beware that this will return a false positive if a bh lock (see
+ below) is held.
+
+Some Basic Rules
+================
+
+No memory protection
+ If you corrupt memory, whether in user context or interrupt context,
+ the whole machine will crash. Are you sure you can't do what you
+ want in userspace?
+
+No floating point or MMX
+ The FPU context is not saved; even in user context the FPU state
+ probably won't correspond with the current process: you would mess
+ with some user process' FPU state. If you really want to do this,
+ you would have to explicitly save/restore the full FPU state (and
+ avoid context switches). It is generally a bad idea; use fixed point
+ arithmetic first.
+
+A rigid stack limit
+ Depending on configuration options the kernel stack is about 3K to
+ 6K for most 32-bit architectures: it's about 14K on most 64-bit
+ archs, and often shared with interrupts so you can't use it all.
+ Avoid deep recursion and huge local arrays on the stack (allocate
+ them dynamically instead).
+
+The Linux kernel is portable
+ Let's keep it that way. Your code should be 64-bit clean, and
+ endian-independent. You should also minimize CPU specific stuff,
+ e.g. inline assembly should be cleanly encapsulated and minimized to
+ ease porting. Generally it should be restricted to the
+ architecture-dependent part of the kernel tree.
+
+ioctls: Not writing a new system call
+=====================================
+
+A system call generally looks like this
+
+::
+
+ asmlinkage long sys_mycall(int arg)
+ {
+ return 0;
+ }
+
+
+First, in most cases you don't want to create a new system call. You
+create a character device and implement an appropriate ioctl for it.
+This is much more flexible than system calls, doesn't have to be entered
+in every architecture's ``include/asm/unistd.h`` and
+``arch/kernel/entry.S`` file, and is much more likely to be accepted by
+Linus.
+
+If all your routine does is read or write some parameter, consider
+implementing a :c:func:`sysfs` interface instead.
+
+Inside the ioctl you're in user context to a process. When a error
+occurs you return a negated errno (see ``include/linux/errno.h``),
+otherwise you return 0.
+
+After you slept you should check if a signal occurred: the Unix/Linux
+way of handling signals is to temporarily exit the system call with the
+``-ERESTARTSYS`` error. The system call entry code will switch back to
+user context, process the signal handler and then your system call will
+be restarted (unless the user disabled that). So you should be prepared
+to process the restart, e.g. if you're in the middle of manipulating
+some data structure.
+
+::
+
+ if (signal_pending(current))
+ return -ERESTARTSYS;
+
+
+If you're doing longer computations: first think userspace. If you
+*really* want to do it in kernel you should regularly check if you need
+to give up the CPU (remember there is cooperative multitasking per CPU).
+Idiom:
+
+::
+
+ cond_resched(); /* Will sleep */
+
+
+A short note on interface design: the UNIX system call motto is "Provide
+mechanism not policy".
+
+Recipes for Deadlock
+====================
+
+You cannot call any routines which may sleep, unless:
+
+- You are in user context.
+
+- You do not own any spinlocks.
+
+- You have interrupts enabled (actually, Andi Kleen says that the
+ scheduling code will enable them for you, but that's probably not
+ what you wanted).
+
+Note that some functions may sleep implicitly: common ones are the user
+space access functions (\*_user) and memory allocation functions
+without ``GFP_ATOMIC``.
+
+You should always compile your kernel ``CONFIG_DEBUG_ATOMIC_SLEEP`` on,
+and it will warn you if you break these rules. If you *do* break the
+rules, you will eventually lock up your box.
+
+Really.
+
+Common Routines
+===============
+
+:c:func:`printk` ``include/linux/kernel.h``
+-----------------------------------------------
+
+:c:func:`printk` feeds kernel messages to the console, dmesg, and
+the syslog daemon. It is useful for debugging and reporting errors, and
+can be used inside interrupt context, but use with caution: a machine
+which has its console flooded with printk messages is unusable. It uses
+a format string mostly compatible with ANSI C printf, and C string
+concatenation to give it a first "priority" argument:
+
+::
+
+ printk(KERN_INFO "i = %u\n", i);
+
+
+See ``include/linux/kernel.h``; for other KERN_ values; these are
+interpreted by syslog as the level. Special case: for printing an IP
+address use
+
+::
+
+ __be32 ipaddress;
+ printk(KERN_INFO "my ip: %pI4\n", &ipaddress);
+
+
+:c:func:`printk` internally uses a 1K buffer and does not catch
+overruns. Make sure that will be enough.
+
+ **Note**
+
+ You will know when you are a real kernel hacker when you start
+ typoing printf as printk in your user programs :)
+
+ **Note**
+
+ Another sidenote: the original Unix Version 6 sources had a comment
+ on top of its printf function: "Printf should not be used for
+ chit-chat". You should follow that advice.
+
+:c:func:`copy_[to/from]_user` / :c:func:`get_user` / :c:func:`put_user` ``include/asm/uaccess.h``
+-----------------------------------------------------------------------------------------------------------------
+
+*[SLEEPS]*
+
+:c:func:`put_user` and :c:func:`get_user` are used to get and
+put single values (such as an int, char, or long) from and to userspace.
+A pointer into userspace should never be simply dereferenced: data
+should be copied using these routines. Both return ``-EFAULT`` or 0.
+
+:c:func:`copy_to_user` and :c:func:`copy_from_user` are more
+general: they copy an arbitrary amount of data to and from userspace.
+
+ **Caution**
+
+ Unlike :c:func:`put_user` and :c:func:`get_user`, they
+ return the amount of uncopied data (ie. 0 still means success).
+
+[Yes, this moronic interface makes me cringe. The flamewar comes up
+every year or so. --RR.]
+
+The functions may sleep implicitly. This should never be called outside
+user context (it makes no sense), with interrupts disabled, or a
+spinlock held.
+
+:c:func:`kmalloc`/:c:func:`kfree` ``include/linux/slab.h``
+------------------------------------------------------------------
+
+*[MAY SLEEP: SEE BELOW]*
+
+These routines are used to dynamically request pointer-aligned chunks of
+memory, like malloc and free do in userspace, but :c:func:`kmalloc`
+takes an extra flag word. Important values:
+
+``
+ GFP_KERNEL
+ ``
+ May sleep and swap to free memory. Only allowed in user context, but
+ is the most reliable way to allocate memory.
+
+``
+ GFP_ATOMIC
+ ``
+ Don't sleep. Less reliable than ``GFP_KERNEL``, but may be called
+ from interrupt context. You should *really* have a good
+ out-of-memory error-handling strategy.
+
+``
+ GFP_DMA
+ ``
+ Allocate ISA DMA lower than 16MB. If you don't know what that is you
+ don't need it. Very unreliable.
+
+If you see a sleeping function called from invalid context warning
+message, then maybe you called a sleeping allocation function from
+interrupt context without ``GFP_ATOMIC``. You should really fix that.
+Run, don't walk.
+
+If you are allocating at least ``PAGE_SIZE`` (``include/asm/page.h``)
+bytes, consider using :c:func:`__get_free_pages`
+(``include/linux/mm.h``). It takes an order argument (0 for page sized,
+1 for double page, 2 for four pages etc.) and the same memory priority
+flag word as above.
+
+If you are allocating more than a page worth of bytes you can use
+:c:func:`vmalloc`. It'll allocate virtual memory in the kernel map.
+This block is not contiguous in physical memory, but the MMU makes it
+look like it is for you (so it'll only look contiguous to the CPUs, not
+to external device drivers). If you really need large physically
+contiguous memory for some weird device, you have a problem: it is
+poorly supported in Linux because after some time memory fragmentation
+in a running kernel makes it hard. The best way is to allocate the block
+early in the boot process via the :c:func:`alloc_bootmem` routine.
+
+Before inventing your own cache of often-used objects consider using a
+slab cache in ``include/linux/slab.h``
+
+:c:func:`current` ``include/asm/current.h``
+-----------------------------------------------
+
+This global variable (really a macro) contains a pointer to the current
+task structure, so is only valid in user context. For example, when a
+process makes a system call, this will point to the task structure of
+the calling process. It is *not NULL* in interrupt context.
+
+:c:func:`mdelay`/:c:func:`udelay` ``include/asm/delay.h`` ``include/linux/delay.h``
+-------------------------------------------------------------------------------------------
+
+The :c:func:`udelay` and :c:func:`ndelay` functions can be used
+for small pauses. Do not use large values with them as you risk overflow
+- the helper function :c:func:`mdelay` is useful here, or consider
+:c:func:`msleep`.
+
+:c:func:`cpu_to_be32`/:c:func:`be32_to_cpu`/:c:func:`cpu_to_le32`/:c:func:`le32_to_cpu` ``include/asm/byteorder.h``
+-------------------------------------------------------------------------------------------------------------------------------------------
+
+The :c:func:`cpu_to_be32` family (where the "32" can be replaced
+by 64 or 16, and the "be" can be replaced by "le") are the general way
+to do endian conversions in the kernel: they return the converted value.
+All variations supply the reverse as well: :c:func:`be32_to_cpu`,
+etc.
+
+There are two major variations of these functions: the pointer
+variation, such as :c:func:`cpu_to_be32p`, which take a pointer to
+the given type, and return the converted value. The other variation is
+the "in-situ" family, such as :c:func:`cpu_to_be32s`, which
+convert value referred to by the pointer, and return void.
+
+:c:func:`local_irq_save`/:c:func:`local_irq_restore` ``include/linux/irqflags.h``
+---------------------------------------------------------------------------------------------
+
+These routines disable hard interrupts on the local CPU, and restore
+them. They are reentrant; saving the previous state in their one
+``unsigned long flags`` argument. If you know that interrupts are
+enabled, you can simply use :c:func:`local_irq_disable` and
+:c:func:`local_irq_enable`.
+
+:c:func:`local_bh_disable`/:c:func:`local_bh_enable` ``include/linux/interrupt.h``
+----------------------------------------------------------------------------------------------
+
+These routines disable soft interrupts on the local CPU, and restore
+them. They are reentrant; if soft interrupts were disabled before, they
+will still be disabled after this pair of functions has been called.
+They prevent softirqs and tasklets from running on the current CPU.
+
+:c:func:`smp_processor_id`() ``include/asm/smp.h``
+--------------------------------------------------------
+
+:c:func:`get_cpu` disables preemption (so you won't suddenly get
+moved to another CPU) and returns the current processor number, between
+0 and ``NR_CPUS``. Note that the CPU numbers are not necessarily
+continuous. You return it again with :c:func:`put_cpu` when you are
+done.
+
+If you know you cannot be preempted by another task (ie. you are in
+interrupt context, or have preemption disabled) you can use
+smp_processor_id().
+
+``__init``/``__exit``/``__initdata`` ``include/linux/init.h``
+-------------------------------------------------------------
+
+After boot, the kernel frees up a special section; functions marked with
+``__init`` and data structures marked with ``__initdata`` are dropped
+after boot is complete: similarly modules discard this memory after
+initialization. ``__exit`` is used to declare a function which is only
+required on exit: the function will be dropped if this file is not
+compiled as a module. See the header file for use. Note that it makes no
+sense for a function marked with ``__init`` to be exported to modules
+with :c:func:`EXPORT_SYMBOL` - this will break.
+
+:c:func:`__initcall`/:c:func:`module_init` ``include/linux/init.h``
+------------------------------------------------------------------------------
+
+Many parts of the kernel are well served as a module
+(dynamically-loadable parts of the kernel). Using the
+:c:func:`module_init` and :c:func:`module_exit` macros it is
+easy to write code without #ifdefs which can operate both as a module or
+built into the kernel.
+
+The :c:func:`module_init` macro defines which function is to be
+called at module insertion time (if the file is compiled as a module),
+or at boot time: if the file is not compiled as a module the
+:c:func:`module_init` macro becomes equivalent to
+:c:func:`__initcall`, which through linker magic ensures that the
+function is called on boot.
+
+The function can return a negative error number to cause module loading
+to fail (unfortunately, this has no effect if the module is compiled
+into the kernel). This function is called in user context with
+interrupts enabled, so it can sleep.
+
+:c:func:`module_exit` ``include/linux/init.h``
+---------------------------------------------------
+
+This macro defines the function to be called at module removal time (or
+never, in the case of the file compiled into the kernel). It will only
+be called if the module usage count has reached zero. This function can
+also sleep, but cannot fail: everything must be cleaned up by the time
+it returns.
+
+Note that this macro is optional: if it is not present, your module will
+not be removable (except for 'rmmod -f').
+
+:c:func:`try_module_get`/:c:func:`module_put` ``include/linux/module.h``
+-----------------------------------------------------------------------------------
+
+These manipulate the module usage count, to protect against removal (a
+module also can't be removed if another module uses one of its exported
+symbols: see below). Before calling into module code, you should call
+:c:func:`try_module_get` on that module: if it fails, then the
+module is being removed and you should act as if it wasn't there.
+Otherwise, you can safely enter the module, and call
+:c:func:`module_put` when you're finished.
+
+Most registerable structures have an owner field, such as in the
+:ref:`struct file_operations` structure. Set this field to the
+macro ``THIS_MODULE``.
+
+Wait Queues ``include/linux/wait.h``
+====================================
+
+*[SLEEPS]*
+
+A wait queue is used to wait for someone to wake you up when a certain
+condition is true. They must be used carefully to ensure there is no
+race condition. You declare a ``wait_queue_head_t``, and then processes
+which want to wait for that condition declare a ``wait_queue_t``
+referring to themselves, and place that in the queue.
+
+Declaring
+---------
+
+You declare a ``wait_queue_head_t`` using the
+:c:func:`DECLARE_WAIT_QUEUE_HEAD` macro, or using the
+:c:func:`init_waitqueue_head` routine in your initialization code.
+
+Queuing
+-------
+
+Placing yourself in the waitqueue is fairly complex, because you must
+put yourself in the queue before checking the condition. There is a
+macro to do this: :c:func:`wait_event_interruptible`
+``include/linux/wait.h`` The first argument is the wait queue head, and
+the second is an expression which is evaluated; the macro returns 0 when
+this expression is true, or -ERESTARTSYS if a signal is received. The
+:c:func:`wait_event` version ignores signals.
+
+Waking Up Queued Tasks
+----------------------
+
+Call :c:func:`wake_up` ``include/linux/wait.h``;, which will wake
+up every process in the queue. The exception is if one has
+``TASK_EXCLUSIVE`` set, in which case the remainder of the queue will
+not be woken. There are other variants of this basic function available
+in the same header.
+
+Atomic Operations
+=================
+
+Certain operations are guaranteed atomic on all platforms. The first
+class of operations work on ``atomic_t`` ``include/asm/atomic.h``; this
+contains a signed integer (at least 32 bits long), and you must use
+these functions to manipulate or read atomic_t variables.
+:c:func:`atomic_read` and :c:func:`atomic_set` get and set the
+counter, :c:func:`atomic_add`, :c:func:`atomic_sub`,
+:c:func:`atomic_inc`, :c:func:`atomic_dec`, and
+:c:func:`atomic_dec_and_test` (returns true if it was decremented
+to zero).
+
+Yes. It returns true (i.e. != 0) if the atomic variable is zero.
+
+Note that these functions are slower than normal arithmetic, and so
+should not be used unnecessarily.
+
+The second class of atomic operations is atomic bit operations on an
+``unsigned long``, defined in ``include/linux/bitops.h``. These
+operations generally take a pointer to the bit pattern, and a bit
+number: 0 is the least significant bit. :c:func:`set_bit`,
+:c:func:`clear_bit` and :c:func:`change_bit` set, clear, and
+flip the given bit. :c:func:`test_and_set_bit`,
+:c:func:`test_and_clear_bit` and
+:c:func:`test_and_change_bit` do the same thing, except return
+true if the bit was previously set; these are particularly useful for
+atomically setting flags.
+
+It is possible to call these operations with bit indices greater than
+BITS_PER_LONG. The resulting behavior is strange on big-endian
+platforms though so it is a good idea not to do this.
+
+Symbols
+=======
+
+Within the kernel proper, the normal linking rules apply (ie. unless a
+symbol is declared to be file scope with the ``static`` keyword, it can
+be used anywhere in the kernel). However, for modules, a special
+exported symbol table is kept which limits the entry points to the
+kernel proper. Modules can also export symbols.
+
+:c:func:`EXPORT_SYMBOL` ``include/linux/export.h``
+-------------------------------------------------------
+
+This is the classic method of exporting a symbol: dynamically loaded
+modules will be able to use the symbol as normal.
+
+:c:func:`EXPORT_SYMBOL_GPL` ``include/linux/export.h``
+------------------------------------------------------------
+
+Similar to :c:func:`EXPORT_SYMBOL` except that the symbols exported
+by :c:func:`EXPORT_SYMBOL_GPL` can only be seen by modules with a
+:c:func:`MODULE_LICENSE` that specifies a GPL compatible license.
+It implies that the function is considered an internal implementation
+issue, and not really an interface. Some maintainers and developers may
+however require EXPORT_SYMBOL_GPL() when adding any new APIs or
+functionality.
+
+Routines and Conventions
+========================
+
+Double-linked lists ``include/linux/list.h``
+--------------------------------------------
+
+There used to be three sets of linked-list routines in the kernel
+headers, but this one is the winner. If you don't have some particular
+pressing need for a single list, it's a good choice.
+
+In particular, :c:func:`list_for_each_entry` is useful.
+
+Return Conventions
+------------------
+
+For code called in user context, it's very common to defy C convention,
+and return 0 for success, and a negative error number (eg. -EFAULT) for
+failure. This can be unintuitive at first, but it's fairly widespread in
+the kernel.
+
+Using :c:func:`ERR_PTR` ``include/linux/err.h``; to encode a
+negative error number into a pointer, and :c:func:`IS_ERR` and
+:c:func:`PTR_ERR` to get it back out again: avoids a separate
+pointer parameter for the error number. Icky, but in a good way.
+
+Breaking Compilation
+--------------------
+
+Linus and the other developers sometimes change function or structure
+names in development kernels; this is not done just to keep everyone on
+their toes: it reflects a fundamental change (eg. can no longer be
+called with interrupts on, or does extra checks, or doesn't do checks
+which were caught before). Usually this is accompanied by a fairly
+complete note to the linux-kernel mailing list; search the archive.
+Simply doing a global replace on the file usually makes things *worse*.
+
+Initializing structure members
+------------------------------
+
+The preferred method of initializing structures is to use designated
+initialisers, as defined by ISO C99, eg:
+
+::
+
+ static struct block_device_operations opt_fops = {
+ .open = opt_open,
+ .release = opt_release,
+ .ioctl = opt_ioctl,
+ .check_media_change = opt_media_change,
+ };
+
+
+This makes it easy to grep for, and makes it clear which structure
+fields are set. You should do this because it looks cool.
+
+GNU Extensions
+--------------
+
+GNU Extensions are explicitly allowed in the Linux kernel. Note that
+some of the more complex ones are not very well supported, due to lack
+of general use, but the following are considered standard (see the GCC
+info page section "C Extensions" for more details - Yes, really the info
+page, the man page is only a short summary of the stuff in info).
+
+- Inline functions
+
+- Statement expressions (ie. the ({ and }) constructs).
+
+- Declaring attributes of a function / variable / type
+ (__attribute__)
+
+- typeof
+
+- Zero length arrays
+
+- Macro varargs
+
+- Arithmetic on void pointers
+
+- Non-Constant initializers
+
+- Assembler Instructions (not outside arch/ and include/asm/)
+
+- Function names as strings (__func__).
+
+- __builtin_constant_p()
+
+Be wary when using long long in the kernel, the code gcc generates for
+it is horrible and worse: division and multiplication does not work on
+i386 because the GCC runtime functions for it are missing from the
+kernel environment.
+
+C++
+---
+
+Using C++ in the kernel is usually a bad idea, because the kernel does
+not provide the necessary runtime environment and the include files are
+not tested for it. It is still possible, but not recommended. If you
+really want to do this, forget about exceptions at least.
+
+#if
+---
+
+It is generally considered cleaner to use macros in header files (or at
+the top of .c files) to abstract away functions rather than using \`#if'
+pre-processor statements throughout the source code.
+
+Putting Your Stuff in the Kernel
+================================
+
+In order to get your stuff into shape for official inclusion, or even to
+make a neat patch, there's administrative work to be done:
+
+- Figure out whose pond you've been pissing in. Look at the top of the
+ source files, inside the ``MAINTAINERS`` file, and last of all in the
+ ``CREDITS`` file. You should coordinate with this person to make sure
+ you're not duplicating effort, or trying something that's already
+ been rejected.
+
+ Make sure you put your name and EMail address at the top of any files
+ you create or mangle significantly. This is the first place people
+ will look when they find a bug, or when *they* want to make a change.
+
+- Usually you want a configuration option for your kernel hack. Edit
+ ``Kconfig`` in the appropriate directory. The Config language is
+ simple to use by cut and paste, and there's complete documentation in
+ ``Documentation/kbuild/kconfig-language.txt``.
+
+ In your description of the option, make sure you address both the
+ expert user and the user who knows nothing about your feature.
+ Mention incompatibilities and issues here. *Definitely* end your
+ description with “if in doubt, say N” (or, occasionally, \`Y'); this
+ is for people who have no idea what you are talking about.
+
+- Edit the ``Makefile``: the CONFIG variables are exported here so you
+ can usually just add a "obj-$(CONFIG_xxx) += xxx.o" line. The syntax
+ is documented in ``Documentation/kbuild/makefiles.txt``.
+
+- Put yourself in ``CREDITS`` if you've done something noteworthy,
+ usually beyond a single file (your name should be at the top of the
+ source files anyway). ``MAINTAINERS`` means you want to be consulted
+ when changes are made to a subsystem, and hear about bugs; it implies
+ a more-than-passing commitment to some part of the code.
+
+- Finally, don't forget to read ``Documentation/SubmittingPatches`` and
+ possibly ``Documentation/SubmittingDrivers``.
+
+Kernel Cantrips
+===============
+
+Some favorites from browsing the source. Feel free to add to this list.
+
+``arch/x86/include/asm/delay.h:``
+
+::
+
+ #define ndelay(n) (__builtin_constant_p(n) ? \
+ ((n) > 20000 ? __bad_ndelay() : __const_udelay((n) * 5ul)) : \
+ __ndelay(n))
+
+
+``include/linux/fs.h``:
+
+::
+
+ /*
+ * Kernel pointers have redundant information, so we can use a
+ * scheme where we can return either an error code or a dentry
+ * pointer with the same return value.
+ *
+ * This should be a per-architecture thing, to allow different
+ * error and pointer decisions.
+ */
+ #define ERR_PTR(err) ((void *)((long)(err)))
+ #define PTR_ERR(ptr) ((long)(ptr))
+ #define IS_ERR(ptr) ((unsigned long)(ptr) > (unsigned long)(-1000))
+
+``arch/x86/include/asm/uaccess_32.h:``
+
+::
+
+ #define copy_to_user(to,from,n) \
+ (__builtin_constant_p(n) ? \
+ __constant_copy_to_user((to),(from),(n)) : \
+ __generic_copy_to_user((to),(from),(n)))
+
+
+``arch/sparc/kernel/head.S:``
+
+::
+
+ /*
+ * Sun people can't spell worth damn. "compatability" indeed.
+ * At least we *know* we can't spell, and use a spell-checker.
+ */
+
+ /* Uh, actually Linus it is I who cannot spell. Too much murky
+ * Sparc assembly will do this to ya.
+ */
+ C_LABEL(cputypvar):
+ .asciz "compatibility"
+
+ /* Tested on SS-5, SS-10. Probably someone at Sun applied a spell-checker. */
+ .align 4
+ C_LABEL(cputypvar_sun4m):
+ .asciz "compatible"
+
+
+``arch/sparc/lib/checksum.S:``
+
+::
+
+ /* Sun, you just can't beat me, you just can't. Stop trying,
+ * give up. I'm serious, I am going to kick the living shit
+ * out of you, game over, lights out.
+ */
+
+
+Thanks
+======
+
+Thanks to Andi Kleen for the idea, answering my questions, fixing my
+mistakes, filling content, etc. Philipp Rumpf for more spelling and
+clarity fixes, and some excellent non-obvious points. Werner Almesberger
+for giving me a great summary of :c:func:`disable_irq`, and Jes
+Sorensen and Andrea Arcangeli added caveats. Michael Elizabeth Chastain
+for checking and adding to the Configure section. Telsa Gwynne for
+teaching me DocBook.
--
2.1.4
[toc] | [prev] | [next] | [standalone]
| From | Jani Nikula <jani.nikula@intel.com> |
|---|---|
| Date | 2016-05-20 15:50 +0200 |
| Subject | [PATCH 03/10] Documentation/sphinx: add basic working Sphinx configuration and build |
| Message-ID | <rASYp-68P-11@gated-at.bofh.it> |
| In reply to | #1404432 |
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 run on the
various 'make *docs' targets.
All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.
There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.
If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.
Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.
Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.
This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
---
Documentation/DocBook/Makefile | 7 +-
Documentation/Makefile.sphinx | 61 +++++++
Documentation/conf.py | 378 +++++++++++++++++++++++++++++++++++++++++
Documentation/index.rst | 23 +++
Makefile | 5 +-
5 files changed, 469 insertions(+), 5 deletions(-)
create mode 100644 Documentation/Makefile.sphinx
create mode 100644 Documentation/conf.py
create mode 100644 Documentation/index.rst
diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile
index d70f9b68174e..e0c7e1e0590b 100644
--- a/Documentation/DocBook/Makefile
+++ b/Documentation/DocBook/Makefile
@@ -33,10 +33,6 @@ PDF_METHOD = $(prefer-db2x)
PS_METHOD = $(prefer-db2x)
-###
-# The targets that may be used.
-PHONY += xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs cleandocs
-
targets += $(DOCBOOKS)
BOOKS := $(addprefix $(obj)/,$(DOCBOOKS))
xmldocs: $(BOOKS)
@@ -63,6 +59,9 @@ installmandocs: mandocs
sort -k 2 -k 1 | uniq -f 1 | sed -e 's: :/:' | \
xargs install -m 644 -t /usr/local/man/man9/
+# no-op for the DocBook toolchain
+epubdocs:
+
###
#External programs used
KERNELDOCXMLREF = $(srctree)/scripts/kernel-doc-xml-ref
diff --git a/Documentation/Makefile.sphinx b/Documentation/Makefile.sphinx
new file mode 100644
index 000000000000..25a7970bfe5c
--- /dev/null
+++ b/Documentation/Makefile.sphinx
@@ -0,0 +1,61 @@
+# -*- makefile -*-
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXBUILD = sphinx-build
+SPHINXOPTS =
+PAPER =
+BUILDDIR = $(obj)/output
+
+# User-friendly check for sphinx-build
+HAVE_SPHINX := $(shell if which $(SPHINXBUILD) >/dev/null 2>&1; then echo 1; else echo 0; fi)
+
+ifeq ($(HAVE_SPHINX),0)
+
+.DEFAULT:
+ $(warning The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed and in PATH, or set the SPHINXBUILD make variable to point to the full path of the '$(SPHINXBUILD)' executable.)
+ @echo " SKIP Sphinx $@ target."
+
+else # HAVE_SPHINX
+
+# User-friendly check for rst2pdf
+HAVE_RST2PDF := $(shell if python -c "import rst2pdf" >/dev/null 2>&1; then echo 1; else echo 0; fi)
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/.doctrees $(PAPEROPT_$(PAPER)) -c $(srctree)/$(src) $(SPHINXOPTS) $(srctree)/$(src)
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+quiet_cmd_sphinx = SPHINX $@
+ cmd_sphinx = $(SPHINXBUILD) -b $2 $(ALLSPHINXOPTS) $(BUILDDIR)/$2
+
+htmldocs:
+ $(call cmd,sphinx,html)
+
+pdfdocs:
+ifeq ($(HAVE_RST2PDF),0)
+ $(warning The Python 'rst2pdf' module was not found. Make sure you have the module installed to produce PDF output.)
+ @echo " SKIP Sphinx $@ target."
+else # HAVE_RST2PDF
+ $(call cmd,sphinx,pdf)
+endif # HAVE_RST2PDF
+
+epubdocs:
+ $(call cmd,sphinx,epub)
+
+xmldocs:
+ $(call cmd,sphinx,xml)
+
+# no-ops for the Sphinx toolchain
+sgmldocs:
+psdocs:
+mandocs:
+installmandocs:
+
+cleandocs:
+ $(Q)rm -rf $(BUILDDIR)
+
+endif # HAVE_SPHINX
diff --git a/Documentation/conf.py b/Documentation/conf.py
new file mode 100644
index 000000000000..ff86f5e88049
--- /dev/null
+++ b/Documentation/conf.py
@@ -0,0 +1,378 @@
+# -*- coding: utf-8 -*-
+#
+# The Linux Kernel documentation build configuration file, created by
+# sphinx-quickstart on Fri Feb 12 13:51:46 2016.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys
+import os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = []
+
+# Gracefully handle missing rst2pdf.
+try:
+ import rst2pdf
+ extensions += ['rst2pdf.pdfbuilder']
+except ImportError:
+ pass
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'The Linux Kernel'
+copyright = '2016, The kernel development community'
+author = 'The kernel development community'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '4.5'
+# The full version, including alpha/beta/rc tags.
+release = '4.5'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['output']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+primary_domain = 'C'
+highlight_language = 'C'
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+
+# The Read the Docs theme is available from
+# - https://github.com/snide/sphinx_rtd_theme
+# - https://pypi.python.org/pypi/sphinx_rtd_theme
+# - python-sphinx-rtd-theme package (on Debian)
+try:
+ import sphinx_rtd_theme
+ html_theme = 'sphinx_rtd_theme'
+ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+except ImportError:
+ sys.stderr.write('Warning: The Sphinx \'sphinx_rtd_theme\' HTML theme was not found. Make sure you have the theme installed to produce pretty HTML output. Falling back to the default theme.\n')
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+#html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
+# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
+#html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# Now only 'ja' uses this config value
+#html_search_options = {'type': 'default'}
+
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+#html_search_scorer = 'scorer.js'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'TheLinuxKerneldoc'
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+
+# Latex figure (float) alignment
+#'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+# author, documentclass [howto, manual, or own class]).
+latex_documents = [
+ (master_doc, 'TheLinuxKernel.tex', 'The Linux Kernel Documentation',
+ 'The kernel development community', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ (master_doc, 'thelinuxkernel', 'The Linux Kernel Documentation',
+ [author], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ (master_doc, 'TheLinuxKernel', 'The Linux Kernel Documentation',
+ author, 'TheLinuxKernel', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False
+
+
+# -- Options for Epub output ----------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+epub_author = author
+epub_publisher = author
+epub_copyright = copyright
+
+# The basename for the epub file. It defaults to the project name.
+#epub_basename = project
+
+# The HTML theme for the epub output. Since the default themes are not
+# optimized for small screen space, using the same theme for HTML and epub
+# output is usually not wise. This defaults to 'epub', a theme designed to save
+# visual space.
+#epub_theme = 'epub'
+
+# The language of the text. It defaults to the language option
+# or 'en' if the language is not set.
+#epub_language = ''
+
+# The scheme of the identifier. Typical schemes are ISBN or URL.
+#epub_scheme = ''
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#epub_identifier = ''
+
+# A unique identification for the text.
+#epub_uid = ''
+
+# A tuple containing the cover image and cover page html template filenames.
+#epub_cover = ()
+
+# A sequence of (type, uri, title) tuples for the guide element of content.opf.
+#epub_guide = ()
+
+# HTML files that should be inserted before the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_pre_files = []
+
+# HTML files that should be inserted after the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_post_files = []
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+# The depth of the table of contents in toc.ncx.
+#epub_tocdepth = 3
+
+# Allow duplicate toc entries.
+#epub_tocdup = True
+
+# Choose between 'default' and 'includehidden'.
+#epub_tocscope = 'default'
+
+# Fix unsupported image types using the Pillow.
+#epub_fix_images = False
+
+# Scale large images.
+#epub_max_image_width = 0
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#epub_show_urls = 'inline'
+
+# If false, no index is generated.
+#epub_use_index = True
+
+#=======
+# rst2pdf
+pdf_documents = [
+ ('index', u'Kernel', u'Kernel', u'J. Random Bozo'),
+]
diff --git a/Documentation/index.rst b/Documentation/index.rst
new file mode 100644
index 000000000000..71a276f34c7f
--- /dev/null
+++ b/Documentation/index.rst
@@ -0,0 +1,23 @@
+.. The Linux Kernel documentation master file, created by
+ sphinx-quickstart on Fri Feb 12 13:51:46 2016.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to The Linux Kernel's documentation!
+============================================
+
+Nothing for you to see here *yet*. Please move along.
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
diff --git a/Makefile b/Makefile
index 0f9cb36d45c2..85b3d1049054 100644
--- a/Makefile
+++ b/Makefile
@@ -1385,8 +1385,11 @@ $(help-board-dirs): help-%:
# Documentation targets
# ---------------------------------------------------------------------------
-%docs: scripts_basic FORCE
+DOC_TARGETS := xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs epubdocs cleandocs
+PHONY += $(DOC_TARGETS)
+$(DOC_TARGETS): scripts_basic FORCE
$(Q)$(MAKE) $(build)=scripts build_docproc build_check-lc_ctype
+ $(Q)$(MAKE) $(build)=Documentation -f $(srctree)/Documentation/Makefile.sphinx $@
$(Q)$(MAKE) $(build)=Documentation/DocBook $@
else # KBUILD_EXTMOD
--
2.1.4
[toc] | [prev] | [next] | [standalone]
| From | Jani Nikula <jani.nikula@intel.com> |
|---|---|
| Date | 2016-05-20 15:50 +0200 |
| Subject | [PATCH 09/10] Documentation: add kernel api rst |
| Message-ID | <rASYp-68P-9@gated-at.bofh.it> |
| In reply to | #1404432 |
Crude conversion. This one uses kernel-doc.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
---
Documentation/index.rst | 1 +
Documentation/kernel-api.rst | 419 +++++++++++++++++++++++++++++++++++++++++++
2 files changed, 420 insertions(+)
create mode 100644 Documentation/kernel-api.rst
diff --git a/Documentation/index.rst b/Documentation/index.rst
index 1ed1c4e91c27..6ca68ef5c89a 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -16,6 +16,7 @@ Contents:
:maxdepth: 2
kernel-hacking
+ kernel-api
Indices and tables
==================
diff --git a/Documentation/kernel-api.rst b/Documentation/kernel-api.rst
new file mode 100644
index 000000000000..ac24d8c2461f
--- /dev/null
+++ b/Documentation/kernel-api.rst
@@ -0,0 +1,419 @@
+====================
+The Linux Kernel API
+====================
+
+Data Types
+==========
+
+Doubly Linked Lists
+-------------------
+
+.. kernel-doc:: include/linux/list.h
+ :internal:
+
+Basic C Library Functions
+=========================
+
+When writing drivers, you cannot in general use routines which are from
+the C Library. Some of the functions have been found generally useful
+and they are listed below. The behaviour of these functions may vary
+slightly from those defined by ANSI, and these deviations are noted in
+the text.
+
+String Conversions
+------------------
+
+.. kernel-doc:: lib/vsprintf.c
+ :export:
+
+.. kernel-doc:: include/linux/kernel.h
+ :functions: kstrtol
+
+.. kernel-doc:: include/linux/kernel.h
+ :functions: kstrtoul
+
+.. kernel-doc:: lib/kstrtox.c
+ :export:
+
+String Manipulation
+-------------------
+
+.. kernel-doc:: lib/string.c
+ :export:
+
+Bit Operations
+--------------
+
+.. kernel-doc:: arch/x86/include/asm/bitops.h
+ :internal:
+
+Basic Kernel Library Functions
+==============================
+
+The Linux kernel provides more basic utility functions.
+
+Bitmap Operations
+-----------------
+
+.. kernel-doc:: lib/bitmap.c
+ :export:
+
+.. kernel-doc:: lib/bitmap.c
+ :internal:
+
+Command-line Parsing
+--------------------
+
+.. kernel-doc:: lib/cmdline.c
+ :export:
+
+CRC Functions
+-------------
+
+.. kernel-doc:: lib/crc7.c
+ :export:
+
+.. kernel-doc:: lib/crc16.c
+ :export:
+
+.. kernel-doc:: lib/crc-itu-t.c
+ :export:
+
+.. kernel-doc:: lib/crc32.c
+ :export:
+
+.. kernel-doc:: lib/crc-ccitt.c
+ :export:
+
+idr/ida Functions
+-----------------
+
+.. kernel-doc:: include/linux/idr.h
+ :doc: idr sync
+
+.. kernel-doc:: lib/idr.c
+ :doc: IDA description
+
+.. kernel-doc:: lib/idr.c
+ :export:
+
+Memory Management in Linux
+==========================
+
+The Slab Cache
+--------------
+
+.. kernel-doc:: include/linux/slab.h
+ :internal:
+
+.. kernel-doc:: mm/slab.c
+ :export:
+
+.. kernel-doc:: mm/util.c
+ :export:
+
+User Space Memory Access
+------------------------
+
+.. kernel-doc:: arch/x86/include/asm/uaccess_32.h
+ :internal:
+
+.. kernel-doc:: arch/x86/lib/usercopy_32.c
+ :export:
+
+More Memory Management Functions
+--------------------------------
+
+.. kernel-doc:: mm/readahead.c
+ :export:
+
+.. kernel-doc:: mm/filemap.c
+ :export:
+
+.. kernel-doc:: mm/memory.c
+ :export:
+
+.. kernel-doc:: mm/vmalloc.c
+ :export:
+
+.. kernel-doc:: mm/page_alloc.c
+ :internal:
+
+.. kernel-doc:: mm/mempool.c
+ :export:
+
+.. kernel-doc:: mm/dmapool.c
+ :export:
+
+.. kernel-doc:: mm/page-writeback.c
+ :export:
+
+.. kernel-doc:: mm/truncate.c
+ :export:
+
+Kernel IPC facilities
+=====================
+
+IPC utilities
+-------------
+
+.. kernel-doc:: ipc/util.c
+ :internal:
+
+FIFO Buffer
+===========
+
+kfifo interface
+---------------
+
+.. kernel-doc:: include/linux/kfifo.h
+ :internal:
+
+relay interface support
+=======================
+
+Relay interface support is designed to provide an efficient mechanism
+for tools and facilities to relay large amounts of data from kernel
+space to user space.
+
+relay interface
+---------------
+
+.. kernel-doc:: kernel/relay.c
+ :export:
+
+.. kernel-doc:: kernel/relay.c
+ :internal:
+
+Module Support
+==============
+
+Module Loading
+--------------
+
+.. kernel-doc:: kernel/kmod.c
+ :export:
+
+Inter Module support
+--------------------
+
+Refer to the file kernel/module.c for more information.
+
+Hardware Interfaces
+===================
+
+Interrupt Handling
+------------------
+
+.. kernel-doc:: kernel/irq/manage.c
+ :export:
+
+DMA Channels
+------------
+
+.. kernel-doc:: kernel/dma.c
+ :export:
+
+Resources Management
+--------------------
+
+.. kernel-doc:: kernel/resource.c
+ :internal:
+
+.. kernel-doc:: kernel/resource.c
+ :export:
+
+MTRR Handling
+-------------
+
+.. kernel-doc:: arch/x86/kernel/cpu/mtrr/main.c
+ :export:
+
+PCI Support Library
+-------------------
+
+.. kernel-doc:: drivers/pci/pci.c
+ :export:
+
+.. kernel-doc:: drivers/pci/pci-driver.c
+ :export:
+
+.. kernel-doc:: drivers/pci/remove.c
+ :export:
+
+.. kernel-doc:: drivers/pci/search.c
+ :export:
+
+.. kernel-doc:: drivers/pci/msi.c
+ :export:
+
+.. kernel-doc:: drivers/pci/bus.c
+ :export:
+
+.. kernel-doc:: drivers/pci/access.c
+ :export:
+
+.. kernel-doc:: drivers/pci/irq.c
+ :export:
+
+.. kernel-doc:: drivers/pci/htirq.c
+ :export:
+
+.. kernel-doc:: drivers/pci/probe.c
+ :export:
+
+.. kernel-doc:: drivers/pci/slot.c
+ :export:
+
+.. kernel-doc:: drivers/pci/rom.c
+ :export:
+
+.. kernel-doc:: drivers/pci/iov.c
+ :export:
+
+.. kernel-doc:: drivers/pci/pci-sysfs.c
+ :internal:
+
+PCI Hotplug Support Library
+---------------------------
+
+.. kernel-doc:: drivers/pci/hotplug/pci_hotplug_core.c
+ :export:
+
+Firmware Interfaces
+===================
+
+DMI Interfaces
+--------------
+
+.. kernel-doc:: drivers/firmware/dmi_scan.c
+ :export:
+
+EDD Interfaces
+--------------
+
+.. kernel-doc:: drivers/firmware/edd.c
+ :internal:
+
+Security Framework
+==================
+
+.. kernel-doc:: security/security.c
+ :internal:
+
+.. kernel-doc:: security/inode.c
+ :export:
+
+Audit Interfaces
+================
+
+.. kernel-doc:: kernel/audit.c
+ :export:
+
+.. kernel-doc:: kernel/auditsc.c
+ :internal:
+
+.. kernel-doc:: kernel/auditfilter.c
+ :internal:
+
+Accounting Framework
+====================
+
+.. kernel-doc:: kernel/acct.c
+ :internal:
+
+Block Devices
+=============
+
+.. kernel-doc:: block/blk-core.c
+ :export:
+
+.. kernel-doc:: block/blk-core.c
+ :internal:
+
+.. kernel-doc:: block/blk-map.c
+ :export:
+
+.. kernel-doc:: block/blk-sysfs.c
+ :internal:
+
+.. kernel-doc:: block/blk-settings.c
+ :export:
+
+.. kernel-doc:: block/blk-exec.c
+ :export:
+
+.. kernel-doc:: block/blk-flush.c
+ :export:
+
+.. kernel-doc:: block/blk-lib.c
+ :export:
+
+.. kernel-doc:: block/blk-tag.c
+ :export:
+
+.. kernel-doc:: block/blk-tag.c
+ :internal:
+
+.. kernel-doc:: block/blk-integrity.c
+ :export:
+
+.. kernel-doc:: kernel/trace/blktrace.c
+ :internal:
+
+.. kernel-doc:: block/genhd.c
+ :internal:
+
+.. kernel-doc:: block/genhd.c
+ :export:
+
+Char devices
+============
+
+.. kernel-doc:: fs/char_dev.c
+ :export:
+
+Miscellaneous Devices
+=====================
+
+.. kernel-doc:: drivers/char/misc.c
+ :export:
+
+Clock Framework
+===============
+
+The clock framework defines programming interfaces to support software
+management of the system clock tree. This framework is widely used with
+System-On-Chip (SOC) platforms to support power management and various
+devices which may need custom clock rates. Note that these "clocks"
+don't relate to timekeeping or real time clocks (RTCs), each of which
+have separate frameworks. These :ref:`struct clk` instances may be
+used to manage for example a 96 MHz signal that is used to shift bits
+into and out of peripherals or busses, or otherwise trigger synchronous
+state machine transitions in system hardware.
+
+Power management is supported by explicit software clock gating: unused
+clocks are disabled, so the system doesn't waste power changing the
+state of transistors that aren't in active use. On some systems this may
+be backed by hardware clock gating, where clocks are gated without being
+disabled in software. Sections of chips that are powered but not clocked
+may be able to retain their last state. This low power state is often
+called a *retention mode*. This mode still incurs leakage currents,
+especially with finer circuit geometries, but for CMOS circuits power is
+mostly used by clocked state changes.
+
+Power-aware drivers only enable their clocks when the device they manage
+is in active use. Also, system sleep states often differ according to
+which clock domains are active: while a "standby" state may allow wakeup
+from several active domains, a "mem" (suspend-to-RAM) state may require
+a more wholesale shutdown of clocks derived from higher speed PLLs and
+oscillators, limiting the number of possible wakeup event sources. A
+driver's suspend method may need to be aware of system-specific clock
+constraints on the target sleep state.
+
+Some platforms support programmable clock generators. These can be used
+by external chips of various kinds, such as other CPUs, multimedia
+codecs, and devices with strict requirements for interface clocking.
+
+.. kernel-doc:: include/linux/clk.h
+ :internal:
--
2.1.4
[toc] | [prev] | [next] | [standalone]
| From | Jani Nikula <jani.nikula@intel.com> |
|---|---|
| Date | 2016-05-20 15:50 +0200 |
| Subject | [PATCH 04/10] Documentation: add .gitignore |
| Message-ID | <rASYp-68P-21@gated-at.bofh.it> |
| In reply to | #1404432 |
The Sphinx output directory is generated. Signed-off-by: Jani Nikula <jani.nikula@intel.com> --- 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 000000000000..53752db253e3 --- /dev/null +++ b/Documentation/.gitignore @@ -0,0 +1 @@ +output -- 2.1.4
[toc] | [prev] | [next] | [standalone]
| From | Jani Nikula <jani.nikula@intel.com> |
|---|---|
| Date | 2016-05-20 15:50 +0200 |
| Subject | [PATCH 02/10] kernel-doc: support printing exported and non-exported symbols |
| Message-ID | <rASYp-68P-25@gated-at.bofh.it> |
| In reply to | #1404432 |
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* may have been in different files. However
for more than ten years the recommendation in CodingStyle has been to
place the EXPORT_SYMBOL* immediately after the closing function brace
line.
Additionally, the kernel-doc comments for functions are generally placed
above the function definition in the .c files (i.e. where the
EXPORT_SYMBOL* is) rather than above the declaration in the .h
files. There are some exceptions to this, but AFAICT none of these are
included in DocBook documentation using the "!E" docproc directive.
Therefore, assuming the EXPORT_SYMBOL* and kernel-doc are with the
function definition, kernel-doc can extract the exported vs. not
information by making two passes on the input file. Add support for that
via the new -export and -internal parameters.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
---
scripts/kernel-doc | 29 +++++++++++++++++++++++++++--
1 file changed, 27 insertions(+), 2 deletions(-)
diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index babb374c043d..0e4109bcaa41 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -59,6 +59,12 @@ Output format selection (mutually exclusive):
-text Output plain text format.
Output selection (mutually exclusive):
+ -export Only output documentation for symbols that have been
+ exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()
+ in the same FILE.
+ -internal Only output documentation for symbols that have NOT been
+ exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()
+ in the same FILE.
-function NAME Only output documentation for the given function(s)
or DOC: section title(s). All other functions and DOC:
sections are ignored. May be specified multiple times.
@@ -380,6 +386,7 @@ my $doc_block = $doc_com . 'DOC:\s*(.*)?';
my $doc_split_start = '^\s*/\*\*\s*$';
my $doc_split_sect = '\s*\*\s*(@[\w\s]+):(.*)';
my $doc_split_end = '^\s*\*/\s*$';
+my $export_symbol = '^\s*EXPORT_SYMBOL(_GPL)?\s*\(\s*(\w+)\s*\)\s*;';
my %constants;
my %parameterdescs;
@@ -444,6 +451,12 @@ while ($ARGV[0] =~ m/^-(.*)/) {
$function_only = 2;
$function = shift @ARGV;
$function_table{$function} = 1;
+ } elsif ($cmd eq "-export") { # only exported symbols
+ $function_only = 3;
+ %function_table = ()
+ } elsif ($cmd eq "-internal") { # only non-exported symbols
+ $function_only = 4;
+ %function_table = ()
} elsif ($cmd eq "-v") {
$verbose = 1;
} elsif (($cmd eq "-h") || ($cmd eq "--help")) {
@@ -1971,8 +1984,10 @@ sub output_declaration {
my $functype = shift;
my $func = "output_${functype}_$output_mode";
if (($function_only==0) ||
- ( $function_only == 1 && defined($function_table{$name})) ||
- ( $function_only == 2 && !($functype eq "function" && defined($function_table{$name}))))
+ ( ($function_only == 1 || $function_only == 3) &&
+ defined($function_table{$name})) ||
+ ( ($function_only == 2 || $function_only == 4) &&
+ !($functype eq "function" && defined($function_table{$name}))))
{
&$func(@_);
$section_counter++;
@@ -2677,6 +2692,16 @@ sub process_file($) {
$. = 1;
+ # two passes for -export and -internal
+ if ($function_only == 3 || $function_only == 4) {
+ while (<IN>) {
+ if (/$export_symbol/o) {
+ $function_table{$2} = 1;
+ }
+ }
+ seek(IN, 0, 0);
+ }
+
$section_counter = 0;
while (<IN>) {
while (s/\\\s*$//) {
--
2.1.4
[toc] | [prev] | [next] | [standalone]
| From | Jani Nikula <jani.nikula@intel.com> |
|---|---|
| Date | 2016-05-20 15:50 +0200 |
| Subject | [PATCH 05/10] Documentation/sphinx: add Sphinx kernel-doc directive extension |
| Message-ID | <rASYp-68P-27@gated-at.bofh.it> |
| In reply to | #1404432 |
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: SECTION TITLE
Of the directive options export, internal, functions, and doc, currently
only one option may be given at a time.
The FILENAME is relative from the kernel source tree root.
The extension notifies Sphinx about the document dependency on FILENAME,
causing the document to be rebuilt when the file has been changed.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
---
Documentation/sphinx/kernel-doc.py | 99 ++++++++++++++++++++++++++++++++++++++
1 file changed, 99 insertions(+)
create mode 100644 Documentation/sphinx/kernel-doc.py
diff --git a/Documentation/sphinx/kernel-doc.py b/Documentation/sphinx/kernel-doc.py
new file mode 100644
index 000000000000..21f61373daf0
--- /dev/null
+++ b/Documentation/sphinx/kernel-doc.py
@@ -0,0 +1,99 @@
+# coding=utf-8
+#
+# Copyright © 2016 Intel Corporation
+#
+# Permission is hereby granted, free of charge, to any person obtaining a
+# copy of this software and associated documentation files (the "Software"),
+# to deal in the Software without restriction, including without limitation
+# the rights to use, copy, modify, merge, publish, distribute, sublicense,
+# and/or sell copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice (including the next
+# paragraph) shall be included in all copies or substantial portions of the
+# Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+#
+# Authors:
+# Jani Nikula <jani.nikula@intel.com>
+
+import os
+import subprocess
+import sys
+
+from docutils import nodes, statemachine
+from docutils.parsers.rst import directives
+from sphinx.util.compat import Directive
+
+class KernelDocDirective(Directive):
+ """Extract kernel-doc comments from the specified file"""
+ required_argument = 1
+ optional_arguments = 4
+ option_spec = {
+ 'doc': directives.unchanged_required,
+ 'functions': directives.unchanged_required,
+ 'export': directives.flag,
+ 'internal': directives.flag,
+ }
+ has_content = False
+
+ def run(self):
+ env = self.state.document.settings.env
+ cmd = [env.config.kerneldoc_bin, '-rst']
+
+ filename = env.config.kerneldoc_srctree + '/' + self.arguments[0]
+
+ # Tell sphinx of the dependency
+ env.note_dependency(os.path.abspath(filename))
+
+ tab_width = self.options.get('tab-width', self.state.document.settings.tab_width)
+ source = self.state_machine.input_lines.source(self.lineno - self.state_machine.input_offset - 1)
+
+ # FIXME: make this nicer and more robust against errors
+ if 'export' in self.options:
+ cmd += ['-export']
+ elif 'internal' in self.options:
+ cmd += ['-internal']
+ elif 'doc' in self.options:
+ cmd += ['-function', str(self.options.get('doc'))]
+ elif 'functions' in self.options:
+ for f in str(self.options.get('functions')).split(' '):
+ cmd += ['-function', f]
+
+ cmd += [filename]
+
+ try:
+ env.app.verbose('calling kernel-doc \'%s\'' % (" ".join(cmd)))
+
+ p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+ out, err = p.communicate()
+
+ if p.returncode != 0:
+ sys.stderr.write(err)
+
+ env.app.warn('kernel-doc \'%s\' failed with return code %d' % (" ".join(cmd), p.returncode))
+ return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))]
+ elif env.config.kerneldoc_verbosity > 0:
+ sys.stderr.write(err)
+
+ lines = statemachine.string2lines(out, tab_width, convert_whitespace=True)
+ self.state_machine.insert_input(lines, source)
+ return []
+ except Exception as e:
+ env.app.warn('kernel-doc \'%s\' processing failed with: %s' %
+ (" ".join(cmd), str(e)))
+ return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))]
+
+def setup(app):
+ app.add_config_value('kerneldoc_bin', None, 'env')
+ app.add_config_value('kerneldoc_srctree', None, 'env')
+ app.add_config_value('kerneldoc_verbosity', 1, 'env')
+
+ app.add_directive('kernel-doc', KernelDocDirective)
--
2.1.4
[toc] | [prev] | [next] | [standalone]
| From | Jani Nikula <jani.nikula@intel.com> |
|---|---|
| Date | 2016-05-20 15:50 +0200 |
| Subject | [PATCH 06/10] Documentation/sphinx: configure the kernel-doc extension |
| Message-ID | <rASYp-68P-23@gated-at.bofh.it> |
| In reply to | #1404432 |
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 kernel-doc extension
configuration on the command line. For example, 'make SPHINXOPTS="-D
kerneldoc_verbosity=0" htmldocs' silences all stderr output from
kernel-doc when the kernel-doc exit code is 0. (The stderr will be
logged unconditionally when the exit code is non-zero.)
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
---
Documentation/Makefile.sphinx | 4 +++-
Documentation/conf.py | 10 ++++++++--
2 files changed, 11 insertions(+), 3 deletions(-)
diff --git a/Documentation/Makefile.sphinx b/Documentation/Makefile.sphinx
index 25a7970bfe5c..8a662be9bd87 100644
--- a/Documentation/Makefile.sphinx
+++ b/Documentation/Makefile.sphinx
@@ -25,7 +25,9 @@ HAVE_RST2PDF := $(shell if python -c "import rst2pdf" >/dev/null 2>&1; then echo
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS = -d $(BUILDDIR)/.doctrees $(PAPEROPT_$(PAPER)) -c $(srctree)/$(src) $(SPHINXOPTS) $(srctree)/$(src)
+KERNELDOC = $(srctree)/scripts/kernel-doc
+KERNELDOC_CONF = -D kerneldoc_srctree=$(srctree) -D kerneldoc_bin=$(KERNELDOC)
+ALLSPHINXOPTS = -d $(BUILDDIR)/.doctrees $(KERNELDOC_CONF) $(PAPEROPT_$(PAPER)) -c $(srctree)/$(src) $(SPHINXOPTS) $(srctree)/$(src)
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
diff --git a/Documentation/conf.py b/Documentation/conf.py
index ff86f5e88049..0d33cb157716 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -18,7 +18,7 @@ import os
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('sphinx'))
# -- General configuration ------------------------------------------------
@@ -28,7 +28,7 @@ import os
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
-extensions = []
+extensions = ['kernel-doc']
# Gracefully handle missing rst2pdf.
try:
@@ -376,3 +376,9 @@ epub_exclude_files = ['search.html']
pdf_documents = [
('index', u'Kernel', u'Kernel', u'J. Random Bozo'),
]
+
+# kernel-doc extension configuration for running Sphinx directly (e.g. by Read
+# the Docs). In a normal build, these are supplied from the Makefile via command
+# line arguments.
+kerneldoc_bin = '../scripts/kernel-doc'
+kerneldoc_srctree = '..'
--
2.1.4
[toc] | [prev] | [next] | [standalone]
| From | Jani Nikula <jani.nikula@intel.com> |
|---|---|
| Date | 2016-05-20 15:50 +0200 |
| Subject | [PATCH 07/10] sphinx: cheesy script to convert .tmpl files |
| Message-ID | <rASYq-68P-29@gated-at.bofh.it> |
| In reply to | #1404432 |
From: Jonathan Corbet <corbet@lwn.net> 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 <in> <out>. Fix escaping for docproc directives. Add support the new kernel-doc extension.] Signed-off-by: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Jani Nikula <jani.nikula@intel.com> --- Documentation/sphinx/convert_template.sed | 14 ++++++++++++++ Documentation/sphinx/post_convert.sed | 19 +++++++++++++++++++ Documentation/sphinx/tmplcvt | 19 +++++++++++++++++++ 3 files changed, 52 insertions(+) create mode 100644 Documentation/sphinx/convert_template.sed create mode 100644 Documentation/sphinx/post_convert.sed create mode 100755 Documentation/sphinx/tmplcvt diff --git a/Documentation/sphinx/convert_template.sed b/Documentation/sphinx/convert_template.sed new file mode 100644 index 000000000000..d53bb8220a26 --- /dev/null +++ b/Documentation/sphinx/convert_template.sed @@ -0,0 +1,14 @@ +# +# Pandoc doesn't grok <function> or <structname>, so convert them +# ahead of time. +# +# Use "$bq" instead of "`" so that pandoc won't mess with it. +# +s%<function>\([^<(]\+\)()</function>%:c:func:$bq\1$bq%g +s%<function>\([^<(]\+\)</function>%:c:func:$bq\1$bq%g +s%<structname>struct *\([^<]\+\)</structname>%:ref:$bqstruct \1$bq%g +s%<structname>\([^<]\+\)</structname>%:ref:$bqstruct \1$bq%g +# +# Wrap docproc directives in para and code blocks. +# +s%^\(!.*\)$%<para><code>DOCPROC: \1</code></para>% diff --git a/Documentation/sphinx/post_convert.sed b/Documentation/sphinx/post_convert.sed new file mode 100644 index 000000000000..ce17049f6a8e --- /dev/null +++ b/Documentation/sphinx/post_convert.sed @@ -0,0 +1,19 @@ +# +# pandoc thinks that both "_" needs to be escaped. Remove the extra +# backslashes. Also put in proper backquotes now that pandoc won't quote +# them. +# +s/$bq/`/g +s/\\_/_/g +# +# Unwrap docproc directives. +# +s/^``DOCPROC: !E\(.*\)``$/.. kernel-doc:: \1\n :export:/ +s/^``DOCPROC: !I\(.*\)``$/.. kernel-doc:: \1\n :internal:/ +s/^``DOCPROC: !F\([^ ]*\) \(.*\)``$/.. kernel-doc:: \1\n :functions: \2/ +s/^``DOCPROC: !P\([^ ]*\) \(.*\)``$/.. kernel-doc:: \1\n :doc: \2/ +s/^``DOCPROC: \(!.*\)``$/.. WARNING: DOCPROC directive not supported: \1/ +# +# Trim trailing whitespace. +# +s/[[:space:]]*$// diff --git a/Documentation/sphinx/tmplcvt b/Documentation/sphinx/tmplcvt new file mode 100755 index 000000000000..909a73065e0a --- /dev/null +++ b/Documentation/sphinx/tmplcvt @@ -0,0 +1,19 @@ +#!/bin/bash +# +# Convert a template file into something like RST +# +# fix <function> +# feed to pandoc +# fix \_ +# title line? +# + +in=$1 +rst=$2 +tmp=$rst.tmp + +cp $in $tmp +sed --in-place -f convert_template.sed $tmp +pandoc -s -S -f docbook -t rst -o $rst $tmp +sed --in-place -f post_convert.sed $rst +rm $tmp -- 2.1.4
[toc] | [prev] | [next] | [standalone]
| From | Jani Nikula <jani.nikula@intel.com> |
|---|---|
| Date | 2016-05-20 15:50 +0200 |
| Subject | [PATCH 01/10] kernel-doc: fix use of uninitialized value |
| Message-ID | <rASYq-68P-47@gated-at.bofh.it> |
| In reply to | #1404432 |
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, <IN> line 6494.
Use of uninitialized value $_[0] in join or string at ./scripts/kernel-doc line 1759, <IN> line 6494.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
---
scripts/kernel-doc | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index 2fc8fad5195e..babb374c043d 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -1803,7 +1803,8 @@ sub output_function_rst(%) {
} else {
print " ``$parameter``\n";
}
- if ($args{'parameterdescs'}{$parameter_name} ne $undescribed) {
+ if (defined($args{'parameterdescs'}{$parameter_name}) &&
+ $args{'parameterdescs'}{$parameter_name} ne $undescribed) {
my $oldprefix = $lineprefix;
$lineprefix = " ";
output_highlight_rst($args{'parameterdescs'}{$parameter_name});
--
2.1.4
[toc] | [prev] | [next] | [standalone]
| From | Jani Nikula <jani.nikula@intel.com> |
|---|---|
| Date | 2016-05-29 22:40 +0200 |
| Message-ID | <rEfF8-2Ag-7@gated-at.bofh.it> |
| In reply to | #1404432 |
On Fri, 20 May 2016, Jani Nikula <jani.nikula@intel.com> wrote: > At this time I've put most effort into the configuration and build side > of things, solving the problems described above, and handling missing > tools and packages gracefully. There are still issues to be ironed out > in a) the kernel-doc script rst output and b) the xml template to rst > conversion. These are somewhat orthogonal from each other and the build, > and I expect some hand-editing will be required in the end. Jon - I've added a significant amount of polish. It works and it looks pretty. The code is in the "sphinx-wip" branch of [1], gitweb at [2], and Read the Docs built copy at [3]. There's roughly 30 commits there that I think are getting ready for merging. The rest is scripted conversion of some DocBook templates for demonstration purposes; I think the final conversion should be done by the authors of the documents when they are ready to ditch the DocBook templates in the same commit. I also think I've now spearheaded this pretty close to a point where more benefits can be gained by merging the work to docs-next, and collaborating there. Let me know what you think. BR, Jani. PS. I never thought I'd do this much perl coding in my life. It didn't kill me, I must be stronger now. [1] git://people.freedesktop.org/~jani/drm [2] https://cgit.freedesktop.org/~jani/drm/log/?h=sphinx-wip [3] https://kernel.readthedocs.io/ -- Jani Nikula, Intel Open Source Technology Center
[toc] | [prev] | [next] | [standalone]
| From | Daniel Vetter <daniel.vetter@ffwll.ch> |
|---|---|
| Date | 2016-05-30 11:20 +0200 |
| Message-ID | <rErwD-2fk-55@gated-at.bofh.it> |
| In reply to | #1408664 |
On Sun, May 29, 2016 at 10:33 PM, Jani Nikula <jani.nikula@intel.com> wrote: > On Fri, 20 May 2016, Jani Nikula <jani.nikula@intel.com> wrote: >> At this time I've put most effort into the configuration and build side >> of things, solving the problems described above, and handling missing >> tools and packages gracefully. There are still issues to be ironed out >> in a) the kernel-doc script rst output and b) the xml template to rst >> conversion. These are somewhat orthogonal from each other and the build, >> and I expect some hand-editing will be required in the end. > > Jon - > > I've added a significant amount of polish. It works and it looks > pretty. The code is in the "sphinx-wip" branch of [1], gitweb at [2], > and Read the Docs built copy at [3]. > > There's roughly 30 commits there that I think are getting ready for > merging. The rest is scripted conversion of some DocBook templates for > demonstration purposes; I think the final conversion should be done by > the authors of the documents when they are ready to ditch the DocBook > templates in the same commit. > > I also think I've now spearheaded this pretty close to a point where > more benefits can be gained by merging the work to docs-next, and > collaborating there. > > Let me know what you think. I've looked both through the patches in Jani's branch and the resulting docs. Spotted 2 nitpicks, which are already fixed, and it looks imo _really_ good. 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. There's still piles of little polish to do to make it really pretty, but that's almost all in the kernel-doc comments or .rst files itself. I think for starting we could convert a few docs already, or just add the index.rst and leave conversions to maintainers. At least for gpu.tmpl I expect some need for cordination with ongoing work. -Daniel > > > BR, > Jani. > > PS. I never thought I'd do this much perl coding in my life. It didn't > kill me, I must be stronger now. > > > [1] git://people.freedesktop.org/~jani/drm > [2] https://cgit.freedesktop.org/~jani/drm/log/?h=sphinx-wip > [3] https://kernel.readthedocs.io/ > > > -- > Jani Nikula, Intel Open Source Technology Center -- Daniel Vetter Software Engineer, Intel Corporation +41 (0) 79 365 57 48 - http://blog.ffwll.ch
[toc] | [prev] | [next] | [standalone]
| From | Markus Heiser <markus.heiser@darmarit.de> |
|---|---|
| Date | 2016-05-30 12:50 +0200 |
| Message-ID | <rEsVI-2ZZ-11@gated-at.bofh.it> |
| In reply to | #1408930 |
Hi,
sorry for my temporary absence, I have been on holiday the last weeks :-)
Am 30.05.2016 um 11:10 schrieb Daniel Vetter <daniel.vetter@ffwll.ch>:
> On Sun, May 29, 2016 at 10:33 PM, Jani Nikula <jani.nikula@intel.com> wrote:
>> On Fri, 20 May 2016, Jani Nikula <jani.nikula@intel.com> wrote:
>>> At this time I've put most effort into the configuration and build side
>>> of things, solving the problems described above, and handling missing
>>> tools and packages gracefully. There are still issues to be ironed out
>>> in a) the kernel-doc script rst output and b) the xml template to rst
>>> conversion. These are somewhat orthogonal from each other and the build,
>>> and I expect some hand-editing will be required in the end.
>>
>> Jon -
>>
>> I've added a significant amount of polish. It works and it looks
>> pretty. The code is in the "sphinx-wip" branch of [1], gitweb at [2],
>> and Read the Docs built copy at [3].
>>
>> There's roughly 30 commits there that I think are getting ready for
>> merging. The rest is scripted conversion of some DocBook templates for
>> demonstration purposes; I think the final conversion should be done by
>> the authors of the documents when they are ready to ditch the DocBook
>> templates in the same commit.
>>
>> I also think I've now spearheaded this pretty close to a point where
>> more benefits can be gained by merging the work to docs-next, and
>> collaborating there.
>>
>> Let me know what you think.
>
> I've looked both through the patches in Jani's branch and the
> resulting docs. Spotted 2 nitpicks, which are already fixed, and it
> looks imo _really_ good.
>
> 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. There's still piles of
> little polish to do to make it really pretty, but that's almost all in
> the kernel-doc comments or .rst files itself. I think for starting we
> could convert a few docs already, or just add the index.rst and leave
> conversions to maintainers. At least for gpu.tmpl I expect some need
> for cordination with ongoing work.
> -Daniel
Here my 5cents about Jani's patch series:
1. Migration implementations should not be a part of the kernel tree
2. sed/pandoc migration fits not for all the XML documentation and has disadvantages.
Jonathan asked it before: http://article.gmane.org/gmane.linux.documentation/37533
I repeat myself: Summarize, why should one prefer this tools over pandoc + sed?
* Pandoc coverage is less on reading and writing, this is where
dbxml comes into play
- reading DocBook: https://github.com/jgm/pandoc/blob/master/src/Text/Pandoc/Readers/DocBook.hs#L23
- writing reST has many bugs and leaks (you fixed some of them with sed)
* Pandoc does not support external entities (linux-tv), covered by dbxml
* dbxml brings the ability to chunk one large XML book into small
reST chunks e.g. kernel-hacking book: https://github.com/return42/sphkerneldoc/tree/master/doc/books/kernel-hacking
* dbxml lets you manipulate the XML source before you convert it to reST
this might helpfull e.g. if you have to convert single-column informal-tables
to lists or other things ... in short; dbxml and it's hooks are the key to hack
everything you need in a full automated DocBook-->reST migration workflow.
3. we also discussed before, that ASCII art tables are ugly, because the produce
confusing diffs, for this I wrote the flat-table directive (dbxml migrates tables
to flat-tables / pandoc can't).
https://return42.github.io/sphkerneldoc/articles/table_concerns.html#flat-table
> With this, we can put any .rst files (including ones that have
> kernel-doc directives) anywhere under Documentation, add a link to them
> in Documentation/index.rst table of contents, and it will just work. It
> can't get much simpler than that.
4. We discussed it / I already mentioned that each document shipped in it's own
sphinx project. Bundling all documents into one sphinx-project will work for
4 or 5 small documents, but not for the whole documentation. BTW all XML
documents are currently separated DocBook projects .. so why should we merge
them into one big project? Making one index-file for the different and small
".txt" files seems OK, but not for the XML docs.
5. In general, the markup of the linux kernel's source code comments remains
unchanged and the reST markup within the comments is passed through the
output. A closer lookup to the *kernel-doc* and *reST* markup revals, that
there are some conflicts between reST (inline) markup and kernel-doc
markup. Determined by the historical development of the kernel-doc comments, the
*classic* kernel-doc comments contain characters like ``*`` or strings with
e.g. leading/trailing underscore (``_``), which are inline markups in
reST. Here a schort example from a *classic* comment::
<SNIP> -----
* In contrast to the other drm_get_*_name functions this one here returns a
* const pointer and hence is threadsafe.
<SNAP> -----
In reST markup, the wildcard in the string ``drm_get_*_name`` has to be
masked: ``drm_get_\\*_name``. Some more examples from reST markup:
* Emphasis "*": like ``*emphasis*`` or ``**emphasis strong**``
* Leading "_" : is a *anchor* in reST markup (``_foo``).
* Trailing "_: is a reference in reST markup (``foo_``).
* interpreted text: "`"
* inline literals: "``"
* substitution references: "|"
These special strings has to be masked in the output and can't be used as
*plain-text markup*. To get in use of the fully reST markup (stop masking
special characters) we need some options in the sources documentation, comments
like
/* parse-markup: reST */
which influence the behavior.
> Sites like https://readthedocs.org/ can build the documentation,
> including kernel-doc, without extra tweaks. As a whole, the build
> becomes much simpler.
6. This fail assessments I also had before. RTD has limits in
resources and in flexibility, that's why I moved to github pages
https://github.com/return42/sphkerneldoc/issues/1
I will stop here ... I think it is good that everyone make its own
experience, BUT ...
IMO it is a misjudgment to think that changing the
markup and it's toolchain is only a series of patches.
Sorry if my words are unpleasant, this is not my intend, but IMO *the
view of the whole* and concepts are missed.
Many of the facts mentioned above have been covered in my POC at
https://github.com/return42/sphkerneldoc ... On others,
like 5. I'am working on ....
> I've had a few moments of spare time to look into Sphinx.
... a comprehensive solution needs time and will not be done in a
hurry. Please give me a week or may be two, then I could present
a much more comprehensive solution.
Again: my english is not the best, if some of my words has been
unpleasant I'am sorry for this, it's not my intend.
--Markus--
>
>>
>>
>> BR,
>> Jani.
>>
>> PS. I never thought I'd do this much perl coding in my life. It didn't
>> kill me, I must be stronger now.
>>
>>
>> [1] git://people.freedesktop.org/~jani/drm
>> [2] https://cgit.freedesktop.org/~jani/drm/log/?h=sphinx-wip
>> [3] https://kernel.readthedocs.io/
>>
>>
>> --
>> Jani Nikula, Intel Open Source Technology Center
>
>
>
> --
> Daniel Vetter
> Software Engineer, Intel Corporation
> +41 (0) 79 365 57 48 - http://blog.ffwll.ch
[toc] | [prev] | [next] | [standalone]
| From | Jani Nikula <jani.nikula@intel.com> |
|---|---|
| Date | 2016-05-30 16:50 +0200 |
| Message-ID | <rEwFX-5sh-3@gated-at.bofh.it> |
| In reply to | #1408977 |
On Mon, 30 May 2016, Markus Heiser <markus.heiser@darmarit.de> wrote: > Here my 5cents about Jani's patch series: > > 1. Migration implementations should not be a part of the kernel tree If you're referring to the conversion scripts, I don't care either way. It's probably helpful to have them until everything is converted, and we can dispose of them afterwards. > 2. sed/pandoc migration fits not for all the XML documentation and has disadvantages. > Jonathan asked it before: http://article.gmane.org/gmane.linux.documentation/37533 > > I repeat myself: Summarize, why should one prefer this tools over pandoc + sed? > > * Pandoc coverage is less on reading and writing, this is where > dbxml comes into play > > - reading DocBook: https://github.com/jgm/pandoc/blob/master/src/Text/Pandoc/Readers/DocBook.hs#L23 > > - writing reST has many bugs and leaks (you fixed some of them with sed) > > * Pandoc does not support external entities (linux-tv), covered by dbxml > > * dbxml brings the ability to chunk one large XML book into small > reST chunks e.g. kernel-hacking book: https://github.com/return42/sphkerneldoc/tree/master/doc/books/kernel-hacking > > * dbxml lets you manipulate the XML source before you convert it to reST > > this might helpfull e.g. if you have to convert single-column informal-tables > to lists or other things ... in short; dbxml and it's hooks are the key to hack > everything you need in a full automated DocBook-->reST migration workflow. I am not proposing to merge the documents that I've converted mostly as samples in the branch. I needed something to demonstrate the build is sane. The authors of the DocBook documents should make the conversions as they see fit, when they see fit, with the tools they see fit, probably with some manual work on top. > 3. we also discussed before, that ASCII art tables are ugly, because the produce > confusing diffs, for this I wrote the flat-table directive (dbxml migrates tables > to flat-tables / pandoc can't). > https://return42.github.io/sphkerneldoc/articles/table_concerns.html#flat-table See the above. Any authors that think the Sphinx support I've added is good enough can go ahead and switch. I think it's safe for me to say the GPU documents won't wait for further extension directives or conversion tools. Some others will definitely want to have the flat table extension before switching. >> With this, we can put any .rst files (including ones that have >> kernel-doc directives) anywhere under Documentation, add a link to them >> in Documentation/index.rst table of contents, and it will just work. It >> can't get much simpler than that. > > 4. We discussed it / I already mentioned that each document shipped in it's own > sphinx project. Bundling all documents into one sphinx-project will work for > 4 or 5 small documents, but not for the whole documentation. BTW all XML > documents are currently separated DocBook projects .. so why should we merge > them into one big project? Making one index-file for the different and small > ".txt" files seems OK, but not for the XML docs. FWIW I locally converted all the DocBook documents (except media) and it works just fine, and to me it looks like exactly what we should have. One of the goals was to have nice cross-referencing between the documents (e.g. from GPU to kernel or device driver API). And it works. This does not exclude having *additional* indexes or Sphinx config files for subsystems or subprojects to build a subset of the documentation for specific needs. It's up to the authors of the documents to decide. For PDF documents, adding the documents separately in pdf_documents seems to be the right thing to do. > 5. In general, the markup of the linux kernel's source code comments remains > unchanged and the reST markup within the comments is passed through the > output. A closer lookup to the *kernel-doc* and *reST* markup revals, that > there are some conflicts between reST (inline) markup and kernel-doc > markup. Determined by the historical development of the kernel-doc comments, the > *classic* kernel-doc comments contain characters like ``*`` or strings with > e.g. leading/trailing underscore (``_``), which are inline markups in > reST. Here a schort example from a *classic* comment:: > > <SNIP> ----- > * In contrast to the other drm_get_*_name functions this one here returns a > * const pointer and hence is threadsafe. > <SNAP> ----- > > In reST markup, the wildcard in the string ``drm_get_*_name`` has to be > masked: ``drm_get_\\*_name``. Some more examples from reST markup: > > * Emphasis "*": like ``*emphasis*`` or ``**emphasis strong**`` > * Leading "_" : is a *anchor* in reST markup (``_foo``). > * Trailing "_: is a reference in reST markup (``foo_``). > * interpreted text: "`" > * inline literals: "``" > * substitution references: "|" > > These special strings has to be masked in the output and can't be used as > *plain-text markup*. To get in use of the fully reST markup (stop masking > special characters) we need some options in the sources documentation, comments > like > > /* parse-markup: reST */ > > which influence the behavior. I find it totally unacceptable to require explicitly marking kernel-doc comments or source files as being reStructuredText. Note that it's all opt-in already. If you add a .rst file that includes kernel-doc via the kernel-doc extension, you better make sure the comments parse as reStructuredText and render nicely. I'm willing to do much of the job for all the things that I care about. Besides, if you look at the results, you'll find it looks mostly good without any fixes. In the sample documents, I've erred on the side of having a few markup hickups here and there while most of it works perfectly well as reStructuredText. I think this is exactly what we should do, declare it all reStructuredText and fix issues as we go. >> Sites like https://readthedocs.org/ can build the documentation, >> including kernel-doc, without extra tweaks. As a whole, the build >> becomes much simpler. > > > 6. This fail assessments I also had before. RTD has limits in > resources and in flexibility, that's why I moved to github pages > > https://github.com/return42/sphkerneldoc/issues/1 I'm just personally using Read the Docs to ensure they can build the documentation as "pure" Sphinx (they won't use the Makefiles), and so I don't have to host the docs anywhere myself. Sure, I can't add *all* the files there because it exceeds the build limits. They might cater for us if they want to carry the kernel documentation going forward, but most likely the output should be at kernel.org anyway. (Plus we'll have freedesktop.org and 01.org for the GPU documentation too.) > I will stop here ... I think it is good that everyone make its own > experience, BUT ... > > IMO it is a misjudgment to think that changing the > markup and it's toolchain is only a series of patches. > > Sorry if my words are unpleasant, this is not my intend, but IMO *the > view of the whole* and concepts are missed. I'm not sure what to say. For one thing, a concrete series of patches to add Sphinx support to the kernel, integrating it with the build system and kernel-doc and everything is *exactly* what is needed. This is what I've done. It's here now. It works. Anyone can take my git tree, run 'make htmldocs' and see the results for themselves. From your message it remains unclear to me what "view of the whole" and "concepts" and "comprehensive solution" I have missed. > Many of the facts mentioned above have been covered in my POC at > https://github.com/return42/sphkerneldoc ... On others, > like 5. I'am working on .... > >> I've had a few moments of spare time to look into Sphinx. > > ... a comprehensive solution needs time and will not be done in a > hurry. Please give me a week or may be two, then I could present > a much more comprehensive solution. Please do not underestimate the productivity of my moments of spare time. ;) My view of the whole is that we've been talking about adding lightweight markup support for the better part of a year now, and I'm getting pretty tired of talking... BR, Jani. -- Jani Nikula, Intel Open Source Technology Center
[toc] | [prev] | [next] | [standalone]
| From | Daniel Vetter <daniel.vetter@ffwll.ch> |
|---|---|
| Date | 2016-05-30 17:30 +0200 |
| Message-ID | <rExiG-5ZF-25@gated-at.bofh.it> |
| In reply to | #1409181 |
I concur with Jani on all points, just want to follow-up here. On Mon, May 30, 2016 at 4:46 PM, Jani Nikula <jani.nikula@intel.com> wrote: >> Many of the facts mentioned above have been covered in my POC at >> https://github.com/return42/sphkerneldoc ... On others, >> like 5. I'am working on .... >> >>> I've had a few moments of spare time to look into Sphinx. >> >> ... a comprehensive solution needs time and will not be done in a >> hurry. Please give me a week or may be two, then I could present >> a much more comprehensive solution. > > Please do not underestimate the productivity of my moments of spare > time. ;) > > My view of the whole is that we've been talking about adding lightweight > markup support for the better part of a year now, and I'm getting pretty > tired of talking... Tbh I'd like to get this in soonish, so that we have about 1 month of time before 4.8 for actually polishing gpu documentation. Maybe there's some room for more, better tables, other extensions, polish the kernel-doc script a bit more. But what we have now works, I think it does address everything we've discussed over the past year that we absolutely need. I think it makes it possible to extend for all the more optional use-cases we need to be able to convert, and we can add those extensions later on. And with Jani's big pile of kernel-doc patches we now also have someone who understands that perl script, which is awesome. In short I want to go nuts improving the docs themselves and stop discussing the tooling to build them. Can we please make this happen? Note that Jani's already started to throw out our old ascidoc hacks in the topic/kerneldoc branch in the drm-intel.git repo, and we'll switch over the autobuilder for the 01.org docs as soon as that's done. We're committed, I want this ;-) Thanks, Daniel -- Daniel Vetter Software Engineer, Intel Corporation +41 (0) 79 365 57 48 - http://blog.ffwll.ch
[toc] | [prev] | [next] | [standalone]
| From | Markus Heiser <markus.heiser@darmarit.de> |
|---|---|
| Date | 2016-05-30 18:50 +0200 |
| Message-ID | <rEyy6-6IE-47@gated-at.bofh.it> |
| In reply to | #1409181 |
Am 30.05.2016 um 16:46 schrieb Jani Nikula <jani.nikula@intel.com>: > On Mon, 30 May 2016, Markus Heiser <markus.heiser@darmarit.de> wrote: >> Here my 5cents about Jani's patch series: >> >> 1. Migration implementations should not be a part of the kernel tree > > If you're referring to the conversion scripts, I don't care either > way. It's probably helpful to have them until everything is converted, > and we can dispose of them afterwards. > >> 2. sed/pandoc migration fits not for all the XML documentation and has disadvantages. >> Jonathan asked it before: http://article.gmane.org/gmane.linux.documentation/37533 >> >> I repeat myself: Summarize, why should one prefer this tools over pandoc + sed? >> >> * Pandoc coverage is less on reading and writing, this is where >> dbxml comes into play >> >> - reading DocBook: https://github.com/jgm/pandoc/blob/master/src/Text/Pandoc/Readers/DocBook.hs#L23 >> >> - writing reST has many bugs and leaks (you fixed some of them with sed) >> >> * Pandoc does not support external entities (linux-tv), covered by dbxml >> >> * dbxml brings the ability to chunk one large XML book into small >> reST chunks e.g. kernel-hacking book: https://github.com/return42/sphkerneldoc/tree/master/doc/books/kernel-hacking >> >> * dbxml lets you manipulate the XML source before you convert it to reST >> >> this might helpfull e.g. if you have to convert single-column informal-tables >> to lists or other things ... in short; dbxml and it's hooks are the key to hack >> everything you need in a full automated DocBook-->reST migration workflow. > > I am not proposing to merge the documents that I've converted mostly as > samples in the branch. I needed something to demonstrate the build is > sane. > The authors of the DocBook documents should make the conversions as they > see fit, when they see fit, with the tools they see fit, probably with > some manual work on top. OK > >> 3. we also discussed before, that ASCII art tables are ugly, because the produce >> confusing diffs, for this I wrote the flat-table directive (dbxml migrates tables >> to flat-tables / pandoc can't). >> https://return42.github.io/sphkerneldoc/articles/table_concerns.html#flat-table > > See the above. Any authors that think the Sphinx support I've added is > good enough can go ahead and switch. > > I think it's safe for me to say the GPU documents won't wait for further > extension directives or conversion tools. Some others will definitely > want to have the flat table extension before switching. OK > >>> With this, we can put any .rst files (including ones that have >>> kernel-doc directives) anywhere under Documentation, add a link to them >>> in Documentation/index.rst table of contents, and it will just work. It >>> can't get much simpler than that. >> >> 4. We discussed it / I already mentioned that each document shipped in it's own >> sphinx project. Bundling all documents into one sphinx-project will work for >> 4 or 5 small documents, but not for the whole documentation. BTW all XML >> documents are currently separated DocBook projects .. so why should we merge >> them into one big project? Making one index-file for the different and small >> ".txt" files seems OK, but not for the XML docs. > > FWIW I locally converted all the DocBook documents (except media) and it > works just fine, and to me it looks like exactly what we should > have. With DocBook, it was hard to separate a file into small chunks (see media for how it is done). With Sphinx, it is common to split a document in small chunks (along parts, chapters, sections ...) Thats why I recommend chunking documents (from the beginning). > One of the goals was to have nice cross-referencing between the > documents (e.g. from GPU to kernel or device driver API). And it works. For this, Sphinx-doc brings intersphinx: http://www.sphinx-doc.org/en/stable/ext/intersphinx.html > This does not exclude having *additional* indexes or Sphinx config files > for subsystems or subprojects to build a subset of the documentation for > specific needs. It's up to the authors of the documents to decide. OK, I think we have a bit different point of view .. IMO it is better to give the authors a *scalable structure* to place their's documentation. > For PDF documents, adding the documents separately in pdf_documents > seems to be the right thing to do. I can't recommend to use rst2pdf (it is less maintained), use default sphinx LaTeX toolchain. > >> 5. In general, the markup of the linux kernel's source code comments remains >> unchanged and the reST markup within the comments is passed through the >> output. A closer lookup to the *kernel-doc* and *reST* markup revals, that >> there are some conflicts between reST (inline) markup and kernel-doc >> markup. Determined by the historical development of the kernel-doc comments, the >> *classic* kernel-doc comments contain characters like ``*`` or strings with >> e.g. leading/trailing underscore (``_``), which are inline markups in >> reST. Here a schort example from a *classic* comment:: >> >> <SNIP> ----- >> * In contrast to the other drm_get_*_name functions this one here returns a >> * const pointer and hence is threadsafe. >> <SNAP> ----- >> >> In reST markup, the wildcard in the string ``drm_get_*_name`` has to be >> masked: ``drm_get_\\*_name``. Some more examples from reST markup: >> >> * Emphasis "*": like ``*emphasis*`` or ``**emphasis strong**`` >> * Leading "_" : is a *anchor* in reST markup (``_foo``). >> * Trailing "_: is a reference in reST markup (``foo_``). >> * interpreted text: "`" >> * inline literals: "``" >> * substitution references: "|" >> >> These special strings has to be masked in the output and can't be used as >> *plain-text markup*. To get in use of the fully reST markup (stop masking >> special characters) we need some options in the sources documentation, comments >> like >> >> /* parse-markup: reST */ >> >> which influence the behavior. > > I find it totally unacceptable to require explicitly marking kernel-doc > comments or source files as being reStructuredText. > Note that it's all opt-in already. If you add a .rst file that includes > kernel-doc via the kernel-doc extension, you better make sure the > comments parse as reStructuredText and render nicely. I'm willing to do > much of the job for all the things that I care about. We have a different POV ... I try to build up a documentation project, which could use all given kernel-doc markups without any change, where reST is an "addition". Your approach is to fix kernel-doc comments if they are referred by a kernl-doc directive in a .rst document. There is nothing wrong about your approach, but I try to build a whole source code documentation like the one I started here: http://return42.github.io/sphkerneldoc/linux_src_doc/index.html Benefit: Beside a kernel-doc directive, authors (from everywhere, not only within the kernel-src-tree) can refer kernel-docs with intersphinx Here is a example, see "cross references" at: http://return42.github.io/sphkerneldoc/articles/linux_src_doc.html?cross-references > Besides, if you look at the results, you'll find it looks mostly good > without any fixes. In the sample documents, I've erred on the side of > having a few markup hickups here and there while most of it works > perfectly well as reStructuredText. I think this is exactly what we > should do, declare it all reStructuredText and fix issues as we go. > >>> Sites like https://readthedocs.org/ can build the documentation, >>> including kernel-doc, without extra tweaks. As a whole, the build >>> becomes much simpler. >> >> >> 6. This fail assessments I also had before. RTD has limits in >> resources and in flexibility, that's why I moved to github pages >> >> https://github.com/return42/sphkerneldoc/issues/1 > > I'm just personally using Read the Docs to ensure they can build the > documentation as "pure" Sphinx (they won't use the Makefiles), and so I > don't have to host the docs anywhere myself. Sure, I can't add *all* the > files there because it exceeds the build limits. They might cater for us > if they want to carry the kernel documentation going forward, but most > likely the output should be at kernel.org anyway. (Plus we'll have > freedesktop.org and 01.org for the GPU documentation too.) There a some similar discussions on RTD ... yes, they make exceptions for *special* users, but its all harry, use your default publishing sides and forget RTD ;-) >> I will stop here ... I think it is good that everyone make its own >> experience, BUT ... >> >> IMO it is a misjudgment to think that changing the >> markup and it's toolchain is only a series of patches. >> >> Sorry if my words are unpleasant, this is not my intend, but IMO *the >> view of the whole* and concepts are missed. > > I'm not sure what to say. As I said, we have a different POV, which is not in contradiction, as your requirements are a subset of mine. I worry a little bit in that reST will be only one more toolchain beside DocBook .. in the long term, kernel's documentation should get rid of all the DocBook artifacts and for this a more comprehensive solution is needed. > Please do not underestimate the productivity of my moments of spare > time. ;) 1:0 for you ;-) Am 30.05.2016 um 17:29 schrieb Daniel Vetter <daniel.vetter@ffwll.ch>: > I concur with Jani on all points, just want to follow-up here. > > Tbh I'd like to get this in soonish, so that we have about 1 month of > time before 4.8 for actually polishing gpu documentation. Maybe > there's some room for more, better tables, other extensions, polish > the kernel-doc script a bit more. But what we have now works, I think > it does address everything we've discussed over the past year that we > absolutely need. I think it makes it possible to extend for all the > more optional use-cases we need to be able to convert, and we can add > those extensions later on. OK, I understand your needs, I don't wan't to stop you writing documentation with reST. May use Jani's approach for a first toolchain > And with Jani's big pile of kernel-doc > patches we now also have someone who understands that perl script, > which is awesome. ? https://github.com/return42/sphkerneldoc/blob/master/scripts/kernel-doc#L1736 > In short I want to go nuts improving the docs themselves and stop > discussing the tooling to build them. Can we please make this happen? > > Note that Jani's already started to throw out our old ascidoc hacks in > the topic/kerneldoc branch in the drm-intel.git repo, and we'll switch > over the autobuilder for the 01.org docs as soon as that's done. We're > committed, I want this ;-) Am 30.05.2016 um 16:46 schrieb Jani Nikula <jani.nikula@intel.com>: > I'm getting pretty tired of talking... Yes, we are all tired in this discussions ... I see, you are in need to switch over ... for this, may use your toolchain ... but I have one please, do not change more than you really need and be open for changing the toolchain later. I will inform you about any substantial progress within my solution ... may we can merge our experience soon or later, but don't stop writing documentation. Thank's for your patience ... :-) --Markus--
[toc] | [prev] | [next] | [standalone]
| From | Jani Nikula <jani.nikula@intel.com> |
|---|---|
| Date | 2016-05-30 22:10 +0200 |
| Message-ID | <rEBFD-B5-21@gated-at.bofh.it> |
| In reply to | #1409290 |
On Mon, 30 May 2016, Markus Heiser <markus.heiser@darmarit.de> wrote: > Am 30.05.2016 um 16:46 schrieb Jani Nikula <jani.nikula@intel.com>: >> I am not proposing to merge the documents that I've converted mostly as >> samples in the branch. I needed something to demonstrate the build is >> sane. > >> The authors of the DocBook documents should make the conversions as they >> see fit, when they see fit, with the tools they see fit, probably with >> some manual work on top. > > OK 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 updates, etc. There is no DocBook tmpl conversion; all of that is left to the authors (owners, maintainers) of the documents, but this enables them to focus on that part. I was planning on sending out the patches after some feedback here. [1] git://people.freedesktop.org/~jani/drm [2] https://cgit.freedesktop.org/~jani/drm/log/?h=sphinx-for-docs-next > With DocBook, it was hard to separate a file into small chunks (see media for > how it is done). With Sphinx, it is common to split a document in small chunks > (along parts, chapters, sections ...) Thats why I recommend chunking documents > (from the beginning). Agreed, but up to the authors. >> One of the goals was to have nice cross-referencing between the >> documents (e.g. from GPU to kernel or device driver API). And it works. > > For this, Sphinx-doc brings intersphinx: http://www.sphinx-doc.org/en/stable/ext/intersphinx.html If the kernel is split to several intersphinx "prefixes", we won't know the prefix of the link targets when we're generating the references in kernel-doc. Also, can be deferred to follow-up work if someone figures out the how. > 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 find it totally unacceptable to require explicitly marking kernel-doc >> comments or source files as being reStructuredText. >> Note that it's all opt-in already. If you add a .rst file that includes >> kernel-doc via the kernel-doc extension, you better make sure the >> comments parse as reStructuredText and render nicely. I'm willing to do >> much of the job for all the things that I care about. > > We have a different POV ... I try to build up a documentation project, > which could use all given kernel-doc markups without any change, where > reST is an "addition". Your approach is to fix kernel-doc comments > if they are referred by a kernl-doc directive in a .rst document. > There is nothing wrong about your approach, but I try to build > a whole source code documentation like the one I started here: > http://return42.github.io/sphkerneldoc/linux_src_doc/index.html That looks nice, but I'll argue it would not be much worse even if you assumed it's all rst. The bigger point is, if you expect people to tag each source file or kernel-doc comment with "rst", you'll end up with a mess where some places have that tag, some not, but it's not conclusive about whether they actually *are* rst or not. (And you've had tons of patch churn to add those tags to get there.) The kernel-doc comments are written by humans who will screw it up anyway. (Apologies for the distrust, fellow developers, but I've been reading too many of your fine kernel-doc comments lately.) People will happily cargo cult rst and current kernel-doc and javadoc and doxygen and whatnot in a fruit salad. The only thing that will help in the end is keeping the rules simple and consistent and having the feedback from the tools. > I worry a little bit in that reST will be only one more toolchain > beside DocBook .. in the long term, kernel's documentation > should get rid of all the DocBook artifacts and for this a more > comprehensive solution is needed. We agree on the end goal, eradicate DocBook. I must say that in my experiments, apart from the media docs, almost everything converts surprisingly nicely or IMO "good enough" with just the tmplcvt script in this series. Do remember that this is a one time conversion. It needs to be good enough that there's not too much manual editing involved, but it doesn't need to be perfect. Some degree of editing will be required no matter what, not least because the DocBook has also been written by humans, and the battle against the GIGO principle is a lost one. >> And with Jani's big pile of kernel-doc >> patches we now also have someone who understands that perl script, >> which is awesome. > > ? I must also question any sentence that implies I understand perl. ;) >> In short I want to go nuts improving the docs themselves and stop >> discussing the tooling to build them. Can we please make this happen? >> >> Note that Jani's already started to throw out our old ascidoc hacks in >> the topic/kerneldoc branch in the drm-intel.git repo, and we'll switch >> over the autobuilder for the 01.org docs as soon as that's done. We're >> committed, I want this ;-) It's done, we're feeding this to our integration tree and dogfooding. BR, Jani. -- Jani Nikula, Intel Open Source Technology Center
[toc] | [prev] | [next] | [standalone]
| From | Mauro Carvalho Chehab <mchehab@osg.samsung.com> |
|---|---|
| Date | 2016-05-30 23:30 +0200 |
| Message-ID | <rECV4-1mL-41@gated-at.bofh.it> |
| In reply to | #1409359 |
Em Mon, 30 May 2016 23:05:34 +0300 Jani Nikula <jani.nikula@intel.com> escreveu: > > I worry a little bit in that reST will be only one more toolchain > > beside DocBook .. in the long term, kernel's documentation > > should get rid of all the DocBook artifacts and for this a more > > comprehensive solution is needed. > > We agree on the end goal, eradicate DocBook. I must say that in my > experiments, apart from the media docs, almost everything converts > surprisingly nicely or IMO "good enough" with just the tmplcvt script in > this series. With regards to media, my plan is to merge create a topic branch based on Kernel 4.7-rc1 at: https://git.linuxtv.org/media_tree.git/ As none of the Jani's patches seem to affect the media API docs, it seems I don't need to merge back from Jon's -next branch. There, I intend to add Markus patches with the conversion from the DocBook to rst, plus the flat-table extension logic. Then, I'll work to manually fix what's needed and I'll add the automation scripting logic that we have at the DocBook Makefile to work with the new media rst files. Lastly, once the job's done, I'll drop Documentation/DocBook/media. Markus, With that regards, could you please send the patches to me? Thanks, Mauro
[toc] | [prev] | [next] | [standalone]
| From | Markus Heiser <markus.heiser@darmarit.de> |
|---|---|
| Date | 2016-05-31 09:30 +0200 |
| Message-ID | <rEMhI-7Yx-5@gated-at.bofh.it> |
| In reply to | #1409359 |
Am 30.05.2016 um 22:05 schrieb Jani Nikula <jani.nikula@intel.com>: > On Mon, 30 May 2016, Markus Heiser <markus.heiser@darmarit.de> wrote: >> Am 30.05.2016 um 16:46 schrieb Jani Nikula <jani.nikula@intel.com>: >>> I am not proposing to merge the documents that I've converted mostly as >>> samples in the branch. I needed something to demonstrate the build is >>> sane. >> >>> The authors of the DocBook documents should make the conversions as they >>> see fit, when they see fit, with the tools they see fit, probably with >>> some manual work on top. >> >> OK > > 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 > updates, etc. There is no DocBook tmpl conversion; all of that is left > to the authors (owners, maintainers) of the documents, but this enables > them to focus on that part. > > I was planning on sending out the patches after some feedback here. > > [1] git://people.freedesktop.org/~jani/drm > [2] https://cgit.freedesktop.org/~jani/drm/log/?h=sphinx-for-docs-next > >> With DocBook, it was hard to separate a file into small chunks (see media for >> how it is done). With Sphinx, it is common to split a document in small chunks >> (along parts, chapters, sections ...) Thats why I recommend chunking documents >> (from the beginning). > > Agreed, but up to the authors. > >>> One of the goals was to have nice cross-referencing between the >>> documents (e.g. from GPU to kernel or device driver API). And it works. >> >> For this, Sphinx-doc brings intersphinx: http://www.sphinx-doc.org/en/stable/ext/intersphinx.html > > If the kernel is split to several intersphinx "prefixes", we won't know > the prefix of the link targets when we're generating the references in > kernel-doc. Also, can be deferred to follow-up work if someone figures > out the how. It stands to reason that each book should be placed in a separate folder. This simple role simplifies much, e.g. chunking, "prefixes" for the intersphinx, a place for images of this book .. etc. It is also the base to have one sphinx-doc project (individual config set) for each book. Please, place each (DocBook) reST-book at least into a separate folder. >> 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. The discussion in the past was dominated by the fear, that something on the sphinx-doc could not be maintained in the future ... I don't share theses fears, if needed, I also have no problem to repair or throw my damaged toolchain away ;-) >>> I find it totally unacceptable to require explicitly marking kernel-doc >>> comments or source files as being reStructuredText. >>> Note that it's all opt-in already. If you add a .rst file that includes >>> kernel-doc via the kernel-doc extension, you better make sure the >>> comments parse as reStructuredText and render nicely. I'm willing to do >>> much of the job for all the things that I care about. >> >> We have a different POV ... I try to build up a documentation project, >> which could use all given kernel-doc markups without any change, where >> reST is an "addition". Your approach is to fix kernel-doc comments >> if they are referred by a kernl-doc directive in a .rst document. >> There is nothing wrong about your approach, but I try to build >> a whole source code documentation like the one I started here: >> http://return42.github.io/sphkerneldoc/linux_src_doc/index.html > > That looks nice, but I'll argue it would not be much worse even if you > assumed it's all rst. A superficial look on the HTML output may give the impression. But in the log you will find tons of errors and warnings. My experience is, that authors will not consult logs if there are tons of errors from the beginning, which carries a decrease in quality. IMO not a good starting point. > The bigger point is, if you expect people to tag each source file or > kernel-doc comment with "rst", you'll end up with a mess where some > places have that tag, some not, but it's not conclusive about whether > they actually *are* rst or not. (And you've had tons of patch churn to > add those tags to get there.) At the end, only sources which have been modified to reST need one line (in the first lines) : /* parse-markup: reST */ which announce the reST markup in this file, normaly this needs no additional patches, except the author forget to announce his movement to reST ... > The kernel-doc comments are written by humans who will screw it up > anyway. (Apologies for the distrust, fellow developers, but I've been > reading too many of your fine kernel-doc comments lately.) People will > happily cargo cult rst and current kernel-doc and javadoc and doxygen > and whatnot in a fruit salad. The only thing that will help in the end > is keeping the rules simple and consistent and having the feedback from > the tools. You are right, I have seen tons of individual markups in the kernel-doc comments. In the past some authors ignored the description in the kernel-doc-nano-howto. The "/* parse-markup: reST */" will be only one addition more to the kernel-doc-nano-howto they could ignore ;-) >> I worry a little bit in that reST will be only one more toolchain >> beside DocBook .. in the long term, kernel's documentation >> should get rid of all the DocBook artifacts and for this a more >> comprehensive solution is needed. > > We agree on the end goal, eradicate DocBook. I must say that in my > experiments, apart from the media docs, almost everything converts > surprisingly nicely or IMO "good enough" with just the tmplcvt script in > this series. Do remember that this is a one time conversion. It needs to > be good enough that there's not too much manual editing involved, but it > doesn't need to be perfect. Some degree of editing will be required no > matter what, not least because the DocBook has also been written by > humans, and the battle against the GIGO principle is a lost one. and I feel like Don Quichotte :-) -- Markus--
[toc] | [prev] | [next] | [standalone]
| From | Daniel Vetter <daniel.vetter@ffwll.ch> |
|---|---|
| Date | 2016-05-31 10:10 +0200 |
| Message-ID | <rEMUq-73-23@gated-at.bofh.it> |
| In reply to | #1409925 |
On Tue, May 31, 2016 at 9:27 AM, Markus Heiser <markus.heiser@darmarit.de> wrote: >>>> I find it totally unacceptable to require explicitly marking kernel-doc >>>> comments or source files as being reStructuredText. >>>> Note that it's all opt-in already. If you add a .rst file that includes >>>> kernel-doc via the kernel-doc extension, you better make sure the >>>> comments parse as reStructuredText and render nicely. I'm willing to do >>>> much of the job for all the things that I care about. >>> >>> We have a different POV ... I try to build up a documentation project, >>> which could use all given kernel-doc markups without any change, where >>> reST is an "addition". Your approach is to fix kernel-doc comments >>> if they are referred by a kernl-doc directive in a .rst document. >>> There is nothing wrong about your approach, but I try to build >>> a whole source code documentation like the one I started here: >>> http://return42.github.io/sphkerneldoc/linux_src_doc/index.html >> >> That looks nice, but I'll argue it would not be much worse even if you >> assumed it's all rst. > > A superficial look on the HTML output may give the impression. But in > the log you will find tons of errors and warnings. My experience is, > that authors will not consult logs if there are tons of errors from the > beginning, which carries a decrease in quality. IMO not a good starting > point. 0-day builds all docs, and checks for new warnings. Even in today's gpu.tmpl build there's a massive pile of warnings, so yes developers don't look. But 0-day does, and then developers look at the nice mails from 0-day. It mostly works to keep out new fail I think. -Daniel -- Daniel Vetter Software Engineer, Intel Corporation +41 (0) 79 365 57 48 - http://blog.ffwll.ch
[toc] | [prev] | [standalone]
Back to top | Article view | linux.kernel
csiph-web