Skip to content

Commit 4a72aad

Browse files
acervpevik
authored andcommitted
New LTP documentation
The new LTP documentation is meant to use Sphinx as the main documentation framework, with ReconStructedText as the main language. All the conversion has been done step-by-step, each chapter at time, updating English syntax and fixing typos. There are minor improvements, but overall the structure is the same. The API chapters is ongoing and it will be completed soon in the future. The old documentation has been moved into doc/old folder, but it will removed once new documentation will be completed. Link: https://lore.kernel.org/ltp/[email protected]/ Reviewed-by: Cyril Hrubis <[email protected]> Reviewed-by: Petr Vorel <[email protected]> Signed-off-by: Andrea Cervesato <[email protected]>
1 parent 0ac55a6 commit 4a72aad

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+3119
-261
lines changed

.readthedocs.yml

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
version: 2
2+
3+
build:
4+
os: "ubuntu-22.04"
5+
tools:
6+
python: "3.6"
7+
apt_packages:
8+
- enchant-2
9+
- hunspell-en-us
10+
11+
# Build from the doc/ directory with Sphinx
12+
sphinx:
13+
configuration: doc/conf.py
14+
15+
# Explicitly set the version of Python and its requirements
16+
python:
17+
install:
18+
- requirements: doc/requirements.txt

README.md

-252
This file was deleted.

README.rst

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
.. SPDX-License-Identifier: GPL-2.0-or-later
2+
3+
Linux Test Project
4+
==================
5+
6+
Linux Test Project is a joint project started by SGI, OSDL and Bull developed
7+
and maintained by SUSE, Red Hat, Fujitsu, IBM, Cisco, Oracle and others. The
8+
project goal is to deliver tests to the open source community that validate
9+
reliability, robustness, and stability of the Linux Kernel.
10+
11+
The testing suites contain a collection of tools for testing the Linux kernel
12+
and related features. Our goal is to improve the Linux kernel and system
13+
libraries by bringing test automation.
14+
15+
.. warning::
16+
17+
LTP tests shouldn't run in production systems. In particular,
18+
growfiles, doio, and iogen, stress the I/O capabilities of the systems and
19+
they are intended to find (or cause) problems.
20+
21+
Some references:
22+
23+
* `Documentation <http://linux-test-project.rtfd.io/>`_
24+
* `Source code <https://github.com/linux-test-project/ltp>`_
25+
* `Releases <https://github.com/linux-test-project/ltp/releases>`_
26+
* `Mailing List <http://lists.linux.it/listinfo/ltp>`_
27+
* `Working patches (patchwork) <https://patchwork.ozlabs.org/project/ltp/list/>`_
28+
* `Working patches (lore.kernel.org) <https://lore.kernel.org/ltp>`_
29+
* `#ltp @ libera chat <https://libera.chat/>`_

doc/.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
html/
2+
build/
3+
_static/syscalls.rst
4+
syscalls.tbl

doc/Makefile

+6-9
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
1-
# SPDX-License-Identifier: GPL-2.0-or-later
2-
# Copyright (C) 2009, Cisco Systems Inc.
3-
# Ngie Cooper, July 2009
1+
all:
2+
sphinx-build -b html . html
43

5-
top_srcdir ?= ..
4+
spelling:
5+
sphinx-build -b spelling -d build/doctree . build/spelling
66

7-
include $(top_srcdir)/include/mk/env_pre.mk
8-
9-
RECURSIVE_TARGETS := install
10-
11-
include $(top_srcdir)/include/mk/generic_trunk_target.mk
7+
clean:
8+
rm -rf html/

doc/_static/custom.css

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/* set multiline tables cells */
2+
.wy-table-responsive table td {
3+
white-space: normal;
4+
}

0 commit comments

Comments
 (0)