diff --git a/docs/command-reference.md b/docs/command-reference.md index c4efb081..a15fb8d2 100644 --- a/docs/command-reference.md +++ b/docs/command-reference.md @@ -5,7 +5,7 @@ > > Example: [release 0.4.1 tag](https://github.com/apple/container/tree/0.4.1) -Note: Command availability may vary depending on host operating system and macOS version. +Command availability may vary depending on your macOS version. ## Core Commands @@ -896,7 +896,8 @@ container run -v $VOL:/data alpine container volume rm $VOL ``` -**Note**: Unlike Docker, anonymous volumes do NOT auto-cleanup with `--rm`. Manual deletion is required. +> [!NOTE] +> Unlike Docker, anonymous volumes do NOT auto-cleanup with `--rm`. Manual deletion is required. ### `container volume delete (rm)` @@ -1054,6 +1055,9 @@ container system start [--app-root ] [--install-root ] [ * `--log-root `: Path to the root directory for log data, using macOS log facility if not set * `--enable-kernel-install/--disable-kernel-install`: Specify whether the default kernel should be installed or not (default: prompt user) +> [!NOTE] +> The `--log-root` option is principally intended for short-term test and diagnostic purposes. The log handler for this option neither aggregates log messages, nor does it rotate logs. + ### `container system stop` Stops the container services and deregisters them from launchd. You can specify a prefix to target services created with a different launchd prefix. @@ -1151,6 +1155,9 @@ Equivalent to the JSON output but in YAML format. Each entry in the array repres Displays logs from the container services. You can specify a time interval or follow new logs in real time. +> [!NOTE] +> If you run `container system start with --log-root`, services only write log messages to files under the log root, and `container system logs` will show no service log messages. + **Usage** ```bash