Skip to content

Commit

Permalink
Rewrite README into RST format
Browse files Browse the repository at this point in the history
README is now included in the main documentation page.
  • Loading branch information
acerv committed Mar 21, 2024
1 parent f176f05 commit 9a40c95
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 278 deletions.
252 changes: 0 additions & 252 deletions README.md

This file was deleted.

29 changes: 29 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
.. SPDX-License-Identifier: GPL-2.0-or-later
Linux Test Project
==================

Linux Test Project is a joint project started by SGI, OSDL and Bull developed
and maintained by SUSE, Red Hat, Fujitsu, IBM, Cisco, Oracle and others. The
project goal is to deliver tests to the open source community that validate
reliability, robustness, and stability of the Linux Kernel.

The testing suites contain a collection of tools for testing the Linux kernel
and related features. Our goal is to improve the Linux kernel and system
libraries by bringing test automation.

.. warning::

LTP tests shouldn't run in production systems. In particular,
growfiles, doio, and iogen, stress the I/O capabilities of the systems and
they are intended to find (or cause) problems.

Some references:

* `Documentation <https://ltp-acerv.readthedocs.io/en/latest/index.html>`_
* `Source code <https://github.com/linux-test-project/ltp>`_
* `Releases <https://github.com/linux-test-project/ltp/releases>`_
* `Mailing List <http://lists.linux.it/listinfo/ltp>`_
* `Working patches (patchwork) <https://patchwork.ozlabs.org/project/ltp/list/>`_
* `Working patches (lore.kernel.org) <https://lore.kernel.org/ltp>`_
* `#ltp @ libera chat <https://libera.chat/>`_
27 changes: 1 addition & 26 deletions doc_new/index.rst
Original file line number Diff line number Diff line change
@@ -1,31 +1,6 @@
.. SPDX-License-Identifier: GPL-2.0-or-later
Linux Test Project
==================

Linux Test Project is a joint project started by SGI, OSDL and Bull developed
and maintained by SUSE, Red Hat, Fujitsu, IBM, Cisco, Oracle and others. The
project goal is to deliver tests to the open source community that validate
reliability, robustness, and stability of the Linux Kernel.

The testing suites contain a collection of tools for testing the Linux kernel
and related features. Our goal is to improve the Linux kernel and system
libraries by bringing test automation.

.. warning::

LTP tests shouldn't run in production systems. In particular,
growfiles, doio, and iogen, stress the I/O capabilities of the systems and
they are intended to find (or cause) problems.

Some references:

* `Source code <https://github.com/linux-test-project/ltp>`_
* `Releases <https://github.com/linux-test-project/ltp/releases>`_
* `Mailing List <http://lists.linux.it/listinfo/ltp>`_
* `Working patches (patchwork) <https://patchwork.ozlabs.org/project/ltp/list/>`_
* `Working patches (lore.kernel.org) <https://lore.kernel.org/ltp>`_
* `#ltp @ libera chat <https://libera.chat/>`_
.. include:: ../README.rst

.. toctree::
:maxdepth: 3
Expand Down

0 comments on commit 9a40c95

Please sign in to comment.