Skip to content

Commit

Permalink
documentation: add info about cmdargs (#1862)
Browse files Browse the repository at this point in the history
Co-authored-by: Zeid Zabaneh <[email protected]>
  • Loading branch information
simon-friedberger and zzzeid authored Oct 31, 2024
1 parent f558f7d commit ec3c8b4
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
7 changes: 7 additions & 0 deletions docs/documentation/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@ Location:
Each option correspond to its command-line counter part (the long form,
but without the first double dashes, -\-). They are described [here](usage.html).

There is an exception for `--arg` which can be set in `mozregression.cfg` by using `cmdargs`.
For example, to pass a URL at which Firefox will open use
```
cmdargs = "https://mozilla.org",
```
Note the trailing comma, it is required to be correctly parsed as a list.

## Example

{% highlight ini %}
Expand Down
2 changes: 1 addition & 1 deletion docs/documentation/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ to date list of available options.
string.pref = Hello, world!
integer.pref = 1

- Forward arguments to tested binary (note that you must use '=' for arguments beginning with '-' so that the parser doesn't get confused)
- Forward arguments to tested binary. Note that you must use '=' for arguments beginning with '-' so that the parser doesn't get confused. Additionally, this is equivalent to `cmdargs` in the [configuration file](configuration.html).

mozregression --arg='-foreground' --arg='-P'

Expand Down

0 comments on commit ec3c8b4

Please sign in to comment.