Skip to content

Commit 0c96545

Browse files
committed
improve getting started section clarity
1 parent 0f3d610 commit 0c96545

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

doc/getting-started.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -335,22 +335,22 @@ mycrate = { path = '..' }
335335
### Built-in runner
336336

337337
The builtin Alire test runner provides a simple way to run `.adb` files as
338-
separate tests. It requires setting up a subcrate (let's name it `mycrate_test`
339-
in our example) with a GPR file that defines its executables in a specific way:
338+
separate tests. It requires setting up a subcrate, with a GPR file that defines
339+
its executables in a specific way:
340340

341341
```ada
342-
with "config/mycrate_tests_list_config.gpr"
342+
with "config/<cratename>_list_config.gpr"
343343
-- ...
344-
for Main use Mycrate_Tests_List_Config.Test_Files;
344+
for Main use <Cratename>_List_Config.Test_Files;
345345
```
346346

347347
This subcrate is automatically generated by `alr init` (unless one specifies
348348
`--no-test`), so you will not have to write all of this by hand.
349349

350350
When running the `alr test` command, it will put every `.adb` file in `/src` in
351-
the generated `config/<cratename>_list_config.gpr` file, then build them all and
352-
run them in parallel in accordance with the `jobs` parameter (either from the
353-
manifest or the command line).
351+
the generated `config/<cratename>_list_config.gpr` file, then build them all
352+
and run them in parallel in accordance with the `jobs` parameter (either from
353+
the manifest or the command line).
354354

355355
Support code for the tests can be placed into another folder, like `/common`;
356356
only `.adb` files in `/src` are counted as tests. Each test must be a main

0 commit comments

Comments
 (0)