Tidy up and conform stack sdist/upload in-app documentation

commercialhaskell · Jul 30, 2024 · 3aa600b · 3aa600b
1 parent a6ad2f6
commit 3aa600b
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/src/Stack/Options/SDistParser.hs b/src/Stack/Options/SDistParser.hs
@@ -21,20 +21,22 @@ sdistOptsParser = SDistOpts
   <$> many (strArgument
         (  metavar "DIR"
         <> completer dirCompleter
+        <> help "Project package directory. Can be specified multiple times. \
+                \If none specified, use all project packages."
         ))
   <*> optional pvpBoundsOption
   <*> ignoreCheckSwitch
   <*> buildPackageOption
   <*> optional (strOption
         (  long "tar-dir"
-        <> help "If specified, copy all the tar to this directory."
+        <> help "If specified, copy all the generated files to this directory."
         ))
  where
   ignoreCheckSwitch = switch
     (  long "ignore-check"
-    <> help "Do not check package for common mistakes."
+    <> help "Do not check packages for common mistakes."
     )
   buildPackageOption = boolFlags False
     "test-tarball"
-    "building of the resulting tarball."
+    "building of the resulting generated files."
     idm
diff --git a/src/Stack/Options/UploadParser.hs b/src/Stack/Options/UploadParser.hs
@@ -61,12 +61,12 @@ uploadOptsParser = UploadOpts
       )
   buildPackageOption = boolFlags False
       "test-tarball"
-      "building of the resulting sdist tarball(s), for package upload."
+      "building of the resulting generated files, for package upload."
       idm
   tarDirParser = optional (strOption
     (  long "tar-dir"
-    <> help "For package upload, if specified, copy all the tar to this \
-            \directory."
+    <> help "If specified, copy all the generated files, for package upload, \
+            \to this directory."
     ))
   uploadVariantParser = flag Publishing Candidate
     (  long "candidate"