Skip to content

Commit

Permalink
📝 Clarified :default_tasks & CLI conventions
Browse files Browse the repository at this point in the history
  • Loading branch information
mkarlesky committed May 11, 2024
1 parent b737e8b commit 478fcd9
Showing 1 changed file with 26 additions and 4 deletions.
30 changes: 26 additions & 4 deletions docs/CeedlingPacket.md
Original file line number Diff line number Diff line change
Expand Up @@ -849,22 +849,28 @@ command line involves two different conventions:
help and operate similarly to popular command line tools like `git`.
1. **Build & Plugin Tasks.** Build tasks actually execute test suites,
run release builds, etc. These tasks are created from your project
file. These are generated through Ceedling's Rake-based code and
file. These are generated through Ceedlings Rake-based code and
conform to its conventions — simplistic help, no option flags, but
bracketed arguments.

In the case of running builds, both come into play at the command line.

The two classes of command line arguments are clearly labelled in the
summary of all commands provided by `ceedling help`.

## Quick command line example to get you started

To exercise the Ceedling command line quickly, follow these steps after
[installing Ceedling](#ceedling-installation--set-up):

1. Open a terminal and chnage directories to a location suitable for
an example project.
1. Execute `ceedling example temp_sensor` in your terminal.
1. Execute `ceedling example temp_sensor` in your terminal. The `example`
argument is an application command.
1. Change directories into the new _temp_sensor/_ directory.
1. Execute `ceedling test:all` in your terminal.
1. Execute `ceedling test:all` in your terminal. The `test:all` is a
build task executed by the default (and omitted) `build` application
command.
1. Take a look at the build and test suite console output as well as
the _project.yml_ file in the root of the example project.

Expand Down Expand Up @@ -2164,11 +2170,27 @@ migrated to the `:test_build` and `:release_build` sections.

* `:default_tasks`

An array of default build / plugin tasks Ceedling should execute if
A list of default build / plugin tasks Ceedling should execute if
none are provided at the command line.

_Note:_ These are build & plugin tasks (e.g. `test:all` and `clobber`).
These are not application commands (e.g. `dumpconfig`) or command
line flags (e.g. `--verbosity`). See the documentation
[on using the command line][command-line] to understand the distinction
between application commands and build & plugin tasks.

Example YAML:
```yaml
:project:
:default_tasks:
- clobber
- test:all
- release
```
**Default**: ['test:all']

[command-line]: #now-what-how-do-i-make-it-go-the-command-line

* `:use_mocks`

Configures the build environment to make use of CMock. Note that if
Expand Down

0 comments on commit 478fcd9

Please sign in to comment.