Skip to content
This repository has been archived by the owner on Jan 25, 2024. It is now read-only.

Commit

Permalink
chore: improve docs for start and stop commands
Browse files Browse the repository at this point in the history
Also add directories used in the deploy process to the .gitignore. Without these the publishing
process will fail.
  • Loading branch information
jacderida committed Nov 29, 2023
1 parent dfa4e19 commit 8854c1c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand Down

0 comments on commit 8854c1c

Please sign in to comment.