13 Jul, 2019

1 commit

  • This adds a new header to asm-generic to allow optionally instrumenting
    architecture-specific asm implementations of bitops.

    This change includes the required change for x86 as reference and
    changes the kernel API doc to point to bitops-instrumented.h instead.
    Rationale: the functions in x86's bitops.h are no longer the kernel API
    functions, but instead the arch_ prefixed functions, which are then
    instrumented via bitops-instrumented.h.

    Other architectures can similarly add support for asm implementations of
    bitops.

    The documentation text was derived from x86 and existing bitops
    asm-generic versions: 1) references to x86 have been removed; 2) as a
    result, some of the text had to be reworded for clarity and consistency.

    Tested using lib/test_kasan with bitops tests (pre-requisite patch).
    Bugzilla ref: https://bugzilla.kernel.org/show_bug.cgi?id=198439

    Link: http://lkml.kernel.org/r/20190613125950.197667-4-elver@google.com
    Signed-off-by: Marco Elver
    Acked-by: Mark Rutland
    Reviewed-by: Andrey Ryabinin
    Cc: Alexander Potapenko
    Cc: Andrey Konovalov
    Cc: Arnd Bergmann
    Cc: Borislav Petkov
    Cc: Dmitry Vyukov
    Cc: "H. Peter Anvin"
    Cc: Ingo Molnar
    Cc: Jonathan Corbet
    Cc: Josh Poimboeuf
    Cc: Peter Zijlstra (Intel)
    Cc: Thomas Gleixner
    Signed-off-by: Andrew Morton
    Signed-off-by: Linus Torvalds

    Marco Elver
     

06 Jun, 2019

2 commits


25 May, 2019

1 commit


15 May, 2019

1 commit

  • For better maintenance and expansion move the mathematic helpers to the
    separate folder.

    No functional change intended.

    Note, the int_sqrt() is not used as a part of lib, so, moved to regular
    obj.

    Link: http://lkml.kernel.org/r/20190323172531.80025-1-andriy.shevchenko@linux.intel.com
    Signed-off-by: Andy Shevchenko
    Signed-off-by: Mauro Carvalho Chehab
    Cc: Randy Dunlap
    Cc: Thierry Reding
    Cc: Lee Jones
    Cc: Daniel Thompson
    Cc: Ray Jui
    [mchehab+samsung@kernel.org: fix broken doc references for div64.c and gcd.c]
    Link: http://lkml.kernel.org/r/734f49bae5d4052b3c25691dfefad59bea2e5843.1555580999.git.mchehab+samsung@kernel.org
    Signed-off-by: Andrew Morton
    Signed-off-by: Linus Torvalds

    Andy Shevchenko
     

15 Jan, 2019

1 commit


04 Jan, 2019

1 commit

  • After 7ca01926463a, legacy rq tagging was removed, so block/blk-tag.c
    does not exists anymore. When generating pdfdocs, sphinx complains about
    this missing file:

    Error: Cannot open file ./block/blk-tag.c
    Error: Cannot open file ./block/blk-tag.c
    Error: Cannot open file ./block/blk-tag.c
    Error: Cannot open file ./block/blk-tag.c

    So remove blk-tag.c traces from kernel-api.rst file to silence these
    warnings.

    Signed-off-by: Marcos Paulo de Souza
    Signed-off-by: Jonathan Corbet

    Marcos Paulo de Souza
     

24 Aug, 2018

3 commits

  • This is basically copy-paste of the memory management section from
    kernel-api.rst with some minor adjustments:

    * The "User Space Memory Access" is moved to the beginning
    * The get_user_pages_fast reference is now a part of "User Space Memory
    Access"
    * And, of course, headings are adjusted with section being promoted to
    chapters

    Link: http://lkml.kernel.org/r/1532626360-16650-6-git-send-email-rppt@linux.vnet.ibm.com
    Signed-off-by: Mike Rapoport
    Reviewed-by: Andrew Morton
    Cc: Jonathan Corbet
    Cc: Matthew Wilcox
    Cc: Michal Hocko
    Signed-off-by: Andrew Morton
    Signed-off-by: Linus Torvalds

    Mike Rapoport
     
  • The string and memory duplication routines fit better to the "String
    Manipulation" section than to "The SLAB Cache".

    Link: http://lkml.kernel.org/r/1532626360-16650-5-git-send-email-rppt@linux.vnet.ibm.com
    Signed-off-by: Mike Rapoport
    Reviewed-by: Andrew Morton
    Cc: Jonathan Corbet
    Cc: Matthew Wilcox
    Cc: Michal Hocko
    Signed-off-by: Andrew Morton
    Signed-off-by: Linus Torvalds

    Mike Rapoport
     
  • Link: http://lkml.kernel.org/r/1532626360-16650-4-git-send-email-rppt@linux.vnet.ibm.com
    Signed-off-by: Mike Rapoport
    Reviewed-by: Andrew Morton
    Cc: Jonathan Corbet
    Cc: Matthew Wilcox
    Cc: Michal Hocko
    Signed-off-by: Andrew Morton
    Signed-off-by: Linus Torvalds

    Mike Rapoport
     

18 Jun, 2018

1 commit


28 Apr, 2018

1 commit

  • Rearrange some kernel-api chapters and sections to group them
    together better.

    - move Bit Operations from Basic C Library Functions to Basic
    Kernel Library Functions (now adjacent to Bitmap Operations since
    they are not typical C library functions)

    - move Sorting from Math Functions to Basic Kernel Library Functions
    since sort functions are more Basic than Math Functions

    - move Text Searching from Math Functions to Basic Kernel Library
    Functions (keep Sorting and Searching close to each other)

    - combine CRC and Math functions together into the (newly named)
    CRC and Math Functions chapter

    Signed-off-by: Randy Dunlap
    Acked-by: Matthew Wilcox
    Signed-off-by: Jonathan Corbet

    Randy Dunlap
     

17 Apr, 2018

1 commit

  • Make lib/textsearch.c usable as kernel-doc.
    Add textsearch() function family to kernel-api documentation.
    Fix kernel-doc warnings in :
    ../include/linux/textsearch.h:65: warning: Incorrect use of kernel-doc format:
    * get_next_block - fetch next block of data
    ../include/linux/textsearch.h:82: warning: Incorrect use of kernel-doc format:
    * finish - finalize/clean a series of get_next_block() calls

    Signed-off-by: Randy Dunlap
    Signed-off-by: David S. Miller

    Randy Dunlap
     

07 Feb, 2018

1 commit


12 Dec, 2017

2 commits


14 Nov, 2017

1 commit

  • Pull documentation updates from Jonathan Corbet:
    "A relatively calm cycle for the docs tree again.

    - The old driver statement has been added to the kernel docs.

    - We have a couple of new helper scripts. find-unused-docs.sh from
    Sayli Karnic will point out kerneldoc comments that are not actually
    used in the documentation. Jani Nikula's
    documentation-file-ref-check finds references to non-existing files.

    - A new ftrace document from Steve Rostedt.

    - Vinod Koul converted the dmaengine docs to RST

    Beyond that, it's mostly simple fixes.

    This set reaches outside of Documentation/ a bit more than most. In
    all cases, the changes are to comment docs, mostly from Randy, in
    places where there didn't seem to be anybody better to take them"

    * tag 'docs-4.15' of git://git.lwn.net/linux: (52 commits)
    documentation: fb: update list of available compiled-in fonts
    MAINTAINERS: update DMAengine documentation location
    dmaengine: doc: ReSTize pxa_dma doc
    dmaengine: doc: ReSTize dmatest doc
    dmaengine: doc: ReSTize client API doc
    dmaengine: doc: ReSTize provider doc
    dmaengine: doc: Add ReST style dmaengine document
    ftrace/docs: Add documentation on how to use ftrace from within the kernel
    bug-hunting.rst: Fix an example and a typo in a Sphinx tag
    scripts: Add a script to find unused documentation
    samples: Convert timers to use timer_setup()
    documentation: kernel-api: add more info on bitmap functions
    Documentation: fix selftests related file refs
    Documentation: fix ref to power basic-pm-debugging
    Documentation: fix ref to trace stm content
    Documentation: fix ref to coccinelle content
    Documentation: fix ref to workqueue content
    Documentation: fix ref to sphinx/kerneldoc.py
    Documentation: fix locking rt-mutex doc refs
    docs: dev-tools: correct Coccinelle version number
    ...

    Linus Torvalds
     

20 Oct, 2017

2 commits

  • Commit 764f80798b95 ("doc: Add RCU files to docbook-generation files")
    added :external: options for RCU source files in the file
    Documentation/core-api/kernel-api.rst. However, this now means nothing,
    so this commit removes them.

    Reported-by: Randy Dunlap
    Reported-by: Akira Yokosawa
    Signed-off-by: Paul E. McKenney
    Signed-off-by: Linus Torvalds

    Paul E. McKenney
     
  • There are some good comments about bitmap operations in lib/bitmap.c
    and include/linux/bitmap.h, so format them for document generation and
    pull them into core-api/kernel-api.rst.

    I converted the "tables" of functions from using tabs to using spaces
    so that they are more readable in the source file and in the generated
    output.

    Signed-off-by: Randy Dunlap
    Signed-off-by: Jonathan Corbet

    Randy Dunlap
     

08 Oct, 2017

1 commit


27 Sep, 2017

3 commits


17 Aug, 2017

1 commit


13 Jul, 2017

1 commit


03 Apr, 2017

3 commits