Re: [PATCH v2] docs: Pull LKMM documentation into dev-tools book

[Jonathan Corbet <corbet@lwn.net>]

Akira Yokosawa <akiyks@gmail.com> writes:

> Currently, LKMM docs are not included in any of kernel documentation
> books.
>
> Commit e40573a43d16 ("docs: put atomic*.txt and memory-barriers.txt
> into the core-api book") covered plain-text docs under Documentation/
> by using the "include::" directive along with the ":literal:" option.
>
> As LKMM docs are not under Documentation/, the same approach would not
> work due to the directive's restriction.
>
> As a matter of fact, kernel documentation has an extended directive
> by the name of "kernel-include::", which loosens such restriction and
> accepts any files under the kernel source tree.
>
> Rather than moving LKMM docs around, use the latter and pull them into
> the dev-tools book next to KCSAN.
>
> Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
> Cc: Paul E. McKenney <paulmck@kernel.org>
> ---
> v2:
>   - Rebased on top of docs-next.
>   - v1 was intended to be upstreamed through Paul's lkmm tree.
>     Given the changes queued in Jon's tree where docs build scripts have
>     seen rather radical changes, upstreaming this through Jon's tree
>     sounds reasonable to me.
>   - Removed "$SOURCEDIR/" from path to the "kernel-include::" directives.
>     "kernel-include::" now treats them as relative to kernel source dir.
>   - Amended summary phrase. 
>
>   Paul, could you ack on this change going through Jon's tree?

Applied, thanks.

jon