LISA Documentation

LISA - “Linux Integrated System Analysis” is a toolkit for interactive analysis and automated regression testing of Linux kernel behaviour.

• See the README on the project’s GitLab home page for an overview.

• Once you have LISA running, take a look at the tutorial and example notebooks included with the installation.

Contributions to LISA and its documentation are very welcome, and handled via GitLab merge requests.

Contents:

• ────── Getting started ──────
• Overview
• Setup
  • Installation
  • Updating
  • What next ?
• Workflows
  • Notebooks
  • Automated testing
  • Workload Automation
• ──── Tools documentation ────
• LISA shell
  • Description
  • Activation
  • Commands
  • Environment variables
• Bisector Documentation
  • Overview
  • Contents
  • Indices and tables
• Exekall Documentation
  • Overview
  • Contents
  • Indices and tables
• ───── API documentation ─────
• Target
  • Introduction
  • Connecting to a target
  • Platform data
  • API
• Workloads
  • Introduction
  • Available workloads
• Kernel testing
  • Introduction
  • Available tests
  • Running tests
  • Writing tests
  • API
• Kernel trace analysis
  • Introduction
  • Trace
  • Available analysis
  • API
• Energy analysis
  • Introduction
  • Energy model
  • Energy meters
  • API
• Miscellaneous utilities
  • Configuration management
  • Regression testing
  • Utilities
  • Kernel modules
  • Generic types
  • Typeclasses
  • Monads
  • Fuzzing
  • Dataframe and Series handling utilities
  • Interactive notebooks utilities
  • PELT signals simulations
  • Sphinx documentation
  • Version
• Statistical comparison
  • Statistical comparisons
  • Workload Automation
• ──────── Changes ────────
• APIs stability
• Versioning
• Changelog
  • Next release
  • v3.1.0
  • v3.0.1
  • v3.0.0
  • v2.0.0
• Breaking changes
• Deprecated APIs
  • Deprecated names to be removed in 4.0
• Release Process
• Transitioning from LISA legacy
  • Global changes
  • API Changes
• Contributor’s guide
  • How to submit a merge request
  • How to reach us
  • Coding style
  • Documentation
  • Commits
  • Subtrees
  • Validating your changes
  • Updating binary tools

Indices and tables

• Index

• Module Index

• Search Page

Building this documentation

• Install doc optional dependencies of lisa package (lisa-install does that by default)

• Run:

  source init_env
  lisa-doc-build
  

• Find the HTML in doc/_build/html