Skip to content

Commit

Permalink
manual: update tool usage and description
Browse files Browse the repository at this point in the history
I am slightly worried about this repeatedly out-of-date, however, in the
past year or so of Microkit development, the Microkit tool usage has
not changed much (if at all).

Signed-off-by: Ivan Velickovic <i.velickovic@unsw.edu.au>
  • Loading branch information
Ivan-Velickovic committed Oct 10, 2023
1 parent 33b9f8d commit 128543c
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions docs/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -312,9 +312,12 @@ The format of the system description is described in a subsequent chapter.

Usage:

microkit [-h] [-o OUTPUT] [-r REPORT] system
microkit [-h] [-o OUTPUT] [-r REPORT] --board [BOARD] --config CONFIG
[--search-path [SEARCH_PATH ...]] system

The path to the system description file must be provided.
The path to the system description file, board to build the system for, and configuration to build for must be provided.

The search paths provided tell the tool where to find any program images specified in the system description file.

In the case of errors, a diagnostic message shall be output to `stderr` and a non-zero code returned.

Expand Down

0 comments on commit 128543c

Please sign in to comment.