Skip to content

Commit

Permalink
fix: optimize help messages
Browse files Browse the repository at this point in the history
  • Loading branch information
CodeChenL committed Apr 15, 2024
1 parent 9daf42e commit 863a2b3
Showing 1 changed file with 24 additions and 27 deletions.
51 changes: 24 additions & 27 deletions src/libexec/rsdk/rsdk-help
Original file line number Diff line number Diff line change
Expand Up @@ -12,39 +12,36 @@ EOF

rsdk-help-build() {
cat <<EOF
# rsdk-${FUNCNAME[0]##rsdk-help-}
rsdk-${FUNCNAME[0]##rsdk-help-}
====
## Command usage
\`\`\`bash
$ rsdk build <options> [product] <suite> <edition>
\`\`\`
$ rsdk build <options> [product] <suite> <edition>
## Options
\`\`\`bash
--no-cache
Do not use cached build artifacts. This will result in rootfs rebuild.
--no-efi
Do not create EFI partition in the generated image.
-d | --debug
Enable debug output. This will also build rootfs into a folder for easier
examination.
-T | --test-repo
Build using Radxa APT test archives.
-m | --mirror [mirror_url]
Specify custom Debian / Ubuntu archive mirror URL.
-M [mirror_url]
Specify custom non-Debian non-Ubuntu archive mirror URL. This mirror should
serve both Radxa archives as well as any other 3rd party archives.
The following archives will use this mirror:
$(find "$SCRIPT_DIR/../../../externals/keyrings/" -maxdepth 1 -mindepth 1 -type d ! -name debian -a ! -name ubuntu -printf " %f\n")
-i | --image-name [image_name]
Set the system image name. (Default: $("$SCRIPT_DIR/../../bin/rsdk" config build.default_image_name))
-h | --help
Show this message.
\`\`\`
--no-cache
Do not use cached build artifacts. This will result in rootfs rebuild.
--no-efi
Do not create EFI partition in the generated image.
-d | --debug
Enable debug output. This will also build rootfs into a folder for easier
examination.
-T | --test-repo
Build using Radxa APT test archives.
-m | --mirror [mirror_url]
Specify custom Debian / Ubuntu archive mirror URL.
-M [mirror_url]
Specify custom non-Debian non-Ubuntu archive mirror URL. This mirror should
serve both Radxa archives as well as any other 3rd party archives.
The following archives will use this mirror:
$(find "$SCRIPT_DIR/../../../externals/keyrings/" -maxdepth 1 -mindepth 1 -type d ! -name debian -a ! -name ubuntu -printf " %f\n")
-i | --image-name [image_name]
Set the system image name. (Default: $("$SCRIPT_DIR/../../bin/rsdk" config build.default_image_name))
-h | --help
Show this message.
EOF
}

Expand Down

0 comments on commit 863a2b3

Please sign in to comment.