diff --git a/docs/results.md b/docs/results.md index 0171380..041b4a8 100644 --- a/docs/results.md +++ b/docs/results.md @@ -23,6 +23,10 @@ The url of the tree to fetch results The branch to get results for +### --git-folder + +Path of the local git repository + ### --commit 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" ## Results actions -### --action=trees List all available trees for a given origin. Example: +### without arguments + +If used without arguments, `kci-dev results` will get KernelCI status of local checked out git repository +In the following example, kci-dev is used on a local linux repository folder +This command work with every linux repository supported by KernelCI + +```sh +linux git:(master)$ kci-dev results +git folder: None +tree: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git +branch: master +commit: fbfd64d25c7af3b8695201ebc85efe90be28c5a3 + +pass/fail/inconclusive +builds: 46/0/0 +boots: 580/48/8 +tests: 7858/6903/654 +``` + +### --git-folder=\ + +Get results automatically from a folder with a local linux repository + +```sh +kci-dev git:(master)$ kci-dev results --git-folder ../linux +git folder: ../linux +tree: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git +branch: master +commit: fbfd64d25c7af3b8695201ebc85efe90be28c5a3 + +pass/fail/inconclusive +builds: 46/0/0 +boots: 580/48/8 +tests: 7858/6903/654 +``` + +### --action=trees + ```sh kci-dev results --action=trees ``` diff --git a/pyproject.toml b/pyproject.toml index 773c8f2..c18786c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,7 +1,7 @@ [tool.poetry] name = "kci-dev" version = "0.1.1" -description = "Stand alone tool for Linux Kernel developers and maintainers that can test local Linux Kernel changes on a enabled KernelCI server" +description = "Stand alone tool for Linux Kernel developers and maintainers to interact with KernelCI" authors = ["Arisu Tachibana "] license = "LGPL-2.1-or-later" readme = "README.md"