Commit graph

17 commits

Author SHA1 Message Date
Matthew Wilcox
291b9d7368 Improve sparse documentation
Add documentation of -DCONFIG_SPARSE_RCU_POINTER.
I started to add documentation of -D__CHECK_ENDIAN__ as well, but
discovered I'm too late; that's now enabled by default.

Signed-off-by: Matthew Wilcox <mawilcox@microsoft.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2017-02-15 15:09:13 -07:00
Michael S. Tsirkin
dc67a9f70c Documentation/sparse: drop __CHECK_ENDIAN__
It's no longer used.

Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
2016-12-16 00:13:41 +02:00
Michael S. Tsirkin
9536099a8e Documentation/sparse: drop __bitwise__
We dropped __CHECK_ENDIAN__ so __bitwise__ is now an implementation
detail. People should use __bitwise everywhere.

Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
2016-12-16 00:13:40 +02:00
Jani Nikula
57131dd3fd Documentation/dev-tools: use code-block with proper language
Now that we don't have automatic syntax highlighting, use the code-block
directive with the explicitly selected language, where appropriate.

Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-11-03 12:39:06 +02:00
Markus Heiser
c289312f96 doc-rst: make dev-tools folder buildable stand-alone
Add minimal conf.py and moved dev-tools/tools.rst to dev-tools/index.rst
makes the dev-tools folder buildable stand-alone. To build only this
folder run::

  make SPHINXDIRS=dev-tools htmldocs
  make SPHINXDIRS=dev-tools pdfdocs

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-10-26 17:24:54 -06:00
Catalin Marinas
9099daed9c mm: kmemleak: avoid using __va() on addresses that don't have a lowmem mapping
Some of the kmemleak_*() callbacks in memblock, bootmem, CMA convert a
physical address to a virtual one using __va().  However, such physical
addresses may sometimes be located in highmem and using __va() is
incorrect, leading to inconsistent object tracking in kmemleak.

The following functions have been added to the kmemleak API and they take
a physical address as the object pointer.  They only perform the
corresponding action if the address has a lowmem mapping:

kmemleak_alloc_phys
kmemleak_free_part_phys
kmemleak_not_leak_phys
kmemleak_ignore_phys

The affected calling places have been updated to use the new kmemleak
API.

Link: http://lkml.kernel.org/r/1471531432-16503-1-git-send-email-catalin.marinas@arm.com
Signed-off-by: Catalin Marinas <catalin.marinas@arm.com>
Reported-by: Vignesh R <vigneshr@ti.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2016-10-11 15:06:33 -07:00
Jonathan Corbet
5512128f02 Merge branch 'dev-tools' into doc/4.9
Coalesce development-tool documents into a single directory and sphinxify
them.
2016-08-19 11:38:36 -06:00
Jonathan Corbet
5f0962748d docs: Sphinxify gdb-kernel-debugging.txt and move to dev-tools
Acked-by: Jan Kiszka <jan.kiszka@siemens.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-08-18 17:43:24 -06:00
Jonathan Corbet
9c296b46c6 docs: sphinxify kmemcheck.txt and move to dev-tools
Cc: Vegard Nossum <vegardno@ifi.uio.no>
Cc: Pekka Enberg <penberg@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-08-18 17:43:14 -06:00
Jonathan Corbet
ca90a7a387 docs: sphinxify kmemleak.txt and move it to dev-tools
Acked-by: Catalin Marinas <catalin.marinas@arm.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-08-18 17:41:57 -06:00
Jonathan Corbet
1ead009cd6 docs: sphinxify ubsan.txt and move it to dev-tools
Acked-by: Andrey Ryabinin <aryabinin@virtuozzo.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-08-18 17:41:51 -06:00
Jonathan Corbet
2757aafad9 docs: sphinxify kasan.txt and move to dev-tools
No textual changes beyond formatting.

Acked-by: Andrey Ryabinin <aryabinin@virtuozzo.com>
Acked-by: Alexander Potapenko <glider@google.com>
Cc: Dmitry Vyukov <dvyukov@google.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-08-18 17:41:45 -06:00
Jonathan Corbet
2584bab2f9 docs: sphinixfy gcov.txt and move to dev-tools
No textual changes beyond formatting.

Cc: Peter Oberparleiter <oberpar@linux.vnet.ibm.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-08-18 17:41:38 -06:00
Jonathan Corbet
758f726e7f docs: sphinxify kcov.txt and move to dev-tools
Another document added to the dev-tools collection.

Cc: Dmitry Vyukov <dvyukov@google.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-08-18 17:41:27 -06:00
Jonathan Corbet
d228af5bcb docs: sphinxify sparse.txt and move to dev-tools
Fold the sparse document into the development tools set; no changes to the
text itself beyond formatting.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-08-18 17:39:24 -06:00
Jonathan Corbet
4b9033a334 docs: sphinxify coccinelle.txt and add it to dev-tools
No textual changes have been made, but the formatting has obviously been
tweaked.

Cc: Michal Marek <mmarek@suse.com>
Cc: Gilles Muller <Gilles.Muller@lip6.fr>
Acked-by: Nicolas Palix <nicolas.palix@imag.fr>
Acked-by: Julia Lawall <julia.lawall@lip6.fr>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-08-18 17:32:11 -06:00
Jonathan Corbet
059c5e918f docs: create a new dev-tools directory
This directory will be a collecting point for documentation oriented around
development tools.  As a step toward ordering Documentation/ it's a small
one, but we have to start somewhere...

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-08-18 17:31:51 -06:00