Commit 05fff6ba authored by Jonathan Corbet's avatar Jonathan Corbet
Browse files

Merge branch 'docs-mw' into docs-next

parents 3ef859a4 69d517e6

Documentation/conf.py

+2 −1
Original line number Diff line number Diff line
@@ -370,7 +370,8 @@ html_static_path = ['sphinx-static'] 
html_use_smartypants = False



# Custom sidebar templates, maps document names to template names.

#html_sidebars = {}

# Note that the RTD theme ignores this.

html_sidebars = { '**': ['searchbox.html', 'localtoc.html', 'sourcelink.html']}



# Additional templates that should be rendered to pages, maps page names to

# template names.

Documentation/asm-annotations.rst→Documentation/core-api/asm-annotations.rst

+4 −3
Original line number Diff line number Diff line
@@ -43,10 +43,11 @@ annotated objects like this, tools can be run on them to generate more useful 
information. In particular, on properly annotated objects, ``objtool`` can be

run to check and fix the object if needed. Currently, ``objtool`` can report

missing frame pointer setup/destruction in functions. It can also

automatically generate annotations for :doc:`ORC unwinder <x86/orc-unwinder>`

automatically generate annotations for the ORC unwinder

(Documentation/x86/orc-unwinder.rst)

for most code. Both of these are especially important to support reliable

stack traces which are in turn necessary for :doc:`Kernel live patching

<livepatch/livepatch>`.

stack traces which are in turn necessary for kernel live patching

(Documentation/livepatch/livepatch.rst).



Caveat and Discussion

---------------------

Documentation/core-api/index.rst

+4 −0
Original line number Diff line number Diff line
@@ -23,6 +23,7 @@ it. 
   printk-formats

   printk-index

   symbol-namespaces

   asm-annotations



Data structures and low-level utilities

=======================================
@@ -44,6 +45,8 @@ Library functionality that is used throughout the kernel. 
   this_cpu_ops

   timekeeping

   errseq

   wrappers/atomic_t

   wrappers/atomic_bitops



Low level entry and exit

========================
@@ -67,6 +70,7 @@ Documentation/locking/index.rst for more related documentation. 
   local_ops

   padata

   ../RCU/index

   wrappers/memory-barriers.rst



Low-level hardware management

=============================

Documentation/core-api/wrappers/atomic_bitops.rst

0 → 100644
+18 −0
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0

   This is a simple wrapper to bring atomic_bitops.txt into the RST world

   until such a time as that file can be converted directly.



=============

Atomic bitops

=============



.. raw:: latex



    \footnotesize



.. include:: ../../atomic_bitops.txt

   :literal:



.. raw:: latex



    \normalsize

Documentation/core-api/wrappers/atomic_t.rst

0 → 100644
+19 −0
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0

   This is a simple wrapper to bring atomic_t.txt into the RST world

   until such a time as that file can be converted directly.



============

Atomic types

============



.. raw:: latex



    \footnotesize



.. include:: ../../atomic_t.txt

   :literal:



.. raw:: latex



    \normalsize