Skip to content
  1. May 14, 2022
    • Fabio M. De Francesco's avatar
      Documentation/vm: move "Using kmap-atomic" to highmem.h · 85a85e76
      Fabio M. De Francesco authored
      
      
      The use of kmap_atomic() is new code is being deprecated in favor of
      kmap_local_page().  For this reason the "Using kmap_atomic" section in
      highmem.rst is obsolete and unnecessary, but it can still help developers
      if it were moved to kdocs in highmem.h.
      
      Therefore, move the relevant parts of this section from highmem.rst and
      merge them with the kdocs in highmem.h.
      
      Link: https://lkml.kernel.org/r/20220428212455.892-4-fmdefrancesco@gmail.com
      Signed-off-by: default avatarFabio M. De Francesco <fmdefrancesco@gmail.com>
      Suggested-by: default avatarIra Weiny <ira.weiny@intel.com>
      Reviewed-by: default avatarSebastian Andrzej Siewior <bigeasy@linutronix.de>
      Reviewed-by: default avatarIra Weiny <ira.weiny@intel.com>
      Cc: Jonathan Corbet <corbet@lwn.net>
      Cc: Matthew Wilcox <willy@infradead.org>
      Cc: Peter Zijlstra <peterz@infradead.org>
      Cc: Thomas Gleixner <tglx@linutronix.de>
      Cc: Catalin Marinas <catalin.marinas@arm.com>
      Cc: Mike Rapoport <rppt@linux.ibm.com>
      Cc: Peter Collingbourne <pcc@google.com>
      Cc: Vlastimil Babka <vbabka@suse.cz>
      Cc: Will Deacon <will@kernel.org>
      Cc: Jonathan Corbet <corbet@lwn.net>
      Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
      85a85e76
    • Fabio M. De Francesco's avatar
      Documentation/vm: include kdocs from highmem*.h into highmem.rst · 174270c2
      Fabio M. De Francesco authored
      
      
      kernel-docs that are in include/linux/highmem.h and in
      include/linux/highmem-internal.h should be included in highmem.rst.
      
      Use kdocs directives to include the above-mentioned comments into
      highmem.rst.
      
      Link: https://lkml.kernel.org/r/20220428212455.892-3-fmdefrancesco@gmail.com
      Signed-off-by: default avatarFabio M. De Francesco <fmdefrancesco@gmail.com>
      Acked-by: default avatarMike Rapoport <rppt@linux.ibm.com>
      Reviewed-by: default avatarIra Weiny <ira.weiny@intel.com>
      Suggested-by: default avatarIra Weiny <ira.weiny@intel.com>
      Reviewed-by: default avatarSebastian Andrzej Siewior <bigeasy@linutronix.de>
      Cc: Jonathan Corbet <corbet@lwn.net>
      Cc: Matthew Wilcox <willy@infradead.org>
      Cc: Peter Zijlstra <peterz@infradead.org>
      Cc: Thomas Gleixner <tglx@linutronix.de>
      Cc: Catalin Marinas <catalin.marinas@arm.com>
      Cc: Peter Collingbourne <pcc@google.com>
      Cc: Vlastimil Babka <vbabka@suse.cz>
      Cc: Will Deacon <will@kernel.org>
      Cc: Jonathan Corbet <corbet@lwn.net>
      Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
      174270c2
    • Fabio M. De Francesco's avatar
      mm/highmem: fix kernel-doc warnings in highmem*.h · e7392b4e
      Fabio M. De Francesco authored
      
      
      Patch series "Extend and reorganize Highmem's documentation", v4.
      
      This series has the purpose to extend and reorganize Highmem's
      documentation.
      
      This is a work in progress because some information should still be moved
      from highmem.rst to highmem.h and highmem-internal.h.  Specifically I'm
      talking about moving the "how to" information to the relevant headers, as
      it as been suggested by Ira Weiny (Intel).
      
      Also, this is a work in progress because some kdocs in highmem.h and
      highmem-internal.h should be improved.
      
      
      This patch (of 4):
      
      `scripts/kernel-doc -v -none include/linux/highmem*` reports the following
      warnings:
      
      include/linux/highmem.h:160: warning: expecting prototype for kunmap_atomic(). Prototype was for nr_free_highpages() instead
      include/linux/highmem.h:204: warning: No description found for return value of 'alloc_zeroed_user_highpage_movable'
      include/linux/highmem-internal.h:256: warning: Function parameter or member '__addr' not described in 'kunmap_atomic'
      include/linux/highmem-internal.h:256: warning: Excess function parameter 'addr' description in 'kunmap_atomic'
      
      Fix these warnings by (1) moving the kernel-doc comments from highmem.h to
      highmem-internal.h (which is the file were the kunmap_atomic() macro is
      actually defined), (2) extending and merging it with the comment which was
      already in highmem-internal.h, and (3) using correct parameter names (4)
      correcting a few technical inaccuracies in comments, and (5) adding a
      deprecation notice in kunmap_atomic() for consistency with kmap_atomic().
      
      Link: https://lkml.kernel.org/r/20220428212455.892-1-fmdefrancesco@gmail.com
      Link: https://lkml.kernel.org/r/20220428212455.892-2-fmdefrancesco@gmail.com
      Signed-off-by: default avatarFabio M. De Francesco <fmdefrancesco@gmail.com>
      Reviewed-by: default avatarSebastian Andrzej Siewior <bigeasy@linutronix.de>
      Reviewed-by: default avatarIra Weiny <ira.weiny@intel.com>
      Cc: Matthew Wilcox <willy@infradead.org>
      Cc: Mike Rapoport <rppt@linux.ibm.com>
      Cc: Catalin Marinas <catalin.marinas@arm.com>
      Cc: Will Deacon <will@kernel.org>
      Cc: Peter Collingbourne <pcc@google.com>
      Cc: Vlastimil Babka <vbabka@suse.cz>
      Cc: Jonathan Corbet <corbet@lwn.net>
      Cc: Peter Zijlstra <peterz@infradead.org>
      Cc: Thomas Gleixner <tglx@linutronix.de>
      Cc: Jonathan Corbet <corbet@lwn.net>
      Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
      e7392b4e
  2. May 13, 2022