From 2d32fe9c2def0a22068f00fd4fc585bca8950558 Mon Sep 17 00:00:00 2001 From: Zachary Snow Date: Thu, 22 Jun 2023 00:05:06 -0400 Subject: [PATCH] minor help text updates --- README.md | 6 +++--- src/Job.hs | 7 ++++--- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a4d154c..2bee0de 100644 --- a/README.md +++ b/README.md @@ -92,13 +92,13 @@ Below is the current usage printout. sv2v [OPTIONS] [FILES] Preprocessing: - -I --incdir=DIR Add directory to include search path + -I --incdir=DIR Add a directory to the include search path -y --libdir=DIR Add a directory to the library search path used when looking for undefined modules and interfaces -D --define=NAME[=VALUE] Define a macro for preprocessing --siloed Lex input files separately, so macros from earlier files are not defined in later files - --skip-preprocessor Disable preprocessor + --skip-preprocessor Disable preprocessing of macros, comments, etc. Conversion: --pass-through Dump input without converting -E --exclude=CONV Exclude a particular conversion (Always, Assert, @@ -116,7 +116,7 @@ Other: number literals (e.g., 'h1_ffff_ffff, 4294967296) --dump-prefix=PATH Create intermediate output files with the given path prefix; used for internal debugging - --help Display help message + --help Display this help message --version Print version information --numeric-version Print just the version number ``` diff --git a/src/Job.hs b/src/Job.hs index f1dee04..d8f6d48 100644 --- a/src/Job.hs +++ b/src/Job.hs @@ -61,7 +61,7 @@ defaultJob :: Job defaultJob = Job { files = def &= args &= typ "FILES" , incdir = nam_ "I" &= name "incdir" &= typDir - &= help "Add directory to include search path" + &= help "Add a directory to the include search path" &= groupname "Preprocessing" , libdir = nam_ "y" &= name "libdir" &= typDir &= help ("Add a directory to the library search path used when looking" @@ -70,7 +70,8 @@ defaultJob = Job &= help "Define a macro for preprocessing" , siloed = nam_ "siloed" &= help ("Lex input files separately, so" ++ " macros from earlier files are not defined in later files") - , skipPreprocessor = nam_ "skip-preprocessor" &= help "Disable preprocessor" + , skipPreprocessor = nam_ "skip-preprocessor" + &= help "Disable preprocessing of macros, comments, etc." , passThrough = nam_ "pass-through" &= help "Dump input without converting" &= groupname "Conversion" , exclude = nam_ "exclude" &= name "E" &= typ "CONV" @@ -100,7 +101,7 @@ defaultJob = Job &= details [ "sv2v converts SystemVerilog to Verilog." , "More info: https://github.com/zachjs/sv2v" , "(C) 2019-2023 Zachary Snow, 2011-2015 Tom Hawkins" ] - &= helpArg [explicit, name "help"] + &= helpArg [explicit, name "help", help "Display this help message"] &= versionArg [explicit, name "version"] &= verbosityArgs [ignore] [ignore] where