docs: clarify version number usage

This was also requested by the community. People were attempting to use a 'v' prefix.
maidsafe · Mar 21, 2024 · 777a132 · 777a132
1 parent 6ea5d06
commit 777a132
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/sn_node_manager/src/bin/cli/main.rs b/sn_node_manager/src/bin/cli/main.rs
@@ -138,6 +138,8 @@ pub enum SubCmd {
         user: Option<String>,
         /// Provide a specific version of safenode to be installed.
         ///
+        /// The version number should be in the form X.Y.Z, with no 'v' prefix.
+        ///
         /// The binary will be downloaded.
         #[clap(long)]
         version: Option<String>,
@@ -177,6 +179,8 @@ pub enum SubCmd {
         faucet_path: Option<PathBuf>,
         /// The version of the faucet to use.
         ///
+        /// The version number should be in the form X.Y.Z, with no 'v' prefix.
+        ///
         /// The version and path arguments are mutually exclusive.
         #[clap(long)]
         faucet_version: Option<String>,
@@ -192,6 +196,8 @@ pub enum SubCmd {
         node_path: Option<PathBuf>,
         /// The version of safenode to use.
         ///
+        /// The version number should be in the form X.Y.Z, with no 'v' prefix.
+        ///
         /// The version and path arguments are mutually exclusive.
         #[clap(long)]
         node_version: Option<String>,
@@ -249,6 +255,8 @@ pub enum SubCmd {
         faucet_path: Option<PathBuf>,
         /// The version of the faucet to use.
         ///
+        /// The version number should be in the form X.Y.Z, with no 'v' prefix.
+        ///
         /// The version and path arguments are mutually exclusive.
         #[clap(long, conflicts_with = "build")]
         faucet_version: Option<String>,
@@ -264,6 +272,8 @@ pub enum SubCmd {
         node_path: Option<PathBuf>,
         /// The version of safenode to use.
         ///
+        /// The version number should be in the form X.Y.Z, with no 'v' prefix.
+        ///
         /// The version and path arguments are mutually exclusive.
         #[clap(long, conflicts_with = "build")]
         node_version: Option<String>,
@@ -370,6 +380,8 @@ pub enum SubCmd {
         #[clap(long, conflicts_with = "version")]
         url: Option<String>,
         /// Upgrade to a specific version rather than the latest version.
+        ///
+        /// The version number should be in the form X.Y.Z, with no 'v' prefix.
         #[clap(long)]
         version: Option<String>,
     },
@@ -419,6 +431,8 @@ pub enum DaemonSubCmd {
         url: Option<String>,
         /// Provide a specific version of the daemon to be installed.
         ///
+        /// The version number should be in the form X.Y.Z, with no 'v' prefix.
+        ///
         /// The binary will be downloaded.
         #[clap(long)]
         version: Option<String>,
@@ -479,6 +493,8 @@ pub enum FaucetSubCmd {
         url: Option<String>,
         /// Provide a specific version of the faucet to be installed.
         ///
+        /// The version number should be in the form X.Y.Z, with no 'v' prefix.
+        ///
         /// The binary will be downloaded.
         #[clap(long)]
         version: Option<String>,
@@ -529,6 +545,8 @@ pub enum FaucetSubCmd {
         #[clap(long, conflicts_with = "version")]
         url: Option<String>,
         /// Upgrade to a specific version rather than the latest version.
+        ///
+        /// The version number should be in the form X.Y.Z, with no 'v' prefix.
         #[clap(long)]
         version: Option<String>,
     },