From ec6fd050f69dbc237b9c424ffe67276e3f5d951c Mon Sep 17 00:00:00 2001 From: Paulo Castro Date: Sat, 25 Dec 2021 02:19:11 +0000 Subject: [PATCH] os build-config: Clarify command purpose in help output Change-type: patch --- docs/balena-cli.md | 4 ++-- lib/commands/os/build-config.ts | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/balena-cli.md b/docs/balena-cli.md index c78a7216..79c7546e 100644 --- a/docs/balena-cli.md +++ b/docs/balena-cli.md @@ -2087,8 +2087,8 @@ or 'menu-esr' (interactive menu, ESR versions) ## os build-config <image> <device-type> -Interactively generate an OS config once, so that the generated config -file can be used in `balena os configure`, skipping the interactive part. +Interactively generate a configuration file that can then be used as +non-interactive input by the 'balena os configure' command. Examples: diff --git a/lib/commands/os/build-config.ts b/lib/commands/os/build-config.ts index c00eaff2..55a51312 100644 --- a/lib/commands/os/build-config.ts +++ b/lib/commands/os/build-config.ts @@ -35,10 +35,10 @@ interface ArgsDef { export default class OsBuildConfigCmd extends Command { public static description = stripIndent` - Build an OS config and save it to a JSON file. + Prepare a configuration file for use by the 'os configure' command. - Interactively generate an OS config once, so that the generated config - file can be used in \`balena os configure\`, skipping the interactive part. + Interactively generate a configuration file that can then be used as + non-interactive input by the 'balena os configure' command. `; public static examples = [