Commit e5a41d7e authored by Vincent Stehlé's avatar Vincent Stehlé
Browse files

Move sample files into a sample folder



Update the documentation accordingly. While at it, remove obsolete mention
of default behaviour.
Signed-off-by: Vincent Stehlé's avatarVincent Stehlé <vincent.stehle@arm.com>
parent c37de35c
...@@ -30,8 +30,7 @@ Usage to generate a `result.md` is such: ...@@ -30,8 +30,7 @@ Usage to generate a `result.md` is such:
$ python3 parser.py <log_file.ekl> <seq_file.seq> $ python3 parser.py <log_file.ekl> <seq_file.seq>
``` ```
If you do no provided any command line arguments it will use `sample.ekl` and The output filename can be specified with the `--md` option:
`sample.seq`. The output filename can be specified with the `--md` option:
``` {.sh} ``` {.sh}
$ ./parser.py --md out.md ... $ ./parser.py --md out.md ...
...@@ -223,13 +222,13 @@ tests. ...@@ -223,13 +222,13 @@ tests.
### Sample ### Sample
A `sample.yaml` configuration file is provided as example, to use with the In the folder `sample`, a `sample.yaml` configuration file is provided as
`sample.ekl` and `sample.seq` files. example, to use with the `sample.ekl` and `sample.seq` files.
Try it with: Try it with:
``` {.sh} ``` {.sh}
$ ./parser.py --config sample.yaml ... $ ./parser.py --config sample/sample.yaml sample/sample.ekl sample/sample.seq
``` ```
### Generating a configuration template ### Generating a configuration template
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment