Skip to content

Commit e1c7af3

Browse files
committed
docs/results: Update documentation
Signed-off-by: Arisu Tachibana <arisu.tachibana@miraclelinux.com>
1 parent 447f0ca commit e1c7af3

File tree

1 file changed

+42
-1
lines changed

1 file changed

+42
-1
lines changed

docs/results.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@ The url of the tree to fetch results
2323

2424
The branch to get results for
2525

26+
### --git-folder
27+
28+
Path of the local git repository
29+
2630
### --commit
2731

2832
The tip of tree commit being tested. It needs to be the full commit hash.
@@ -39,12 +43,49 @@ Filter results by the status: "all", "pass", "fail" or "inconclusive"
3943

4044
## Results actions
4145

42-
### --action=trees
4346

4447
List all available trees for a given origin.
4548

4649
Example:
4750

51+
### without arguments
52+
53+
Used without arguments `kci-dev results` will get KernelCI status of local checkout git repository
54+
In the following example kci-dev is used on the local linux repository folder
55+
This command work with every linux repository supported by KernelCI
56+
57+
```sh
58+
linux git:(master)$ kci-dev results
59+
git folder: None
60+
tree: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
61+
branch: master
62+
commit: fbfd64d25c7af3b8695201ebc85efe90be28c5a3
63+
64+
pass/fail/inconclusive
65+
builds: 46/0/0
66+
boots: 580/48/8
67+
tests: 7858/6903/654
68+
```
69+
70+
### --git-folder=\<local repository path\>
71+
72+
Get results automatically from a folder with a local linux repository
73+
74+
```sh
75+
kci-dev git:(master)$ kci-dev results --git-folder ../linux
76+
git folder: ../linux
77+
tree: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
78+
branch: master
79+
commit: fbfd64d25c7af3b8695201ebc85efe90be28c5a3
80+
81+
pass/fail/inconclusive
82+
builds: 46/0/0
83+
boots: 580/48/8
84+
tests: 7858/6903/654
85+
```
86+
87+
### --action=trees
88+
4889
```sh
4990
kci-dev results --action=trees
5091
```

0 commit comments

Comments
 (0)