data_type large_stringclasses 3
values | source large_stringclasses 29
values | code large_stringlengths 98 49.4M | filepath large_stringlengths 5 161 ⌀ | message large_stringclasses 234
values | commit large_stringclasses 234
values | subject large_stringclasses 418
values | critique large_stringlengths 101 1.26M ⌀ | metadata dict |
|---|---|---|---|---|---|---|---|---|
source | linux | =========
Workqueue
=========
:Date: September, 2010
:Author: Tejun Heo <tj@kernel.org>
:Author: Florian Mickler <florian@mickler.org>
Introduction
============
There are many cases where an asynchronous process execution context
is needed and the workqueue (wq) API is the most commonly used
mechanism for such case... | Documentation/core-api/workqueue.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0+
======
XArray
======
:Author: Matthew Wilcox
Overview
========
The XArray is an abstract data type which behaves like a very large array
of pointers. It meets many of the same needs as a hash or a conventional
resizable array. Unlike a hash, it allows you to sensibly go to the... | Documentation/core-api/xarray.rst | null | null | null | null | null |
source | linux | ===============
What is an IRQ?
===============
An IRQ is an interrupt request from a device. Currently, they can come
in over a pin, or over a packet. Several devices may be connected to
the same pin thus sharing an IRQ. Such as on legacy PCI bus: All devices
typically share 4 lanes/pins. Note that each device can re... | Documentation/core-api/irq/concepts.rst | null | null | null | null | null |
source | linux | ====
IRQs
====
.. toctree::
:maxdepth: 1
concepts
irq-affinity
irq-domain
irqflags-tracing | Documentation/core-api/irq/index.rst | null | null | null | null | null |
source | linux | ================
SMP IRQ affinity
================
ChangeLog:
- Started by Ingo Molnar <mingo@redhat.com>
- Update by Max Krasnyansky <maxk@qualcomm.com>
/proc/irq/IRQ#/smp_affinity and /proc/irq/IRQ#/smp_affinity_list specify
which target CPUs are permitted for a given IRQ source. It's a bitmask
(smp_affinity) o... | Documentation/core-api/irq/irq-affinity.rst | null | null | null | null | null |
source | linux | ===============================================
The irq_domain Interrupt Number Mapping Library
===============================================
The current design of the Linux kernel uses a single large number
space where each separate IRQ source is assigned a unique number.
This is simple when there is only one inter... | Documentation/core-api/irq/irq-domain.rst | null | null | null | null | null |
source | linux | =======================
IRQ-flags state tracing
=======================
:Author: started by Ingo Molnar <mingo@redhat.com>
The "irq-flags tracing" feature "traces" hardirq and softirq state, in
that it gives interested subsystems an opportunity to be notified of
every hardirqs-off/hardirqs-on, softirqs-off/softirqs-o... | Documentation/core-api/irq/irqflags-tracing.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0-or-later
==================
Kexec Handover ABI
==================
Core Kexec Handover ABI
========================
.. kernel-doc:: include/linux/kho/abi/kexec_handover.h
:doc: Kexec Handover ABI
vmalloc preservation ABI
========================
.. kernel-doc:: include/linux/k... | Documentation/core-api/kho/abi.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0-or-later
.. _kho-concepts:
========================
Kexec Handover Subsystem
========================
Overview
========
Kexec HandOver (KHO) is a mechanism that allows Linux to preserve memory
regions, which could contain serialized system states, across kexec.
KHO uses :ref:`fl... | Documentation/core-api/kho/index.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=============================================
Porting an architecture to support PREEMPT_RT
=============================================
:Author: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
This list outlines the architecture specific requirements that must be
implemented i... | Documentation/core-api/real-time/architecture-porting.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
===========================
How realtime kernels differ
===========================
:Author: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
Preface
=======
With forced-threaded interrupts and sleeping spin locks, code paths that
previously caused long scheduling latencies have... | Documentation/core-api/real-time/differences.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
====================
Considering hardware
====================
:Author: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
The way a workload is handled can be influenced by the hardware it runs on.
Key components include the CPU, memory, and the buses that connect them.
These reso... | Documentation/core-api/real-time/hardware.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=====================
Real-time preemption
=====================
This documentation is intended for Linux kernel developers and contributors
interested in the inner workings of PREEMPT_RT. It explains key concepts and
the required changes compared to a non-PREEMPT_RT configuration.... | Documentation/core-api/real-time/index.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=====================
Theory of operation
=====================
:Author: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
Preface
=======
PREEMPT_RT transforms the Linux kernel into a real-time kernel. It achieves
this by replacing locking primitives, such as spinlock_t, with a ... | Documentation/core-api/real-time/theory.rst | null | null | null | null | null |
source | linux | .. 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
... | Documentation/core-api/wrappers/atomic_bitops.rst | null | null | null | null | null |
source | linux | .. 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 | Documentation/core-api/wrappers/atomic_t.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
This is a simple wrapper to bring memory-barriers.txt into the RST world
until such a time as that file can be converted directly.
============================
Linux kernel memory barriers
============================
.. raw:: latex
\footnotesize
.. include:: ../../memo... | Documentation/core-api/wrappers/memory-barriers.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=============================================================
General description of the CPUFreq core and CPUFreq notifiers
=============================================================
Authors:
- Dominik Brodowski <linux@brodo.de>
- David Kimdon <dwhedon@debian.org>
- Rafael J... | Documentation/cpu-freq/core.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
===============================================
How to Implement a new CPUFreq Processor Driver
===============================================
Authors:
- Dominik Brodowski <linux@brodo.de>
- Rafael J. Wysocki <rafael.j.wysocki@intel.com>
- Viresh Kumar <viresh.kumar@linaro.o... | Documentation/cpu-freq/cpu-drivers.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
==========================================
General Description of sysfs CPUFreq Stats
==========================================
information for users
Author: Venkatesh Pallipadi <venkatesh.pallipadi@intel.com>
.. Contents
1. Introduction
2. Statistics Provided (with exam... | Documentation/cpu-freq/cpufreq-stats.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
========================================================================
CPUFreq - CPU frequency and voltage scaling code in the Linux(TM) kernel
========================================================================
Author: Dominik Brodowski <linux@brodo.de>
Clock scaling a... | Documentation/cpu-freq/index.rst | null | null | null | null | null |
source | linux | Authenticated Encryption With Associated Data (AEAD)
====================================================
Authenticated Encryption With Associated Data (AEAD) Algorithm Definitions
--------------------------------------------------------------------------
.. kernel-doc:: include/crypto/aead.h
:doc: Authenticated E... | Documentation/crypto/api-aead.rst | null | null | null | null | null |
source | linux | Asymmetric Cipher
=================
Asymmetric Cipher Algorithm Definitions
---------------------------------------
.. kernel-doc:: include/crypto/akcipher.h
:functions: akcipher_alg akcipher_request
Asymmetric Cipher API
---------------------
.. kernel-doc:: include/crypto/akcipher.h
:doc: Generic Public Key... | Documentation/crypto/api-akcipher.rst | null | null | null | null | null |
source | linux | Message Digest
==============
Message Digest Algorithm Definitions
------------------------------------
.. kernel-doc:: include/crypto/hash.h
:doc: Message Digest Algorithm Definitions
.. kernel-doc:: include/crypto/hash.h
:functions: hash_alg_common ahash_alg shash_alg
Asynchronous Message Digest API
-------... | Documentation/crypto/api-digest.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=============================
Scatterlist Cryptographic API
=============================
Introduction
============
The Scatterlist Crypto API takes page vectors (scatterlists) as
arguments, and works directly on pages. In some cases (e.g. ECB
mode ciphers), this will allow for p... | Documentation/crypto/api-intro.rst | null | null | null | null | null |
source | linux | Key-agreement Protocol Primitives (KPP)
=======================================
Key-agreement Protocol Primitives (KPP) Cipher Algorithm Definitions
--------------------------------------------------------------------
.. kernel-doc:: include/crypto/kpp.h
:functions: kpp_request crypto_kpp kpp_alg kpp_secret
Key-a... | Documentation/crypto/api-kpp.rst | null | null | null | null | null |
source | linux | Random Number Generator (RNG)
=============================
Random Number Algorithm Definitions
-----------------------------------
.. kernel-doc:: include/crypto/rng.h
:functions: rng_alg
Crypto API Random Number API
----------------------------
.. kernel-doc:: include/crypto/rng.h
:doc: Random number genera... | Documentation/crypto/api-rng.rst | null | null | null | null | null |
source | linux | Code Examples
=============
Code Example For Symmetric Key Cipher Operation
-----------------------------------------------
This code encrypts some data with AES-256-XTS. For sake of example,
all inputs are random bytes, the encryption is done in-place, and it's
assumed the code is running in a context where it can ... | Documentation/crypto/api-samples.rst | null | null | null | null | null |
source | linux | Asymmetric Signature
====================
Asymmetric Signature Algorithm Definitions
------------------------------------------
.. kernel-doc:: include/crypto/sig.h
:functions: sig_alg
Asymmetric Signature API
------------------------
.. kernel-doc:: include/crypto/sig.h
:doc: Generic Public Key Signature API... | Documentation/crypto/api-sig.rst | null | null | null | null | null |
source | linux | Symmetric Key Cipher
====================
Block Cipher Algorithm Definitions
----------------------------------
.. kernel-doc:: include/linux/crypto.h
:doc: Block Cipher Algorithm Definitions
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_alg cipher_alg compress_alg
Symmetric Key Cipher API
-------... | Documentation/crypto/api-skcipher.rst | null | null | null | null | null |
source | linux | Programming Interface
=====================
.. toctree::
:caption: Table of contents
:maxdepth: 2
api-skcipher
api-aead
api-digest
api-rng
api-akcipher
api-sig
api-kpp | Documentation/crypto/api.rst | null | null | null | null | null |
source | linux | Kernel Crypto API Architecture
==============================
Cipher algorithm types
----------------------
The kernel crypto API provides different API calls for the following
cipher types:
- Symmetric ciphers
- AEAD ciphers
- Message digest, including keyed message digest
- Random number generation
- User... | Documentation/crypto/architecture.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=============================================
Asymmetric / Public-key Cryptography Key Type
=============================================
.. Contents:
- Overview.
- Key identification.
- Accessing asymmetric keys.
- Signature verification.
- Asymmetric key subtypes.
... | Documentation/crypto/asymmetric-keys.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=====================================
Asynchronous Transfers/Transforms API
=====================================
.. Contents
1. INTRODUCTION
2 GENEALOGY
3 USAGE
3.1 General format of the API
3.2 Supported operations
3.3 Descriptor management
3.4 When does the oper... | Documentation/crypto/async-tx-api.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
Crypto Engine
=============
Overview
--------
The crypto engine (CE) API is a crypto queue manager.
Requirement
-----------
You must put, at the start of your transform context your_tfm_ctx, the structure
crypto_engine:
::
struct your_tfm_ctx {
struct crypto_engine engine;
... | Documentation/crypto/crypto_engine.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. include:: <isonum.txt>
===========================================
Fast & Portable DES encryption & decryption
===========================================
.. note::
Below is the original README file from the descore.shar package,
converted to ReST format.
---------------... | Documentation/crypto/descore-readme.rst | null | null | null | null | null |
source | linux | Developing Cipher Algorithms
============================
Registering And Unregistering Transformation
--------------------------------------------
There are three distinct types of registration functions in the Crypto
API. One is used to register a generic cryptographic transformation,
while the other two are specif... | Documentation/crypto/devel-algos.rst | null | null | null | null | null |
source | linux | ==========
Crypto API
==========
:Author: Stephan Mueller
:Author: Marek Vasut
This documentation outlines the Linux kernel crypto API with its
concepts, details about developing cipher implementations, employment of the API
for cryptographic use cases, as well as programming examples.
.. toctree::
:caption: Tabl... | Documentation/crypto/index.rst | null | null | null | null | null |
source | linux | Kernel Crypto API Interface Specification
=========================================
Introduction
------------
The kernel crypto API offers a rich set of cryptographic ciphers as well
as other data transformation mechanisms and methods to invoke these.
This document contains a description of the API and provides examp... | Documentation/crypto/intro.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
===========================
Kerberos V Cryptography API
===========================
.. Contents:
- Overview.
- Small Buffer.
- Encoding Type.
- Key Derivation.
- PRF+ Calculation.
- Kc, Ke And Ki Derivation.
- Crypto Functions.
- Preparation Functions.
... | Documentation/crypto/krb5.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0-or-later
==========================
SHA-3 Algorithm Collection
==========================
.. contents::
Overview
========
The SHA-3 family of algorithms, as specified in NIST FIPS-202 [1]_, contains six
algorithms based on the Keccak sponge function. The differences between them... | Documentation/crypto/sha3.rst | null | null | null | null | null |
source | linux | User Space Interface
====================
Introduction
------------
The concepts of the kernel crypto API visible to kernel space is fully
applicable to the user space interface as well. Therefore, the kernel
crypto API high level discussion for the in-kernel use cases applies
here as well.
The major difference, how... | Documentation/crypto/userspace-if.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
Hardware Device Driver Specific Documentation
---------------------------------------------
.. toctree::
:maxdepth: 1
octeontx2 | Documentation/crypto/device_drivers/index.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=========================
octeontx2 devlink support
=========================
This document describes the devlink features implemented by the ``octeontx2 CPT``
device drivers.
Parameters
==========
The ``octeontx2`` driver implements the following driver-specific parameters.
.. ... | Documentation/crypto/device_drivers/octeontx2.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
===================================
Using AutoFDO with the Linux kernel
===================================
This enables AutoFDO build support for the kernel when using
the Clang compiler. AutoFDO (Auto-Feedback-Directed Optimization)
is a type of profile-guided optimization (PGO) ... | Documentation/dev-tools/autofdo.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0-only
==========
Checkpatch
==========
Checkpatch (scripts/checkpatch.pl) is a perl script which checks for trivial
style violations in patches and optionally corrects them. Checkpatch can
also be run on file contexts and without the kernel tree.
Checkpatch is not always right. Yo... | Documentation/dev-tools/checkpatch.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0-only
============
UAPI Checker
============
The UAPI checker (``scripts/check-uapi.sh``) is a shell script which
checks UAPI header files for userspace backwards-compatibility across
the git tree.
Options
=======
This section will describe the options with which ``check-uapi.sh``... | Documentation/dev-tools/checkuapi.rst | null | null | null | null | null |
source | linux | .. _clangformat:
clang-format
============
``clang-format`` is a tool to format C/C++/... code according to
a set of rules and heuristics. Like most tools, it is not perfect
nor covers every single case, but it is good enough to be helpful.
``clang-format`` can be used for several purposes:
- Quickly reformat a b... | Documentation/dev-tools/clang-format.rst | null | null | null | null | null |
source | linux | .. Copyright 2010 Nicolas Palix <npalix@diku.dk>
.. Copyright 2010 Julia Lawall <julia@diku.dk>
.. Copyright 2010 Gilles Muller <Gilles.Muller@lip6.fr>
.. highlight:: none
.. _devtools_coccinelle:
Coccinelle
==========
Coccinelle is a tool for pattern matching and text transformation that has
many uses in kernel de... | Documentation/dev-tools/coccinelle.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0-only
.. Copyright (C) 2025 Guillaume Tucker
====================
Containerized Builds
====================
The ``container`` tool can be used to run any command in the kernel source tree
from within a container. Doing so facilitates reproducing builds across
various platforms, for... | Documentation/dev-tools/container.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. Copyright (C) 2025, Google LLC.
.. _context-analysis:
Compiler-Based Context Analysis
===============================
Context Analysis is a language extension, which enables statically checking
that required contexts are active (or inactive) by acquiring and releasing
user-defi... | Documentation/dev-tools/context-analysis.rst | null | null | null | null | null |
source | linux | Using gcov with the Linux kernel
================================
gcov profiling kernel support enables the use of GCC's coverage testing
tool gcov_ with the Linux kernel. Coverage data of a running kernel
is exported in gcov-compatible format via the "gcov" debugfs directory.
To get coverage data for a specific file,... | Documentation/dev-tools/gcov.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=============================================
Linux Kernel GPIO based sloppy logic analyzer
=============================================
:Author: Wolfram Sang
Introduction
============
This document briefly describes how to run the GPIO based in-kernel sloppy
logic analyzer runn... | Documentation/dev-tools/gpio-sloppy-logic-analyzer.rst | null | null | null | null | null |
source | linux | ================================
Development tools for the kernel
================================
This document is a collection of documents about development tools that can
be used to work on the kernel. For now, the documents have been pulled
together without any significant effort to integrate them into a coherent... | Documentation/dev-tools/index.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. Copyright (C) 2023, Google LLC.
Kernel Address Sanitizer (KASAN)
================================
Overview
--------
Kernel Address Sanitizer (KASAN) is a dynamic memory safety error detector
designed to find out-of-bounds and use-after-free bugs.
KASAN has three modes:
1. Gen... | Documentation/dev-tools/kasan.rst | null | null | null | null | null |
source | linux | KCOV: code coverage for fuzzing
===============================
KCOV collects and exposes kernel code coverage information in a form suitable
for coverage-guided fuzzing. Coverage data of a running kernel is exported via
the ``kcov`` debugfs file. Coverage collection is enabled on a task basis, and
thus KCOV can captu... | Documentation/dev-tools/kcov.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. Copyright (C) 2019, Google LLC.
Kernel Concurrency Sanitizer (KCSAN)
====================================
The Kernel Concurrency Sanitizer (KCSAN) is a dynamic race detector, which
relies on compile-time instrumentation, and uses a watchpoint-based sampling
approach to detect ra... | Documentation/dev-tools/kcsan.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. Copyright (C) 2020, Google LLC.
Kernel Electric-Fence (KFENCE)
==============================
Kernel Electric-Fence (KFENCE) is a low-overhead sampling-based memory safety
error detector. KFENCE detects heap out-of-bounds access, use-after-free, and
invalid-free errors.
KFENCE ... | Documentation/dev-tools/kfence.rst | null | null | null | null | null |
source | linux | Kernel Memory Leak Detector
===========================
Kmemleak provides a way of detecting possible kernel memory leaks in a
way similar to a `tracing garbage collector
<https://en.wikipedia.org/wiki/Tracing_garbage_collection>`_,
with the difference that the orphan objects are not freed but only
reported via /sys/k... | Documentation/dev-tools/kmemleak.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. Copyright (C) 2022, Google LLC.
===============================
Kernel Memory Sanitizer (KMSAN)
===============================
KMSAN is a dynamic error detector aimed at finding uses of uninitialized
values. It is based on compiler instrumentation, and is quite similar to the
u... | Documentation/dev-tools/kmsan.rst | null | null | null | null | null |
source | linux | ======================
Linux Kernel Selftests
======================
The kernel contains a set of "self tests" under the tools/testing/selftests/
directory. These are intended to be small tests to exercise individual code
paths in the kernel. Tests are intended to be run after building, installing
and booting a kernel... | Documentation/dev-tools/kselftest.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
===================================================
The Kernel Test Anything Protocol (KTAP), version 1
===================================================
TAP, or the Test Anything Protocol is a format for specifying test results used
by a number of projects. Its website and speci... | Documentation/dev-tools/ktap.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=====================================
Using Propeller with the Linux kernel
=====================================
This enables Propeller build support for the kernel when using Clang
compiler. Propeller is a profile-guided optimization (PGO) method used
to optimize binary executabl... | Documentation/dev-tools/propeller.rst | null | null | null | null | null |
source | linux | .. Copyright 2004 Linus Torvalds
.. Copyright 2004 Pavel Machek <pavel@ucw.cz>
.. Copyright 2006 Bob Copeland <me@bobcopeland.com>
Sparse
======
Sparse is a semantic checker for C programs; it can be used to find a
number of potential problems with kernel code. See
https://lwn.net/Articles/689907/ for an overview of... | Documentation/dev-tools/sparse.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. Copyright (c) 2024 Collabora Ltd
=============================
Device testing with kselftest
=============================
There are a few different kselftests available for testing devices generically,
with some overlap in coverage and different requirements. This document aim... | Documentation/dev-tools/testing-devices.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
====================
Kernel Testing Guide
====================
There are a number of different tools for testing the Linux kernel, so knowing
when to use each of them can be a challenge. This document provides a rough
overview of their differences, and how they fit together.
Wri... | Documentation/dev-tools/testing-overview.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
Undefined Behavior Sanitizer - UBSAN
====================================
UBSAN is a runtime undefined behaviour checker.
UBSAN uses compile-time instrumentation to catch undefined behavior (UB).
Compiler inserts code that perform certain kinds of checks before operations
that may... | Documentation/dev-tools/ubsan.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
==================
KUnit Architecture
==================
The KUnit architecture is divided into two parts:
- `In-Kernel Testing Framework`_
- `kunit_tool (Command-line Test Harness)`_
In-Kernel Testing Framework
===========================
The kernel testing library supports KUn... | Documentation/dev-tools/kunit/architecture.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
==========================
Frequently Asked Questions
==========================
How is this different from Autotest, kselftest, and so on?
==========================================================
KUnit is a unit testing framework. Autotest, kselftest (and some others) are
not.
... | Documentation/dev-tools/kunit/faq.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=================================
KUnit - Linux Kernel Unit Testing
=================================
.. toctree::
:maxdepth: 2
:caption: Contents:
start
architecture
run_wrapper
run_manual
usage
api/index
style
faq
running_tips
This section details the kernel unit tes... | Documentation/dev-tools/kunit/index.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
============================
Run Tests without kunit_tool
============================
If we do not want to use kunit_tool (For example: we want to integrate
with other systems, or run tests on real hardware), we can
include KUnit in any kernel, read out results, and parse manually... | Documentation/dev-tools/kunit/run_manual.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=============================
Running tests with kunit_tool
=============================
We can either run KUnit tests using kunit_tool or can run tests
manually, and then use kunit_tool to parse the results. To run tests
manually, see: Documentation/dev-tools/kunit/run_manual.rst... | Documentation/dev-tools/kunit/run_wrapper.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
============================
Tips For Running KUnit Tests
============================
Using ``kunit.py run`` ("kunit tool")
=====================================
Running from any directory
--------------------------
It can be handy to create a bash function like:
.. code-block:... | Documentation/dev-tools/kunit/running_tips.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
===============
Getting Started
===============
This page contains an overview of the kunit_tool and KUnit framework,
teaching how to run existing tests and then how to write a simple test case,
and covers common problems users face when using KUnit for the first time.
Installing ... | Documentation/dev-tools/kunit/start.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
===========================
Test Style and Nomenclature
===========================
To make finding, writing, and using KUnit tests as simple as possible, it is
strongly encouraged that they are named and written according to the guidelines
below. While it is possible to write KUni... | Documentation/dev-tools/kunit/style.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
Writing Tests
=============
Test Cases
----------
The fundamental unit in KUnit is the test case. A test case is a function with
the signature ``void (*)(struct kunit *test)``. It calls the function under test
and then sets *expectations* for what should happen. For example:
.. c... | Documentation/dev-tools/kunit/usage.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
========
Clk API
========
The KUnit clk API is used to test clk providers and clk consumers.
.. kernel-doc:: drivers/clk/clk_kunit_helpers.c
:export: | Documentation/dev-tools/kunit/api/clk.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
========================
Function Redirection API
========================
Overview
========
When writing unit tests, it's important to be able to isolate the code being
tested from other parts of the kernel. This ensures the reliability of the test
(it won't be affected by extern... | Documentation/dev-tools/kunit/api/functionredirection.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=============
API Reference
=============
.. toctree::
:hidden:
test
resource
functionredirection
clk
of
platformdevice
This page documents the KUnit kernel testing API. It is divided into the
following sections:
Core KUnit API
==============
Documentation/dev-tools/kuni... | Documentation/dev-tools/kunit/api/index.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
====================
Device Tree (OF) API
====================
The KUnit device tree API is used to test device tree (of_*) dependent code.
.. kernel-doc:: include/kunit/of.h
:internal:
.. kernel-doc:: drivers/of/of_kunit_helpers.c
:export: | Documentation/dev-tools/kunit/api/of.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
===================
Platform Device API
===================
The KUnit platform device API is used to test platform devices.
.. kernel-doc:: lib/kunit/platform.c
:export: | Documentation/dev-tools/kunit/api/platformdevice.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
============
Resource API
============
This file documents the KUnit resource API.
Most users won't need to use this API directly, power users can use it to store
state on a per-test basis, register custom cleanup actions, and more.
.. kernel-doc:: include/kunit/resource.h
:in... | Documentation/dev-tools/kunit/api/resource.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
========
Test API
========
This file documents all of the standard testing API.
.. kernel-doc:: include/kunit/test.h
:internal: | Documentation/dev-tools/kunit/api/test.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
============================================
Linux Kernel Memory Consistency Model (LKMM)
============================================
This section literally renders documents under ``tools/memory-model/``
and ``tools/memory-model/Documentation/``, which are maintained in
the *pure... | Documentation/dev-tools/lkmm/index.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
README (for LKMM)
=================
Literal include of ``tools/memory-model/README``.
------------------------------------------------------------
.. kernel-include:: tools/memory-model/README
:literal: | Documentation/dev-tools/lkmm/readme.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
Access Marking
--------------
Literal include of ``tools/memory-model/Documentation/access-marking.txt``.
------------------------------------------------------------------
.. kernel-include:: tools/memory-model/Documentation/access-marking.txt
:literal: | Documentation/dev-tools/lkmm/docs/access-marking.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
Cheatsheet
----------
Literal include of ``tools/memory-model/Documentation/cheatsheet.txt``.
------------------------------------------------------------------
.. kernel-include:: tools/memory-model/Documentation/cheatsheet.txt
:literal: | Documentation/dev-tools/lkmm/docs/cheatsheet.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
Control Dependencies
--------------------
Literal include of ``tools/memory-model/Documentation/control-dependencies.txt``.
------------------------------------------------------------------
.. kernel-include:: tools/memory-model/Documentation/control-dependencies.txt
:literal... | Documentation/dev-tools/lkmm/docs/control-dependencies.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
Explanation
-----------
Literal include of ``tools/memory-model/Documentation/explanation.txt``.
------------------------------------------------------------------
.. kernel-include:: tools/memory-model/Documentation/explanation.txt
:literal: | Documentation/dev-tools/lkmm/docs/explanation.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
Glossary
--------
Literal include of ``tools/memory-model/Documentation/glossary.txt``.
------------------------------------------------------------------
.. kernel-include:: tools/memory-model/Documentation/glossary.txt
:literal: | Documentation/dev-tools/lkmm/docs/glossary.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
herd-representation
-------------------
Literal include of ``tools/memory-model/Documentation/herd-representation.txt``.
------------------------------------------------------------------
.. kernel-include:: tools/memory-model/Documentation/herd-representation.txt
:literal: | Documentation/dev-tools/lkmm/docs/herd-representation.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
Documentation
=============
.. toctree::
:maxdepth: 1
readme
simple
ordering
litmus-tests
locking
recipes
control-dependencies
access-marking
cheatsheet
explanation
herd-representation
glossary
references | Documentation/dev-tools/lkmm/docs/index.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
Litmus Tests
------------
Literal include of ``tools/memory-model/Documentation/litmus-tests.txt``.
------------------------------------------------------------------
.. kernel-include:: tools/memory-model/Documentation/litmus-tests.txt
:literal: | Documentation/dev-tools/lkmm/docs/litmus-tests.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
Locking
-------
Literal include of ``tools/memory-model/Documentation/locking.txt``.
------------------------------------------------------------------
.. kernel-include:: tools/memory-model/Documentation/locking.txt
:literal: | Documentation/dev-tools/lkmm/docs/locking.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
Ordering
--------
Literal include of ``tools/memory-model/Documentation/ordering.txt``.
------------------------------------------------------------------
.. kernel-include:: tools/memory-model/Documentation/ordering.txt
:literal: | Documentation/dev-tools/lkmm/docs/ordering.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
README (for LKMM Documentation)
-------------------------------
Literal include of ``tools/memory-model/Documentation/README``.
------------------------------------------------------------------
.. kernel-include:: tools/memory-model/Documentation/README
:literal: | Documentation/dev-tools/lkmm/docs/readme.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
Recipes
-------
Literal include of ``tools/memory-model/Documentation/recipes.txt``.
------------------------------------------------------------------
.. kernel-include:: tools/memory-model/Documentation/recipes.txt
:literal: | Documentation/dev-tools/lkmm/docs/recipes.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
References
----------
Literal include of ``tools/memory-model/Documentation/references.txt``.
------------------------------------------------------------------
.. kernel-include:: tools/memory-model/Documentation/references.txt
:literal: | Documentation/dev-tools/lkmm/docs/references.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
Simple
------
Literal include of ``tools/memory-model/Documentation/simple.txt``.
------------------------------------------------------------------
.. kernel-include:: tools/memory-model/Documentation/simple.txt
:literal: | Documentation/dev-tools/lkmm/docs/simple.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=====================
Devicetree Changesets
=====================
A Devicetree changeset is a method which allows one to apply changes
in the live tree in such a way that either the full set of changes
will be applied, or none of them will be. If an error occurs partway
through app... | Documentation/devicetree/changesets.rst | null | null | null | null | null |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.