Fixes #231 - Remove Markdown code from the long CLI help

This commit is contained in:
Wladimir Palant 2024-05-24 21:43:34 +02:00
parent 479d9badbf
commit a8dee4e975

View file

@ -119,13 +119,14 @@ impl Default for ServerConf {
///
/// Call `Opt::from_args()` to build this object from the process's command line arguments.
#[derive(Parser, Debug)]
#[clap(name = "basic")]
#[clap(name = "basic", long_about = None)]
pub struct Opt {
/// Whether this server should try to upgrade from a running old server
#[clap(
short,
long,
help = "This is the base set of command line arguments for a pingora-based service"
help = "This is the base set of command line arguments for a pingora-based service",
long_help = None
)]
pub upgrade: bool,
@ -149,14 +150,15 @@ pub struct Opt {
long,
help = "This flag is useful for upgrading service where the user wants \
to make sure the new service can start before shutting down \
the old server process."
the old server process.",
long_help = None
)]
pub test: bool,
/// The path to the configuration file.
///
/// See [`ServerConf`] for more details of the configuration file.
#[clap(short, long, help = "The path to the configuration file.")]
#[clap(short, long, help = "The path to the configuration file.", long_help = None)]
pub conf: Option<String>,
}