Garmelon/mima-tools
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Reword parts of the help

Browse source
This commit is contained in:
Joscha 2019-11-06 18:45:16 +00:00
parent ccf08f7a18
commit eb027f1c19
2 changed files with 14 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -21,22 +21,22 @@ at address 0 (i. e. the first block).
This program can load and run `.mima` files. This program can load and run `.mima` files.
``` ```
$ ./mima-run --help $ mima-run --help
Usage: mima-run INFILE [-n|--steps N] [-d|--dump OUTFILE] [-q|--quiet] Usage: mima-run INFILE [-n|--steps N] [-d|--dump OUTFILE] [-q|--quiet]
[-s|--sparse] [-r|--norun] [-s|--sparse] [-r|--norun]
Available options: Available options:
-h,--help Show this help text -h,--help Show this help text
INFILE The memory dump to load and execute INFILE The binary memory dump to load and execute
-n,--steps N How many instructions to execute (if not specified, -n,--steps N How many instructions to execute (if not specified,
runs until HALT or execution exception) runs until HALT or execution exception)
-d,--dump OUTFILE If specified, the MiMa's memory is dumped to this -d,--dump OUTFILE If specified, write the MiMa's binary memory dump to
file after execution is finished this file after execution is finished
-q,--quiet Whether to print the memory after execution is -q,--quiet Don't print the memory dump
finished -s,--sparse Don't print memory locations containing only 0x000000
-s,--sparse Whether to print memory locations that contain 0 in the memory dump
-r,--norun Don't run the MiMa. Continues as if the initial state -r,--norun Don't run the MiMa. Use the initial state for all
was the result of running the MiMa. further actions
``` ```
## Conventions ## Conventions

10
app/MimaRun.hs
View file

@ -24,7 +24,7 @@ settingsParser :: Parser Settings
settingsParser = Settings settingsParser = Settings
<$> strArgument <$> strArgument
(metavar "INFILE" (metavar "INFILE"
<> help "The memory dump to load and execute") <> help "The binary memory dump to load and execute")
<*> (optional . option auto) <*> (optional . option auto)
(long "steps" (long "steps"
<> short 'n' <> short 'n'
@ -34,19 +34,19 @@ settingsParser = Settings
(long "dump" (long "dump"
<> short 'd' <> short 'd'
<> metavar "OUTFILE" <> metavar "OUTFILE"
<> help "If specified, the MiMa's memory is dumped to this file after execution is finished") <> help "If specified, write the MiMa's binary memory dump to this file after execution is finished")
<*> flag False True <*> flag False True
(long "quiet" (long "quiet"
<> short 'q' <> short 'q'
<> help "Whether to print the memory after execution is finished") <> help "Don't print the memory dump")
<*> flag False True <*> flag False True
(long "sparse" (long "sparse"
<> short 's' <> short 's'
<> help "Whether to print memory locations that contain 0") <> help "Don't print memory locations containing only 0x000000 in the memory dump")
<*> flag False True <*> flag False True
(long "norun" (long "norun"
<> short 'r' <> short 'r'
<> help "Don't run the MiMa. Continues as if the initial state was the result of running the MiMa.") <> help "Don't run the MiMa. Use the initial state for all further actions")
opts :: ParserInfo Settings opts :: ParserInfo Settings
opts = info (helper <*> settingsParser) $ fullDesc <> failureCode 1 opts = info (helper <*> settingsParser) $ fullDesc <> failureCode 1