on master help sign in
Documentation Fixes for CLI

+ Added documentation for `typeintype`. + Added internal documentation for flag groupings.

commitedb2809de1fe3268fc8ca0d8ac43eac6f660488a authorJan de Muijnck-Hughes <jfdm@st-andrews.ac.uk> dateThu 2 Jul 2015, 09:06 (11 years ago) parent6e7f896
1 file changed+7−3
src/Idris/CmdOptions.hs+7−3
src/Idris/CmdOptions.hs+7−3
@@ -78,12 +78,15 @@ parseFlags :: Parser [Opt]
7878parseFlags = many $
7979 flag' NoBanner (long "nobanner" <> help "Suppress the banner")
8080 <|> flag' Quiet (short 'q' <> long "quiet" <> help "Quiet verbosity")
81+ -- IDE Mode Specific Flags
8182 <|> flag' Idemode (long "ide-mode" <> help "Run the Idris REPL with machine-readable syntax")
8283 <|> flag' IdemodeSocket (long "ide-mode-socket" <> help "Choose a socket for IDE mode to listen on")
8384 <|> flag' Idemode (long "ideslave" <> help "Deprecated version of --ide-mode") -- TODO: Remove in v0.9.18
8485 <|> flag' IdemodeSocket (long "ideslave-socket" <> help "Deprecated version of --ide-mode-socket") -- TODO: Remove in v0.9.18
8586 <|> (Client <$> strOption (long "client"))
87+ -- Logging Flags
8688 <|> (OLogging <$> option auto (long "log" <> metavar "LEVEL" <> help "Debugging log level"))
89+ -- Turn off Certain libraries.
8790 <|> flag' NoBasePkgs (long "nobasepkgs" <> help "Do not use the given base package")
8891 <|> flag' NoPrelude (long "noprelude" <> help "Do not use the given prelude")
8992 <|> flag' NoBuiltins (long "nobuiltins" <> help "Do not use the builtin functions")
@@ -91,7 +94,7 @@ parseFlags = many $
9194 <|> (Output <$> strOption (short 'o' <> long "output" <> metavar "FILE" <> help "Specify output file"))
9295 -- <|> flag' TypeCase (long "typecase")
9396 <|> flag' Interface (long "interface" <> help "Generate interface files from ExportLists")
94− <|> flag' TypeInType (long "typeintype")
97+ <|> flag' TypeInType (long "typeintype" <> help "Turn off Universe checking")
9598 <|> flag' DefaultTotal (long "total" <> help "Require functions to be total by default")
9699 <|> flag' DefaultPartial (long "partial")
97100 <|> flag' WarnPartial (long "warnpartial" <> help "Warn about undeclared partial functions")
@@ -128,6 +131,7 @@ parseFlags = many $
128131 <|> flag' (InterpretScript "Main.main") (long "execute" <> help "Execute as idris")
129132 <|> (InterpretScript <$> strOption (long "exec" <> metavar "EXPR" <> help "Execute as idris"))
130133 <|> ((\s -> Extension $ getExt s) <$> strOption (long "extension" <> short 'X' <> metavar "EXT" <> help "Turn on language extension (TypeProviders or ErrorReflection)"))
134+ -- Optimisation Levels
131135 <|> flag' (OptLevel 3) (long "O3")
132136 <|> flag' (OptLevel 2) (long "O2")
133137 <|> flag' (OptLevel 1) (long "O1")
@@ -137,6 +141,7 @@ parseFlags = many $
137141 <|> (OptLevel <$> option auto (short 'O' <> long "level"))
138142 <|> (TargetTriple <$> strOption (long "target" <> metavar "TRIPLE" <> help "Select target triple (for llvm codegen)"))
139143 <|> (TargetCPU <$> strOption (long "cpu" <> metavar "CPU" <> help "Select target CPU e.g. corei7 or cortex-m3 (for LLVM codegen)"))
144+ -- Colour Options
140145 <|> flag' (ColourREPL True) (long "colour" <> long "color" <> help "Force coloured output")
141146 <|> flag' (ColourREPL False) (long "nocolour" <> long "nocolor" <> help "Disable coloured output")
142147
@@ -178,6 +183,5 @@ parseConsoleWidth s =
178183
179184integerReader :: ReadP Int
180185integerReader = do
181− digits <- many1 $ satisfy isDigit
186+ digits <- many1 $ satisfy isDigit
182187 return $ read digits
183−