From 128543c505f444ccbe957a5456eea00b5973d2e8 Mon Sep 17 00:00:00 2001 From: Ivan Velickovic Date: Tue, 10 Oct 2023 15:46:02 +1100 Subject: [PATCH] manual: update tool usage and description 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 --- docs/manual.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/manual.md b/docs/manual.md index b8d8f020..871f9d31 100644 --- a/docs/manual.md +++ b/docs/manual.md @@ -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.