Skip to content

Commit

Permalink
README.rst: fix formatting
Browse files Browse the repository at this point in the history
With the introduction of the information about tags, the bullet point
list did not render properly.  Also the list of (implicit) references
is now a sub section and also formats properly.

Signed-off-by: Cleber Rosa <[email protected]>
  • Loading branch information
clebergnu committed Jun 5, 2017
1 parent 6038a62 commit e747391
Showing 1 changed file with 15 additions and 12 deletions.
27 changes: 15 additions & 12 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Avocado Misc Tests
==================

This repository is dedicated to host any tests written using the avocado [1]
This repository is dedicated to host any tests written using the Avocado[1]
API. It is being initially populated with tests ported from autotest
client tests repository, but it's not limited by that.

Expand All @@ -21,21 +21,24 @@ Tests are be organized per category basis, each category with its own
directory. Additionally, the tests are categorized by the use of the
following tags[2] by functional area:

* cpu - Exercises a system's CPU
* net - Exercises a system's network devices or networking stack
* storage - Exercises a system's local storage
* fs - Exercises a system's file system
* cpu - Exercises a system's CPU
* net - Exercises a system's network devices or networking stack
* storage - Exercises a system's local storage
* fs - Exercises a system's file system

Tags by architecture:

* x86_64 - Requires a x86_64 architecture
* power - Requires a Power architecture
* x86_64 - Requires a x86_64 architecture
* power - Requires a Power architecture

Tags by access privileges:

* privileged - requires the test to be run with the most privileged,
unrestricted privileges. For Linux systems, this usually means the
root account
* privileged - requires the test to be run with the most privileged,
unrestricted privileges. For Linux systems, this usually means the
root account

[1] https://github.com/avocado-framework/avocado
[2] http://avocado-framework.readthedocs.io/en/latest/WritingTests.html#categorizing-tests
References:
-----------

1. https://github.com/avocado-framework/avocado
2. http://avocado-framework.readthedocs.io/en/latest/WritingTests.html#categorizing-tests

0 comments on commit e747391

Please sign in to comment.