Skip to content

L
linux
Switch branch/tag
  1. 24 Oct, 2019 1 commit
  3. 18 Oct, 2019 5 commits
  5. 15 Oct, 2019 4 commits
  7. 11 Oct, 2019 2 commits
  9. 10 Oct, 2019 12 commits
  11. 07 Oct, 2019 4 commits
    • Jonathan Corbet's avatar
      docs/driver-api: Catch up with dma_buf file-name changes · f704985b
      Jonathan Corbet authored 
      drivers/dma_buf/reservation.c was renamed to dma-resv.c (and
include/linux/reservation.h to dma-resv.h), but the documentation was not
updated to match, leading to these build errors:

  Error: Cannot open file ./drivers/dma-buf/reservation.c
  Error: Cannot open file ./drivers/dma-buf/reservation.c
  Error: Cannot open file ./drivers/dma-buf/reservation.c
  Error: Cannot open file ./include/linux/reservation.h
  Error: Cannot open file ./include/linux/reservation.h

Update the documentation and make the world happy again.

Fixes: 52791eee ("dma-buf: rename reservation_object to dma_resv')
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
      f704985b
    • Jonathan Corbet's avatar
      genalloc: Fix a set of docs build warnings · ea83df73
      Jonathan Corbet authored 
      Commit 795ee306 ("lib/genalloc: introduce chunk owners") made a number
of changes to the genalloc API and implementation but did not update the
documentation to match, leading to these docs build warnings:

  ./lib/genalloc.c:1: warning: 'gen_pool_add_virt' not found
  ./lib/genalloc.c:1: warning: 'gen_pool_alloc' not found
  ./lib/genalloc.c:1: warning: 'gen_pool_free' not found
  ./lib/genalloc.c:1: warning: 'gen_pool_alloc_algo' not found

Fix these by updating the docs to match new function locations and names,
and by completing the update of one kerneldoc comment.

Fixes: 795ee306 ("lib/genalloc: introduce chunk owners")
Acked-by: default avatarDan Williams <dan.j.williams@intel.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
      ea83df73
    • Jonathan Corbet's avatar
      docs: Catch up with the new location of get_user_pages_fast() · cc84ac35
      Jonathan Corbet authored 
      Commit 050a9adc ("mm: consolidate the get_user_pages* implementations")
moved get_user_pages_fast() from mm/util.c to mm/gup.c, but didn't update
the documentation, leading to this build warning:

  ./mm/util.c:1: warning: 'get_user_pages_fast' not found

Update the docs to match the new reality.

Fixes: 050a9adc ("mm: consolidate the get_user_pages* implementations")
Reviewed-by: default avatarChristoph Hellwig <hch@lst.de>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
      cc84ac35
    • Jonathan Corbet's avatar
      docs: remove :c:func: from refcount-vs-atomic.rst · 81584a6a
      Jonathan Corbet authored 
      As of 5.3, the automarkup extension will do the right thing with function()
notation, so we don't need to clutter the text with :c:func: invocations.
So remove them.

Looking at the generated output reveals that we lack kerneldoc coverage for
much of this API, but that's a separate problem.
Acked-by: default avatarPaul E. McKenney <paulmck@kernel.org>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
      81584a6a
  13. 03 Oct, 2019 5 commits
  15. 02 Oct, 2019 2 commits
    • Kees Cook's avatar
      doc-rst: Programmatically render MAINTAINERS into ReST · aa204855
      Kees Cook authored 
      In order to have the MAINTAINERS file visible in the rendered ReST
output, this makes some small changes to the existing MAINTAINERS file
to allow for better machine processing, and adds a new Sphinx directive
"maintainers-include" to perform the rendering.

Features include:
- Per-subsystem reference links: subsystem maintainer entries can be
  trivially linked to both internally and external. For example:
  https://www.kernel.org/doc/html/latest/process/maintainers.html#secure-computing

- Internally referenced .rst files are linked so they can be followed
  when browsing the resulting rendering. This allows, for example, the
  future addition of maintainer profiles to be automatically linked.

- Field name expansion: instead of the short fields (e.g. "M", "F",
  "K"), use the indicated inline "full names" for the fields (which are
  marked with "*"s in MAINTAINERS) so that a rendered subsystem entry
  is more human readable. Email lists are additionally comma-separated.
  For example:

    SECURE COMPUTING
	Mail:	  Kees Cook <keescook@chromium.org>
	Reviewer: Andy Lutomirski <luto@amacapital.net>,
		  Will Drewry <wad@chromium.org>
	SCM:	  git git://git.kernel.org/pub/scm/linux/kernel/git/kees/linux.git seccomp
	Status:	  Supported
	Files:	  kernel/seccomp.c include/uapi/linux/seccomp.h
		  include/linux/seccomp.h tools/testing/selftests/seccomp/*
		  tools/testing/selftests/kselftest_harness.h
		  userspace-api/seccomp_filter
	Content regex:	\bsecure_computing \bTIF_SECCOMP\b
Signed-off-by: default avatarKees Cook <keescook@chromium.org>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
      aa204855
    • Kees Cook's avatar
      doc-rst: Reduce CSS padding around Field · 1b1438b5
      Kees Cook authored 
      Right now any ":Field Name: Field Contents" lines end up with significant
padding due to CSS from the "table" CSS which rightly needs padding to
make tables readable. However, field lists don't need this as they tend
to be stacked together. The future heavy use of fields in the parsed
MAINTAINERS file needs this cleaned up, and existing users look better
too. Note the needless white space (and misalignment of name/contents)
between "Date" and "Author":

https://www.kernel.org/doc/html/latest/accounting/psi.html

This patch fixes this by lowering the padding with a more specific CSS.
Signed-off-by: default avatarKees Cook <keescook@chromium.org>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
      1b1438b5
  17. 01 Oct, 2019 5 commits
    • Jonathan Corbet's avatar
      docs: No structured comments in kernel/dma/coherent.c · e07f7927
      Jonathan Corbet authored 
      Don't try to extract comments from that file, since there are none to be
had and, seemingly, never have been.
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
      e07f7927
    • Christoph Hellwig's avatar
      Documentation: document earlycon without options for more platforms · e18409c0
      Christoph Hellwig authored 
      The earlycon options without arguments is supposed to work on all
device tree platforms, not just arm64.
Signed-off-by: default avatarChristoph Hellwig <hch@lst.de>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
      e18409c0
    • Adam Zerella's avatar
      docs: perf: Add imx-ddr to documentation index · 0522e130
      Adam Zerella authored 
      Sphinx is currently outputting a warning where
the file 'imx-ddr.rst' is not included in the
documentation index. Additionally, the code
highlighting and doc formatting can be slightly
improved.
Signed-off-by: default avatarAdam Zerella <adam.zerella@gmail.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
      0522e130
    • Jonathan Corbet's avatar
      Merge branch 'dump-struct' into docs-next · 81929718
      Jonathan Corbet authored 
      André Almeida writes:

The current way that scripts/kernel-doc dump structs do not work for
nested structs with attributes (e.g. __packed) and without type alias
(e.g } alias1;). This is due to the way nested structs members are parsed.

Inside dump_struct(), the regex removes attributes and it surrounds
whitespaces. After that, it will do a foreach(id) loop for each alias.
However, we will have an empty string, and then the split function will
return nothing and the foreach will not have any iteration. The code will
then jump the loop and the substitution will fail since $newmember
is uninitialized.

This bug does not happen when the nested struct has no alias and no
attribute, since at process_proto_type() a whitespace is inserted in
order to ensure that the split will not fail. However, with any
attribute, this whitespace will be removed.

This patch solves this by replacing attributes with one whitespace, to
ensure that will have at least one whitespace.

Besides solving this bug at patch 1, I also add support for the
____cacheline_aligned_in_smp atribute at patch 2.

For testing and reproducing, create a file `code.h`:

/**
 * struct foobar - description
 * @number0: desc0
 * @number1: desc1
 * @number2: desc2
 */
struct foo {
	int number0;

	struct  {
		int number1;
	} __packed;

	struct {
		int number2;
	};

 };

I've tested with CRYPTO_MINALIGN_ATTR, __attribute__((__aligned__(8)))
and __aligned() as well. Now, run the `./script/kernel-doc code.h`,
and this is the output:

Use of uninitialized value $newmember in substitution (s///) at
./scripts/kernel-doc line 1152, <IN> line 18.

.. c:type:: struct foo

   description

**Definition**

::

  struct foo {
    int number0;
    struct {
      int number1;
    };
    struct {
      int number2;
    };
  };

**Members**

``number0``
  desc0

``{unnamed_struct}``
  anonymous

``number2``
  desc2

The output will not display the member number1 and will also display an
uninitialized warning. Running after the patch will get rid of the
warning and also display the description for number1:

[...]

**Members**

``number0``
  desc0

``{unnamed_struct}``
  anonymous

``number1``
  desc1

``{unnamed_struct}``
  anonymous

``number2``
  desc2

To test patch [2/2], just replace __packed for
____cacheline_aligned_in_smp and compare how, at the previous stage the
script believes ____cacheline... is an alias for the struct and after
the patch it is removed just as the others attributes.

Finally, I have compared the output of "make htmldocs" with and without
this patch. No new warning were found and one warning regarding
____cacheline_aligned_in_smp at include/linux/netdevice.h was removed.
      81929718
    • André Almeida's avatar
      kernel-doc: add support for ____cacheline_aligned_in_smp attribute · f861537d
      André Almeida authored 
      Subroutine dump_struct uses type attributes to check if the struct
syntax is valid. Then, it removes all attributes before using it for
output. `____cacheline_aligned_in_smp` is an attribute that is
not included in both steps. Add it, since it is used by kernel structs.
Signed-off-by: default avatarAndré Almeida <andrealmeid@collabora.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
      f861537d
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7