Review comments - pass 1: trivial fixes

Signed-off-by: Abhijit Gadgil <[email protected]>
habitat-sh · Jan 10, 2025 · 6804517 · 6804517
1 parent ae3bf2e
commit 6804517
Show file tree

Hide file tree

Showing 8 changed files with 10 additions and 9 deletions.
diff --git a/components/hab/src/cli_v4/pkg.rs b/components/hab/src/cli_v4/pkg.rs
@@ -65,7 +65,7 @@ pub(super) enum PkgCommand {
     /// Builds a plan using Habitat Studio
     Build(build::PkgBuildOptions),
 
-    /// Bulk uploads Habitat artifacts from to a depo from a local directory
+    /// Bulk uploads Habitat artifacts from to a depot from a local directory
     Bulkupload(bulk_upload::PkgBulkUploadOptions),
 
     /// Find out what channels a package belongs to
@@ -136,7 +136,7 @@ pub(super) enum PkgCommand {
     /// Uploads a local Habitat Artifact to Builder
     Upload(upload::PkgUploadOptions),
 
-    /// Verifies a Habitat Architect with an origin key
+    /// Verifies a Habitat Artifact with an origin key
     Verify(verify::PkgVerifyOptions),
 }
 

diff --git a/components/hab/src/cli_v4/pkg/channels.rs b/components/hab/src/cli_v4/pkg/channels.rs
@@ -24,7 +24,7 @@ pub(crate) struct PkgChannelsOptions {
     #[command(flatten)]
     bldr_url: BldrUrl,
 
-    /// Fully Qualified package identifier for the package
+    /// A fully qualified package identifier (ex: core/busybox-static/1.42.2/20170513215502)
     #[arg(name = "PKG_IDENT")]
     pkg_ident: PackageIdent,
 

diff --git a/components/hab/src/cli_v4/pkg/delete.rs b/components/hab/src/cli_v4/pkg/delete.rs
@@ -24,7 +24,7 @@ pub(crate) struct PkgDeleteOptions {
     #[command(flatten)]
     bldr_url: BldrUrl,
 
-    /// Fully Qualified package identifier for the package
+    /// A fully qualified package identifier (ex: core/busybox-static/1.42.2/20170513215502)
     #[arg(name = "PKG_IDENT")]
     pkg_ident: PackageIdent,
 

diff --git a/components/hab/src/cli_v4/pkg/demote.rs b/components/hab/src/cli_v4/pkg/demote.rs
@@ -25,7 +25,7 @@ pub(crate) struct PkgDemoteOptions {
     #[command(flatten)]
     bldr_url: BldrUrl,
 
-    /// Fully Qualified package identifier for the package
+    /// A fully qualified package identifier (ex: core/busybox-static/1.42.2/20170513215502)
     #[arg(name = "PKG_IDENT")]
     pkg_ident: PackageIdent,
 

diff --git a/components/hab/src/cli_v4/pkg/exec.rs b/components/hab/src/cli_v4/pkg/exec.rs
@@ -21,7 +21,7 @@ pub(crate) struct PkgExecOptions {
     #[arg(name = "PKG_IDENT")]
     pkg_ident: PackageIdent,
 
-    /// Command to execute
+    /// The command to execute (ex: ls)
     #[arg(name = "CMD")]
     cmd: PathBuf,
 

diff --git a/components/hab/src/cli_v4/pkg/header.rs b/components/hab/src/cli_v4/pkg/header.rs
@@ -18,7 +18,7 @@ use crate::{command::pkg::header,
           help_template = "{name} {version} {author-section} {about-section} \n{usage-heading} \
                            {usage}\n\n{all-args}\n")]
 pub(crate) struct PkgHeaderOptions {
-    /// Filepath to the Habitat Package file
+    /// A path to a Habitat Artifact (ex: /home/acme-redis-3.0.7-21120102031201-x86_64-linux.hart)
     #[arg(name = "SOURCE", value_parser = FileExistsValueParser)]
     source: String,
 }

diff --git a/components/hab/src/cli_v4/pkg/promote.rs b/components/hab/src/cli_v4/pkg/promote.rs
@@ -25,11 +25,11 @@ pub(crate) struct PkgPromoteOptions {
     #[command(flatten)]
     bldr_url: BldrUrl,
 
-    /// Fully Qualified package identifier for the package
+    /// A fully qualified package identifier (ex: core/busybox-static/1.42.2/20170513215502)
     #[arg(name = "PKG_IDENT")]
     pkg_ident: PackageIdent,
 
-    /// Demote from the specified release channel
+    /// Promote from the specified release channel
     #[arg(name = "CHANNEL")]
     channel: ChannelIdent,
 

diff --git a/components/hab/src/cli_v4/pkg/uninstall.rs b/components/hab/src/cli_v4/pkg/uninstall.rs
@@ -20,6 +20,7 @@ use crate::{command::pkg::{uninstall,
           help_template = "{name} {version} {author-section} {about-section} \n{usage-heading} \
                            {usage}\n\n{all-args}\n")]
 pub(crate) struct PkgUninstallOptions {
+    /// A package identifier (ex: core/redis, core/busybox-static/1.42.2)
     #[arg(name = "PKG_IDENT")]
     pkg_ident: PackageIdent,