Improve Help output
authorJoachim Breitner <mail@joachim-breitner.de>
Sun, 22 Aug 2010 18:48:30 +0000 (18:48 +0000)
committerJoachim Breitner <mail@joachim-breitner.de>
Sun, 22 Aug 2010 18:48:30 +0000 (18:48 +0000)
Apply.hs
Help.lhs
Split.hs
Version.hs
ipatch.hs

index 494db76..9a76d77 100644 (file)
--- a/Apply.hs
+++ b/Apply.hs
@@ -35,7 +35,13 @@ import Common
 import DiffFile ( filesTouchedByDiff, readDiffFile )
 
 applyHelp :: String
-applyHelp = "apply help"
+applyHelp =
+    "The `ipatch apply file.patch' command works similar to a `patch file.patch' command.\n" ++
+    "It will, however, prompt the user about each part of the patch, whether it should\n" ++
+    "be applied or not. Using the integrated hunk editor, the user has full control over\n" ++
+    "the chosen changes.\n"++
+    "\n"++
+    "No files are touched until the end, when the user is asked for a final confirmation.\n"
 
 applyDescription :: String
 applyDescription = "Apply a diff file interactively."
index 2ffbdf4..8f7bf29 100644 (file)
--- a/Help.lhs
+++ b/Help.lhs
@@ -32,7 +32,7 @@ import Darcs.Commands
       DarcsCommand(..),
       disambiguateCommands,
       extractCommands,
-      getCommandHelp,
+      getCommandHelp, -- This still prints "darcs", need to revise API here.
       nodefaults,
       usageHelper )
 import Darcs.External ( viewDoc )
@@ -70,7 +70,8 @@ help = DarcsCommand {commandName = "help",
                      commandHelp = helpHelp,
                      commandDescription = helpDescription,
                      commandExtraArgs = -1,
-                     commandExtraArgHelp = ["[<DARCS_COMMAND> [DARCS_SUBCOMMAND]]  "],
+                     --commandExtraArgHelp = ["[<DARCS_COMMAND> [DARCS_SUBCOMMAND]]  "],
+                     commandExtraArgHelp = ["[<IPATCH_COMMAND>]  "],
                      commandCommand = \ x y -> helpCmd x y >> exitWith ExitSuccess,
                      commandPrereq = \_ -> return $ Right (),
                      commandGetArgPossibilities = return [],
@@ -82,8 +83,8 @@ usage :: [CommandControl] -> String
 usage cs = "Usage: ipatch COMMAND ...\n\nCommands:\n" ++
            usageHelper cs ++ "\n" ++
            "Use 'ipatch COMMAND --help' for help on a single command.\n" ++
-           "Use 'ipatch --version' to see the ipatch version number.\n" ++
-           "Use 'ipatch --exact-version' to get the exact version of this ipatch instance.\n"
+           "Use 'ipatch --version' to see the ipatch version number.\n"
+           -- "Use 'ipatch --exact-version' to get the exact version of this ipatch instance.\n"
            -- "Use 'ipatch help environment' for help on environment variables.\n" ++
            --"\n" ++
            --"Check bug reports at http://bugs.darcs.net/\n"
@@ -116,8 +117,8 @@ listAvailableCommands =
                 zip (extractCommands commandControlList) is_valid
        putStrLn "--help"
        putStrLn "--version"
-       putStrLn "--exact-version"
-       putStrLn "--overview"
+       -- putStrLn "--exact-version"
+       -- putStrLn "--overview"
     where isRight (Right _) = True
           isRight _ = False
 
index bfb1691..059ede6 100644 (file)
--- a/Split.hs
+++ b/Split.hs
@@ -41,7 +41,15 @@ import Common
 import DiffFile ( readDiffFile, filesTouchedByDiff )
 
 splitHelp :: String
-splitHelp = "split help"
+splitHelp =
+    "The `ipatch split file.patch' lets the user select different parts (hunks) of the\n" ++
+    "given patch file. After making a choice for each hunk, the user has to provide a\n" ++
+    "file name where the selected changes are stored. This procedure is repeated until\n" ++
+    "each change in the original file has been selected for one output file.\n" ++
+    "\n"++
+    "No files are modified by this command. The output patch files are all written at the\n" ++
+    "of the process.\n"
+
 
 splitDescription :: String
 splitDescription = "Split a diff file interactively."
index a6237ca..fa08df7 100644 (file)
@@ -1,4 +1,7 @@
-module Version where
+module Version (version) where
 
-version = "noversion"
-context = "nocontext"
+import Data.Version
+
+import qualified Paths_ipatch
+
+version = showVersion Paths_ipatch.version
index 338f5b7..6a98cf0 100644 (file)
--- a/ipatch.hs
+++ b/ipatch.hs
@@ -4,7 +4,7 @@ import System.IO ( hSetBinaryMode, stdin, stdout )
 import Darcs.Flags ( DarcsFlag(Verbose) )
 import Darcs.RunCommand ( runTheCommand )
 
-import Version ( version, context )
+import Version ( version )
 import Help
     ( commandControlList,
       helpCmd,
@@ -21,9 +21,6 @@ main = do
     ["--commands"]      -> listAvailableCommands
     ["-v"]              -> putStrLn version
     ["--version"]       -> putStrLn version
-    ["--exact-version"] -> do
-              --putStrLn $ "darcs compiled on "++__DATE__++", at "++__TIME__
-              putStrLn context
     _ -> do
       hSetBinaryMode stdin True
       hSetBinaryMode stdout True