From 8854c1cbe0822d7a729123c085c1eedbfb70f28d Mon Sep 17 00:00:00 2001 From: Chris O'Neil Date: Wed, 29 Nov 2023 16:53:20 +0000 Subject: [PATCH] chore: improve docs for `start` and `stop` commands Also add directories used in the deploy process to the .gitignore. Without these the publishing process will fail. --- .gitignore | 2 ++ src/main.rs | 4 ++++ 2 files changed, 6 insertions(+) diff --git a/.gitignore b/.gitignore index 7af7937..b06fdc7 100644 --- a/.gitignore +++ b/.gitignore @@ -2,6 +2,8 @@ # will have compiled files and executables debug/ target/ +artifacts/ +deploy/ # Remove Cargo.lock from gitignore if creating an executable, leave it for libraries # More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html diff --git a/src/main.rs b/src/main.rs index 4cc9dae..e8e9f47 100644 --- a/src/main.rs +++ b/src/main.rs @@ -77,6 +77,8 @@ pub enum SubCmd { /// Start an installed safenode service. /// /// If no peer ID(s) or service name(s) are supplied, all installed services will be started. + /// + /// This command must run as the root/administrative user. #[clap(name = "start")] Start { /// The peer ID of the service to start. @@ -96,6 +98,8 @@ pub enum SubCmd { /// Stop an installed safenode service. /// /// If no peer ID(s) or service name(s) are supplied, all installed services will be stopped. + /// + /// This command must run as the root/administrative user. #[clap(name = "stop")] Stop { /// The peer ID of the service to stop.