Skip to content

Commit 245d3f9

Browse files
committed
doc: cleanup install/usage documentation in quickstart
Signed-off-by: Andrea Cervesato <andrea.cervesato@suse.com>
1 parent 57bf00f commit 245d3f9

1 file changed

Lines changed: 19 additions & 25 deletions

File tree

doc/users/quickstart.rst

Lines changed: 19 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,68 +3,62 @@
33
Start using kirk
44
================
55

6-
The tool works out of the box by running `kirk` script.
6+
The tool works out of the box by running ``kirk`` script.
77
Minimum python requirement is 3.6+ and *optional* dependences are the following:
88

99
- `asyncssh <https://pypi.org/project/asyncssh/>`_ for SSH support
1010
- `msgpack <https://pypi.org/project/msgpack/>`_ for LTX support
1111

12-
`kirk` will detect if dependences are installed and activate the corresponding
13-
support. If no dependences are provided by the OS's package manager,
14-
`virtualenv` can be used to install them:
12+
kirk will detect if dependences are installed and activate the corresponding
13+
support.
14+
15+
To use kirk via git repository:
1516

1617
.. code-block:: bash
1718
18-
# download source code
1919
git clone git@github.com:acerv/kirk.git
20-
cd kirk
21-
22-
# create your virtual environment (python-3.6+)
23-
virtualenv .venv
20+
export PATH=$PATH:$PWD/kirk
2421
25-
# activate virtualenv
26-
source .venv/bin/activate
22+
kirk --help
2723
28-
# SSH support
29-
pip install asyncssh
24+
kirk is also present in `pypi <https://pypi.org/project/kirk>`_ and it can be
25+
installed via ``pip`` command:
3026

31-
# LTX support
32-
pip install msgpack
27+
.. code-block:: bash
3328
34-
# run kirk
35-
./kirk --help
29+
pip install --user kirk
3630
3731
Some basic commands are the following:
3832

3933
.. code-block:: bash
4034
4135
# run LTP syscalls testing suite on host
42-
./kirk --run-suite syscalls
36+
kirk --run-suite syscalls
4337
4438
# run LTP syscalls testing suite on qemu VM
45-
./kirk --sut qemu:image=folder/image.qcow2:user=root:password=root \
39+
kirk --sut qemu:image=folder/image.qcow2:user=root:password=root \
4640
--run-suite syscalls
4741
4842
# run LTP syscalls testing suite via SSH
49-
./kirk --sut ssh:host=myhost.com:user=root:key_file=myhost_id_rsa \
43+
kirk --sut ssh:host=myhost.com:user=root:key_file=myhost_id_rsa \
5044
--run-suite syscalls
5145
5246
# run LTP syscalls testing suite in parallel on host using 16 workers
53-
./kirk --run-suite syscalls --workers 16
47+
kirk --run-suite syscalls --workers 16
5448
5549
# run LTP syscalls testing suite in parallel via SSH using 16 workers
56-
./kirk --sut ssh:host=myhost.com:user=root:key_file=myhost_id_rsa \
50+
kirk --sut ssh:host=myhost.com:user=root:key_file=myhost_id_rsa \
5751
--run-suite syscalls --workers 16
5852
5953
# pass environment variables (list of key=value separated by ':')
60-
./kirk --run-suite net.features \
54+
kirk --run-suite net.features \
6155
--env 'VIRT_PERF_THRESHOLD=180:LTP_NET_FEATURES_IGNORE_PERFORMANCE_FAILURE=1'
6256
6357
It's possible to run a single command before running testing suites using
64-
`--run-command` option as following:
58+
``--run-command`` option as following:
6559

6660
.. code-block:: bash
6761
68-
./kirk --run-command /mnt/setup.sh \
62+
kirk --run-command ./setup_sut.sh \
6963
--sut qemu:image=folder/image.qcow
7064

0 commit comments

Comments
 (0)