Browse files

Fix typos.

  • Loading branch information...
1 parent b00b491 commit b5b42896a3ebea38aca55c71bd675555dc2faa67 @ianbollinger ianbollinger committed Apr 14, 2014
Showing with 159 additions and 159 deletions.
  1. +5 −5 Cabal/Distribution/Compat/TempFile.hs
  2. +1 −1 Cabal/Distribution/Make.hs
  3. +2 −2 Cabal/Distribution/PackageDescription.hs
  4. +15 −15 Cabal/Distribution/PackageDescription/Check.hs
  5. +2 −2 Cabal/Distribution/PackageDescription/Configuration.hs
  6. +1 −1 Cabal/Distribution/PackageDescription/Parse.hs
  7. +4 −4 Cabal/Distribution/ParseUtils.hs
  8. +2 −2 Cabal/Distribution/Simple.hs
  9. +4 −4 Cabal/Distribution/Simple/Build.hs
  10. +3 −3 Cabal/Distribution/Simple/Command.hs
  11. +5 −5 Cabal/Distribution/Simple/GHC.hs
  12. +9 −9 Cabal/Distribution/Simple/Haddock.hs
  13. +1 −1 Cabal/Distribution/Simple/HaskellSuite.hs
  14. +8 −8 Cabal/Distribution/Simple/InstallDirs.hs
  15. +6 −6 Cabal/Distribution/Simple/LHC.hs
  16. +1 −1 Cabal/Distribution/Simple/LocalBuildInfo.hs
  17. +5 −5 Cabal/Distribution/Simple/PackageIndex.hs
  18. +1 −1 Cabal/Distribution/Simple/Program.hs
  19. +1 −1 Cabal/Distribution/Simple/Program/Builtin.hs
  20. +3 −3 Cabal/Distribution/Simple/Program/Db.hs
  21. +2 −2 Cabal/Distribution/Simple/Program/Types.hs
  22. +3 −3 Cabal/Distribution/Simple/Register.hs
  23. +6 −6 Cabal/Distribution/Simple/Setup.hs
  24. +1 −1 Cabal/Distribution/Simple/SrcDist.hs
  25. +2 −2 Cabal/Distribution/Simple/UHC.hs
  26. +1 −1 Cabal/Distribution/Simple/UserHooks.hs
  27. +4 −4 Cabal/Distribution/Simple/Utils.hs
  28. +4 −4 Cabal/Distribution/System.hs
  29. +2 −2 Cabal/Distribution/Version.hs
  30. +1 −1 Cabal/Language/Haskell/Extension.hs
  31. +1 −1 Cabal/tests/README
  32. +1 −1 Cabal/tests/UnitTests/Distribution/Compat/ReadP.hs
  33. +1 −1 cabal-install/Distribution/Client/Compat/Environment.hs
  34. +1 −1 cabal-install/Distribution/Client/Config.hs
  35. +4 −4 cabal-install/Distribution/Client/Dependency.hs
  36. +1 −1 cabal-install/Distribution/Client/Dependency/Modular/IndexConversion.hs
  37. +1 −1 cabal-install/Distribution/Client/Dependency/Modular/PSQ.hs
  38. +1 −1 cabal-install/Distribution/Client/Dependency/Modular/Validate.hs
  39. +2 −2 cabal-install/Distribution/Client/Dependency/Types.hs
  40. +1 −1 cabal-install/Distribution/Client/Freeze.hs
  41. +2 −2 cabal-install/Distribution/Client/Get.hs
  42. +1 −1 cabal-install/Distribution/Client/HttpUtils.hs
  43. +3 −3 cabal-install/Distribution/Client/IndexUtils.hs
  44. +3 −3 cabal-install/Distribution/Client/Init/Heuristics.hs
  45. +4 −4 cabal-install/Distribution/Client/Install.hs
  46. +3 −3 cabal-install/Distribution/Client/InstallPlan.hs
  47. +8 −8 cabal-install/Distribution/Client/InstallSymlink.hs
  48. +1 −1 cabal-install/Distribution/Client/List.hs
  49. +4 −4 cabal-install/Distribution/Client/PackageIndex.hs
  50. +1 −1 cabal-install/Distribution/Client/SrcDist.hs
  51. +5 −5 cabal-install/Distribution/Client/Tar.hs
  52. +4 −4 cabal-install/Distribution/Client/Win32SelfUpgrade.hs
  53. +1 −1 cabal-install/cabal-install.cabal
View
10 Cabal/Distribution/Compat/TempFile.hs
@@ -37,7 +37,7 @@ import qualified System.Posix
-- This is here for Haskell implementations that do not come with
-- System.IO.openTempFile. This includes nhc-1.20, hugs-2006.9.
--- TODO: Not sure about jhc
+-- TODO: Not sure about JHC
-- This is a copy/paste of the openBinaryTempFile definition, but
-- if uses 666 rather than 600 for the permissions. The base library
@@ -49,7 +49,7 @@ openNewBinaryFile dir template = do
where
-- We split off the last extension, so we can use .foo.ext files
-- for temporary files (hidden on Unix OSes). Unfortunately we're
- -- below filepath in the hierarchy here.
+ -- below file path in the hierarchy here.
(prefix,suffix) =
case break (== '.') $ reverse template of
-- First case: template contains no '.'s. Just re-reverse it.
@@ -76,9 +76,9 @@ openNewBinaryFile dir template = do
then findTempName (x+1)
else ioError (errnoToIOError "openNewBinaryFile" errno Nothing (Just dir))
else do
- -- TODO: We want to tell fdToHandle what the filepath is,
+ -- TODO: We want to tell fdToHandle what the file path is,
-- as any exceptions etc will only be able to report the
- -- fd currently
+ -- FD currently
h <- fdToHandle fd `onException` c_close fd
return (filepath, h)
where
@@ -92,7 +92,7 @@ openNewBinaryFile dir template = do
| last a == pathSeparator = a ++ b
| otherwise = a ++ [pathSeparator] ++ b
--- FIXME: Should use filepath library
+-- FIXME: Should use System.FilePath library
pathSeparator :: Char
#ifdef mingw32_HOST_OS
pathSeparator = '\\'
View
2 Cabal/Distribution/Make.hs
@@ -17,7 +17,7 @@
-- that it works.
--
-- Uses the parsed command-line from "Distribution.Simple.Setup" in order to build
--- Haskell tools using a backend build system based on make. Obviously we
+-- Haskell tools using a back-end build system based on make. Obviously we
-- assume that there is a configure script, and that after the ConfigCmd has
-- been run, there is a Makefile. Further assumptions:
--
View
4 Cabal/Distribution/PackageDescription.hs
@@ -613,7 +613,7 @@ data BuildInfo = BuildInfo {
pkgconfigDepends :: [Dependency], -- ^ pkg-config packages that are used
frameworks :: [String], -- ^support frameworks for Mac OS X
cSources :: [FilePath],
- hsSourceDirs :: [FilePath], -- ^ where to look for the haskell module hierarchy
+ hsSourceDirs :: [FilePath], -- ^ where to look for the Haskell module hierarchy
otherModules :: [ModuleName], -- ^ non-exposed or non-main modules
defaultLanguage :: Maybe Language,-- ^ language used when not explicitly specified
@@ -899,7 +899,7 @@ updatePackageDescription (mb_lib_bi, exe_bi) p
updateExecutable :: (String, BuildInfo) -- ^(exeName, new buildinfo)
-> [Executable] -- ^list of executables to update
- -> [Executable] -- ^libst with exeName updated
+ -> [Executable] -- ^list with exeName updated
updateExecutable _ [] = []
updateExecutable exe_bi'@(name,bi) (exe:exes)
| exeName exe == name = exe{buildInfo = bi `mappend` buildInfo exe} : exes
View
30 Cabal/Distribution/PackageDescription/Check.hs
@@ -15,7 +15,7 @@
-- different kinds of check so we can see which ones are appropriate to report
-- in different situations. This code gets uses when configuring a package when
-- we consider only basic problems. The higher standard is uses when when
--- preparing a source tarball and by hackage when uploading new packages. The
+-- preparing a source tarball and by Hackage when uploading new packages. The
-- reason for this is that we want to hold packages that are expected to be
-- distributed to a higher standard than packages that are only ever expected
-- to be used on the author's own environment.
@@ -99,13 +99,13 @@ data PackageCheck =
| PackageBuildWarning { explanation :: String }
-- | An issue that might not be a problem for the package author but
- -- might be annoying or determental when the package is distributed to
+ -- might be annoying or detrimental when the package is distributed to
-- users. We should encourage distributed packages to be free from these
-- issues, but occasionally there are justifiable reasons so we cannot
-- ban them entirely.
| PackageDistSuspicious { explanation :: String }
- -- | An issue that is ok in the author's environment but is almost
+ -- | An issue that is OK in the author's environment but is almost
-- certain to be a portability problem for other environments. We can
-- quite legitimately refuse to publicly distribute packages with these
-- problems.
@@ -131,7 +131,7 @@ checkSpecVersion pkg specver cond pc
-- | Check for common mistakes and problems in package descriptions.
--
--- This is the standard collection of checks covering all apsects except
+-- This is the standard collection of checks covering all aspects except
-- for checks that require looking at files within the package. For those
-- see 'checkPackageFiles'.
--
@@ -429,7 +429,7 @@ checkFields pkg =
, check (null (synopsis pkg) && not (null (description pkg))) $
PackageDistSuspicious "No 'synopsis' field."
- --TODO: recommend the bug reports url, author and homepage fields
+ --TODO: recommend the bug reports URL, author and homepage fields
--TODO: recommend not using the stability field
--TODO: recommend specifying a source repo
@@ -840,7 +840,7 @@ checkPaths pkg =
++ [ (path, "extra-lib-dirs") | path <- extraLibDirs bi ]
| bi <- allBuildInfo pkg ]
---TODO: check sets of paths that would be interpreted differently between unix
+--TODO: check sets of paths that would be interpreted differently between Unix
-- and windows, ie case-sensitive or insensitive. Things that might clash, or
-- conversely be distinguished.
@@ -936,7 +936,7 @@ checkCabalVersion pkg =
"The package uses wildcard syntax in the 'build-depends' field: "
++ commaSep (map display depsUsingWildcardSyntax)
++ ". To use this new syntax the package need to specify at least "
- ++ "'cabal-version: >= 1.6'. Alternatively, if broader compatability "
+ ++ "'cabal-version: >= 1.6'. Alternatively, if broader compatibility "
++ "is important then use: " ++ commaSep
[ display (Dependency name (eliminateWildcardSyntax versionRange))
| Dependency name versionRange <- depsUsingWildcardSyntax ]
@@ -956,7 +956,7 @@ checkCabalVersion pkg =
"The package uses wildcard syntax in the 'tested-with' field: "
++ commaSep (map display testedWithUsingWildcardSyntax)
++ ". To use this new syntax the package need to specify at least "
- ++ "'cabal-version: >= 1.6'. Alternatively, if broader compatability "
+ ++ "'cabal-version: >= 1.6'. Alternatively, if broader compatibility "
++ "is important then use: " ++ commaSep
[ display (Dependency name (eliminateWildcardSyntax versionRange))
| Dependency name versionRange <- testedWithUsingWildcardSyntax ]
@@ -967,7 +967,7 @@ checkCabalVersion pkg =
"Using wildcards like "
++ commaSep (map quote $ take 3 dataFilesUsingGlobSyntax)
++ " in the 'data-files' field requires 'cabal-version: >= 1.6'. "
- ++ "Alternatively if you require compatability with earlier Cabal "
+ ++ "Alternatively if you require compatibility with earlier Cabal "
++ "versions then list all the files explicitly."
-- check use of "extra-source-files: mk/*.in" syntax
@@ -977,7 +977,7 @@ checkCabalVersion pkg =
++ commaSep (map quote $ take 3 extraSrcFilesUsingGlobSyntax)
++ " in the 'extra-source-files' field requires "
++ "'cabal-version: >= 1.6'. Alternatively if you require "
- ++ "compatability with earlier Cabal versions then list all the files "
+ ++ "compatibility with earlier Cabal versions then list all the files "
++ "explicitly."
-- check use of "source-repository" section
@@ -993,7 +993,7 @@ checkCabalVersion pkg =
"Unfortunately the license " ++ quote (display (license pkg))
++ " messes up the parser in earlier Cabal versions so you need to "
++ "specify 'cabal-version: >= 1.4'. Alternatively if you require "
- ++ "compatability with earlier Cabal versions then use 'OtherLicense'."
+ ++ "compatibility with earlier Cabal versions then use 'OtherLicense'."
-- check for new language extensions
, checkVersion [1,2,3] (not (null mentionedExtensionsThatNeedCabal12)) $
@@ -1002,7 +1002,7 @@ checkCabalVersion pkg =
++ commaSep (map (quote . display) mentionedExtensionsThatNeedCabal12)
++ " break the parser in earlier Cabal versions so you need to "
++ "specify 'cabal-version: >= 1.2.3'. Alternatively if you require "
- ++ "compatability with earlier Cabal versions then you may be able to "
+ ++ "compatibility with earlier Cabal versions then you may be able to "
++ "use an equivalent compiler-specific flag."
, checkVersion [1,4] (not (null mentionedExtensionsThatNeedCabal14)) $
@@ -1011,7 +1011,7 @@ checkCabalVersion pkg =
++ commaSep (map (quote . display) mentionedExtensionsThatNeedCabal14)
++ " break the parser in earlier Cabal versions so you need to "
++ "specify 'cabal-version: >= 1.4'. Alternatively if you require "
- ++ "compatability with earlier Cabal versions then you may be able to "
+ ++ "compatibility with earlier Cabal versions then you may be able to "
++ "use an equivalent compiler-specific flag."
]
where
@@ -1139,7 +1139,7 @@ checkCabalVersion pkg =
-- | A variation on the normal 'Text' instance, shows any ()'s in the original
-- textual syntax. We need to show these otherwise it's confusing to users when
--- we complain of their presense but do not pretty print them!
+-- we complain of their presence but do not pretty print them!
--
displayRawVersionRange :: VersionRange -> String
displayRawVersionRange =
@@ -1269,7 +1269,7 @@ checkConditionals pkg =
-- ------------------------------------------------------------
-- | Sanity check things that requires IO. It looks at the files in the
--- package and expects to find the package unpacked in at the given filepath.
+-- package and expects to find the package unpacked in at the given file path.
--
checkPackageFiles :: PackageDescription -> FilePath -> IO [PackageCheck]
checkPackageFiles pkg root = checkPackageContent checkFilesIO pkg
View
4 Cabal/Distribution/PackageDescription/Configuration.hs
@@ -95,7 +95,7 @@ simplifyCondition cond i = fv . walk $ cond
COr c1 c2 -> fv' c1 ++ fv' c2
CAnd c1 c2 -> fv' c1 ++ fv' c2
--- | Simplify a configuration condition using the os and arch names. Returns
+-- | Simplify a configuration condition using the OS and arch names. Returns
-- the names of all the flags occurring in the condition.
simplifyWithSysParams :: OS -> Arch -> CompilerId -> Condition ConfVar
-> (Condition FlagName, [FlagName])
@@ -459,7 +459,7 @@ instance Monoid PDTagged where
--
finalizePackageDescription ::
FlagAssignment -- ^ Explicitly specified flag assignments
- -> (Dependency -> Bool) -- ^ Is a given depenency satisfiable from the set of
+ -> (Dependency -> Bool) -- ^ Is a given dependency satisfiable from the set of
-- available packages? If this is unknown then use
-- True.
-> Platform -- ^ The 'Arch' and 'OS'
View
2 Cabal/Distribution/PackageDescription/Parse.hs
@@ -761,7 +761,7 @@ parsePackageDescription file = do
-- * an optional library section, and an arbitrary number of executable
-- sections (in any order).
--
- -- The current implementatition just gathers all library-specific fields
+ -- The current implementation just gathers all library-specific fields
-- in a library section and wraps all executable stanzas in an executable
-- section.
sectionizeFields :: [Field] -> [Field]
View
8 Cabal/Distribution/ParseUtils.hs
@@ -415,15 +415,15 @@ data Token =
-- > else
-- > other
--
- -- this is ok
+ -- this is OK
Line LineNo Indent HasTabs String
| Span LineNo String -- ^ span in a line, following brackets
| OpenBracket LineNo | CloseBracket LineNo
type Indent = Int
type HasTabs = Bool
--- | Tokenise a single line, splitting on '{' '}' and the spans inbetween.
+-- | Tokenise a single line, splitting on '{' '}' and the spans in between.
-- Also trims leading & trailing space on those spans within the line.
tokeniseLine :: (LineNo, Indent, HasTabs, String) -> [Token]
tokeniseLine (n0, i, t, l) = case split n0 l of
@@ -460,8 +460,8 @@ mkTree :: [Token] -> ParseResult [SyntaxTree]
mkTree toks =
layout 0 [] toks >>= \(trees, trailing) -> case trailing of
[] -> return trees
- OpenBracket n:_ -> syntaxError n "mismatched backets, unexpected {"
- CloseBracket n:_ -> syntaxError n "mismatched backets, unexpected }"
+ OpenBracket n:_ -> syntaxError n "mismatched brackets, unexpected {"
+ CloseBracket n:_ -> syntaxError n "mismatched brackets, unexpected }"
-- the following two should never happen:
Span n l :_ -> syntaxError n $ "unexpected span: " ++ show l
Line n _ _ l :_ -> syntaxError n $ "unexpected line: " ++ show l
View
4 Cabal/Distribution/Simple.hs
@@ -56,7 +56,7 @@ module Distribution.Simple (
-- local
import Distribution.Simple.Compiler hiding (Flag)
import Distribution.Simple.UserHooks
-import Distribution.Package --must not specify imports, since we're exporting moule.
+import Distribution.Package --must not specify imports, since we're exporting module.
import Distribution.PackageDescription
( PackageDescription(..), GenericPackageDescription, Executable(..)
, updatePackageDescription, hasLibs
@@ -453,7 +453,7 @@ getBuildConfig hooks verbosity distPref = do
let cFlags' = cFlags {
-- Since the list of unconfigured programs is not serialized,
-- restore it to the same value as normally used at the beginning
- -- of a conigure run:
+ -- of a configure run:
configPrograms = restoreProgramConfiguration
(builtinPrograms ++ hookedPrograms hooks)
(configPrograms cFlags),
View
8 Cabal/Distribution/Simple/Build.hs
@@ -167,7 +167,7 @@ repl pkg_descr lbi flags suffixes args = do
pkg_descr lbi' suffixes comp clbi distPref
| (cname, clbi) <- init componentsToBuild ]
- -- repl for target components
+ -- REPL for target components
let (cname, clbi) = componentForRepl
comp = getComponent pkg_descr cname
lbi' = lbiForComponent comp lbi
@@ -201,12 +201,12 @@ buildComponent verbosity numJobs pkg_descr lbi suffixes
pwd <- getCurrentDirectory
let installedPkgInfo =
(inplaceInstalledPackageInfo pwd distPref pkg_descr lib lbi clbi) {
- -- The inplace registration uses the "-inplace" suffix,
+ -- The in place registration uses the "-inplace" suffix,
-- not an ABI hash.
IPI.installedPackageId = inplacePackageId (packageId installedPkgInfo)
}
registerPackage verbosity
- installedPkgInfo pkg_descr lbi True -- True meaning inplace
+ installedPkgInfo pkg_descr lbi True -- True meaning in place
(withPackageDB lbi)
@@ -442,7 +442,7 @@ addInternalBuildTools pkg lbi bi progs =
-- TODO: build separate libs in separate dirs so that we can build
--- multiple libs, e.g. for 'LibTest' library-style testsuites
+-- multiple libs, e.g. for 'LibTest' library-style test suites
buildLib :: Verbosity -> Flag (Maybe Int)
-> PackageDescription -> LocalBuildInfo
-> Library -> ComponentLocalBuildInfo -> IO ()
View
6 Cabal/Distribution/Simple/Command.hs
@@ -89,11 +89,11 @@ data ShowOrParseArgs = ShowArgs | ParseArgs
type Name = String
type Description = String
--- | We usually have a datatype for storing configuration values, where
+-- | We usually have a data type for storing configuration values, where
-- every field stores a configuration option, and the user sets
-- the value either via command line flags or a configuration file.
-- An individual OptionField models such a field, and we usually
--- build a list of options associated to a configuration datatype.
+-- build a list of options associated to a configuration data type.
data OptionField a = OptionField {
optionName :: Name,
optionDescr :: [OptDescr a] }
@@ -450,7 +450,7 @@ commandParseArgs command global args =
where -- Note: It is crucial to use reverse function composition here or to
-- reverse the flags here as we want to process the flags left to right
- -- but data flow in function compsition is right to left.
+ -- but data flow in function composition is right to left.
accum flags = foldr (flip (.)) id [ f | Right f <- flags ]
unrecognised opts = [ "unrecognized "
++ "'" ++ (commandName command) ++ "'"
View
10 Cabal/Distribution/Simple/GHC.hs
@@ -420,7 +420,7 @@ getExtensions verbosity ghcProg
then -- ghc-6.8 introduced RecordPuns however it
-- should have been NamedFieldPuns. We now
-- encourage packages to use NamedFieldPuns
- -- so for compatability we fake support for
+ -- so for compatibility we fake support for
-- it in ghc-6.8 by making it an alias for
-- the old RecordPuns extension.
(EnableExtension NamedFieldPuns, "-XRecordPuns") :
@@ -518,7 +518,7 @@ getInstalledPackages verbosity packagedbs conf = do
[(_,[rts])]
-> PackageIndex.insert (removeMingwIncludeDir rts) index
_ -> index -- No (or multiple) ghc rts package is registered!!
- -- Feh, whatever, the ghc testsuite does some crazy stuff.
+ -- Feh, whatever, the ghc test suite does some crazy stuff.
-- | Given a list of @(PackageDB, InstalledPackageInfo)@ pairs, produce a
-- @PackageIndex@. Helper function used by 'getPackageDBContents' and
@@ -560,7 +560,7 @@ ghcGlobalPackageDB verbosity ghcProg =
-- Cabal does not use the environment variable GHC_PACKAGE_PATH; let users
-- know that this is the case. See ticket #335. Simply ignoring it is not a
-- good idea, since then ghc and cabal are looking at different sets of
--- package dbs and chaos is likely to ensue.
+-- package DBs and chaos is likely to ensue.
checkPackageDbEnvVar :: IO ()
checkPackageDbEnvVar = do
hasGPP <- (getEnv "GHC_PACKAGE_PATH" >> return True)
@@ -1015,7 +1015,7 @@ buildOrReplExe forRepl verbosity numJobsFlag _pkg_descr lbi
-- With dynamic-by-default GHC the TH object files loaded at compile-time
-- need to be .dyn_o instead of .o.
doingTH = EnableExtension TemplateHaskell `elem` allExtensions exeBi
- -- Should we use -dynamic-too instead of compilng twice?
+ -- Should we use -dynamic-too instead of compiling twice?
useDynToo = dynamicTooSupported && isGhcDynamic
&& doingTH && withStaticExe && null (ghcSharedOptions exeBi)
compileTHOpts | isGhcDynamic = dynOpts
@@ -1252,7 +1252,7 @@ installExe verbosity lbi installDirs buildPref
installLib :: Verbosity
-> LocalBuildInfo
-> FilePath -- ^install location
- -> FilePath -- ^install location for dynamic librarys
+ -> FilePath -- ^install location for dynamic libraries
-> FilePath -- ^Build location
-> PackageDescription
-> Library
View
18 Cabal/Distribution/Simple/Haddock.hs
@@ -14,7 +14,7 @@
-- about installed packages (from @ghc-pkg@) to find the locations of
-- documentation for dependent packages, so it can create links.
--
--- The @hscolour@ support allows generating html versions of the original
+-- The @hscolour@ support allows generating HTML versions of the original
-- source, with coloured syntax highlighting.
module Distribution.Simple.Haddock (
@@ -100,13 +100,13 @@ data HaddockArgs = HaddockArgs {
argInterfaceFile :: Flag FilePath, -- ^ path of the interface file, relative to argOutputDir, required.
argPackageName :: Flag PackageIdentifier, -- ^ package name, required.
argHideModules :: (All,[ModuleName.ModuleName]), -- ^ (hide modules ?, modules to hide)
- argIgnoreExports :: Any, -- ^ ingore export lists in modules?
+ argIgnoreExports :: Any, -- ^ ignore export lists in modules?
argLinkSource :: Flag (Template,Template,Template), -- ^ (template for modules, template for symbols, template for lines)
- argCssFile :: Flag FilePath, -- ^ optinal custom css file.
- argContents :: Flag String, -- ^ optional url to contents page
+ argCssFile :: Flag FilePath, -- ^ optional custom CSS file.
+ argContents :: Flag String, -- ^ optional URL to contents page
argVerbose :: Any,
- argOutput :: Flag [Output], -- ^ Html or Hoogle doc or both? required.
- argInterfaces :: [(FilePath, Maybe String)], -- ^ [(interface file, URL to the html docs for links)]
+ argOutput :: Flag [Output], -- ^ HTML or Hoogle doc or both? required.
+ argInterfaces :: [(FilePath, Maybe String)], -- ^ [(interface file, URL to the HTML docs for links)]
argOutputDir :: Directory, -- ^ where to generate the documentation.
argTitle :: Flag String, -- ^ page's title, required.
argPrologue :: Flag String, -- ^ prologue text, required.
@@ -308,7 +308,7 @@ fromPackageDescription pkg_descr =
fromLibrary :: Verbosity
-> FilePath
-> LocalBuildInfo -> Library -> ComponentLocalBuildInfo
- -> Maybe PathTemplate -- ^ template for html location
+ -> Maybe PathTemplate -- ^ template for HTML location
-> IO HaddockArgs
fromLibrary verbosity tmp lbi lib clbi htmlTemplate = do
inFiles <- map snd `fmap` getLibSourceFiles lbi lib
@@ -346,7 +346,7 @@ fromLibrary verbosity tmp lbi lib clbi htmlTemplate = do
fromExecutable :: Verbosity
-> FilePath
-> LocalBuildInfo -> Executable -> ComponentLocalBuildInfo
- -> Maybe PathTemplate -- ^ template for html location
+ -> Maybe PathTemplate -- ^ template for HTML location
-> IO HaddockArgs
fromExecutable verbosity tmp lbi exe clbi htmlTemplate = do
inFiles <- map snd `fmap` getExeSourceFiles lbi exe
@@ -403,7 +403,7 @@ compToExe comp =
getInterfaces :: Verbosity
-> LocalBuildInfo
-> ComponentLocalBuildInfo
- -> Maybe PathTemplate -- ^ template for html location
+ -> Maybe PathTemplate -- ^ template for HTML location
-> IO HaddockArgs
getInterfaces verbosity lbi clbi htmlTemplate = do
(packageFlags, warnings) <- haddockPackageFlags lbi clbi htmlTemplate
View
2 Cabal/Distribution/Simple/HaskellSuite.hs
@@ -180,7 +180,7 @@ installLib
:: Verbosity
-> LocalBuildInfo
-> FilePath -- ^install location
- -> FilePath -- ^install location for dynamic librarys
+ -> FilePath -- ^install location for dynamic libraries
-> FilePath -- ^Build location
-> PackageDescription
-> Library
View
16 Cabal/Distribution/Simple/InstallDirs.hs
@@ -63,15 +63,15 @@ import Foreign.C
#endif
-- ---------------------------------------------------------------------------
--- Instalation directories
+-- Installation directories
-- | The directories where we will install files for packages.
--
-- We have several different directories for different types of files since
-- many systems have conventions whereby different types of files in a package
--- are installed in different direcotries. This is particularly the case on
--- unix style systems.
+-- are installed in different directories. This is particularly the case on
+-- Unix style systems.
--
data InstallDirs dir = InstallDirs {
prefix :: dir,
@@ -168,11 +168,11 @@ appendSubdirs append dirs = dirs {
-- convenient for the user to override the default installation directory
-- by only having to specify --prefix=... rather than overriding each
-- individually. This is done by allowing $-style variables in the dirs.
--- These are expanded by textual substituion (see 'substPathTemplate').
+-- These are expanded by textual substitution (see 'substPathTemplate').
--
-- A few of these installation directories are split into two components, the
-- dir and subdir. The full installation path is formed by combining the two
--- together with @\/@. The reason for this is compatibility with other unix
+-- together with @\/@. The reason for this is compatibility with other Unix
-- build systems which also support @--libdir@ and @--datadir@. We would like
-- users to be able to configure @--libdir=\/usr\/lib64@ for example but
-- because by default we want to support installing multiple versions of
@@ -336,7 +336,7 @@ prefixRelativeInstallDirs pkgId compilerId platform dirs =
-- ---------------------------------------------------------------------------
-- Path templates
--- | An abstract path, posibly containing variables that need to be
+-- | An abstract path, possibly containing variables that need to be
-- substituted for to get a real 'FilePath'.
--
newtype PathTemplate = PathTemplate [PathComponent]
@@ -360,7 +360,7 @@ data PathTemplateVariable =
| PkgIdVar -- ^ The @$pkgid@ package Id path variable, eg @foo-1.0@
| CompilerVar -- ^ The compiler name and version, eg @ghc-6.6.1@
| OSVar -- ^ The operating system name, eg @windows@ or @linux@
- | ArchVar -- ^ The cpu architecture name, eg @i386@ or @x86_64@
+ | ArchVar -- ^ The CPU architecture name, eg @i386@ or @x86_64@
| ExecutableNameVar -- ^ The executable name; used in shell wrappers
| TestSuiteNameVar -- ^ The name of the test suite being run
| TestSuiteResultVar -- ^ The result of the test suite being run, eg
@@ -493,7 +493,7 @@ instance Show PathComponent where
showList = foldr (\x -> (shows x .)) id
instance Read PathComponent where
- -- for some reason we colapse multiple $ symbols here
+ -- for some reason we collapse multiple $ symbols here
readsPrec _ = lex0
where lex0 [] = []
lex0 ('$':'$':s') = lex0 ('$':s')
View
12 Cabal/Distribution/Simple/LHC.hs
@@ -333,7 +333,7 @@ buildLib verbosity pkg_descr lbi lib clbi = do
-- TH always needs vanilla libs, even when building for profiling
createDirectoryIfMissingVerbose verbosity True libTargetDir
- -- TODO: do we need to put hs-boot files into place for mutually recurive modules?
+ -- TODO: do we need to put hs-boot files into place for mutually recursive modules?
let ghcArgs =
["-package-name", display pkgid ]
++ constructGHCCmdLine lbi libBi clbi libTargetDir verbosity
@@ -460,10 +460,10 @@ buildLib verbosity pkg_descr lbi lib clbi = do
runAr = rawSystemProgramConf verbosity arProgram (withPrograms lbi)
- --TODO: discover this at configure time or runtime on unix
- -- The value is 32k on Windows and posix specifies a minimum of 4k
- -- but all sensible unixes use more than 4k.
- -- we could use getSysVar ArgumentLimit but that's in the unix lib
+ --TODO: discover this at configure time or runtime on Unix
+ -- The value is 32k on Windows and POSIX specifies a minimum of 4k
+ -- but all sensible Unixes use more than 4k.
+ -- we could use getSysVar ArgumentLimit but that's in the Unix lib
maxCommandLineSize = 30 * 1024
ifVanillaLib False $ xargs maxCommandLineSize
@@ -728,7 +728,7 @@ stripExe verbosity lbi name path = when (stripExes lbi) $
installLib :: Verbosity
-> LocalBuildInfo
-> FilePath -- ^install location
- -> FilePath -- ^install location for dynamic librarys
+ -> FilePath -- ^install location for dynamic libraries
-> FilePath -- ^Build location
-> PackageDescription
-> Library
View
2 Cabal/Distribution/Simple/LocalBuildInfo.hs
@@ -92,7 +92,7 @@ data LocalBuildInfo = LocalBuildInfo {
-- ^ Extra args on the command line for the configuration step.
-- Needed to re-run configuration when .cabal is out of date
installDirTemplates :: InstallDirTemplates,
- -- ^ The installation directories for the various differnt
+ -- ^ The installation directories for the various different
-- kinds of files
--TODO: inplaceDirTemplates :: InstallDirs FilePath
compiler :: Compiler,
View
10 Cabal/Distribution/Simple/PackageIndex.hs
@@ -89,15 +89,15 @@ import Distribution.Simple.Utils (lowercase, comparing, equating)
-- | The collection of information about packages from one or more 'PackageDB's.
--
-- Packages are uniquely identified in by their 'InstalledPackageId', they can
--- also be effeciently looked up by package name or by name and version.
+-- also be efficiently looked up by package name or by name and version.
--
data PackageIndex = PackageIndex
-- The primary index. Each InstalledPackageInfo record is uniquely identified
-- by its InstalledPackageId.
--
!(Map InstalledPackageId InstalledPackageInfo)
- -- This auxillary index maps package names (case-sensitively) to all the
+ -- This auxiliary index maps package names (case-sensitively) to all the
-- versions and instances of that package. This allows us to find all
-- versions satisfying a dependency.
--
@@ -372,12 +372,12 @@ lookupDependency (PackageIndex _ pnames) (Dependency name versionRange) =
-- | Does a case-insensitive search by package name.
--
--- If there is only one package that compares case-insentiviely to this name
+-- If there is only one package that compares case-insensitively to this name
-- then the search is unambiguous and we get back all versions of that package.
--- If several match case-insentiviely but one matches exactly then it is also
+-- If several match case-insensitively but one matches exactly then it is also
-- unambiguous.
--
--- If however several match case-insentiviely and none match exactly then we
+-- If however several match case-insensitively and none match exactly then we
-- have an ambiguous result, and we get back all the versions of all the
-- packages. The list of ambiguous results is split by exact package name. So
-- it is a non-empty list of non-empty lists.
View
2 Cabal/Distribution/Simple/Program.hs
@@ -58,7 +58,7 @@ module Distribution.Simple.Program (
, runProgramInvocation
, getProgramInvocationOutput
- -- * The collection of unconfigured and configured progams
+ -- * The collection of unconfigured and configured programs
, builtinPrograms
-- * The collection of configured programs we can run
View
2 Cabal/Distribution/Simple/Program/Builtin.hs
@@ -12,7 +12,7 @@
--
module Distribution.Simple.Program.Builtin (
- -- * The collection of unconfigured and configured progams
+ -- * The collection of unconfigured and configured programs
builtinPrograms,
-- * Programs that Cabal knows about
View
6 Cabal/Distribution/Simple/Program/Db.hs
@@ -171,7 +171,7 @@ knownPrograms conf =
-- | Get the current 'ProgramSearchPath' used by the 'ProgramDb'.
-- This is the default list of locations where programs are looked for when
--- configuring them. This can be overriden for specific programs (with
+-- configuring them. This can be overridden for specific programs (with
-- 'userSpecifyPath'), and specific known programs can modify or ignore this
-- search path in their own configuration code.
--
@@ -274,8 +274,8 @@ configuredPrograms = Map.elems . configuredProgs
-- Configuring known programs
-- | Try to configure a specific program. If the program is already included in
--- the colleciton of unconfigured programs then we use any user-supplied
--- location and arguments. If the program gets configured sucessfully it gets
+-- the collection of unconfigured programs then we use any user-supplied
+-- location and arguments. If the program gets configured successfully it gets
-- added to the configured collection.
--
-- Note that it is not a failure if the program cannot be configured. It's only
View
4 Cabal/Distribution/Simple/Program/Types.hs
@@ -57,7 +57,7 @@ data Program = Program {
-> IO (Maybe FilePath),
-- | Try to find the version of the program. For many programs this is
- -- not possible or is not necessary so it's ok to return Nothing.
+ -- not possible or is not necessary so it's OK to return Nothing.
programFindVersion :: Verbosity -> FilePath -> IO (Maybe Version),
-- | A function to do any additional configuration after we have
@@ -100,7 +100,7 @@ data ConfiguredProgram = ConfiguredProgram {
programLocation :: ProgramLocation
} deriving (Read, Show, Eq)
--- | Where a program was found. Also tells us whether it's specifed by user or
+-- | Where a program was found. Also tells us whether it's specified by user or
-- not. This includes not just the path, but the program as well.
data ProgramLocation
= UserSpecified { locationPath :: FilePath }
View
6 Cabal/Distribution/Simple/Register.hs
@@ -15,7 +15,7 @@
-- popular so we also provide a way to simply generate the package registration
-- file which then must be manually passed to @ghc-pkg@. It is possible to
-- generate registration information for where the package is to be installed,
--- or alternatively to register the package inplace in the build tree. The
+-- or alternatively to register the package in place in the build tree. The
-- latter is occasionally handy, and will become more important when we try to
-- build multi-package systems.
--
@@ -306,10 +306,10 @@ generalInstalledPackageInfo adjustRelIncDirs pkg lib clbi installDirs =
hasLibrary = hasModules || not (null (cSources bi))
--- | Construct 'InstalledPackageInfo' for a library that is inplace in the
+-- | Construct 'InstalledPackageInfo' for a library that is in place in the
-- build tree.
--
--- This function knows about the layout of inplace packages.
+-- This function knows about the layout of in place packages.
--
inplaceInstalledPackageInfo :: FilePath -- ^ top of the build tree
-> FilePath -- ^ location of the dist tree
View
12 Cabal/Distribution/Simple/Setup.hs
@@ -250,11 +250,11 @@ data ConfigFlags = ConfigFlags {
configPrograms :: ProgramConfiguration, -- ^All programs that cabal may
-- run
- configProgramPaths :: [(String, FilePath)], -- ^user specifed programs paths
- configProgramArgs :: [(String, [String])], -- ^user specifed programs args
+ configProgramPaths :: [(String, FilePath)], -- ^user specified programs paths
+ configProgramArgs :: [(String, [String])], -- ^user specified programs args
configProgramPathExtra :: [FilePath], -- ^Extend the $PATH
configHcFlavor :: Flag CompilerFlavor, -- ^The \"flavor\" of the
- -- compiler, sugh as GHC or
+ -- compiler, such as GHC or
-- Hugs.
configHcPath :: Flag FilePath, -- ^given compiler location
configHcPkg :: Flag FilePath, -- ^given hc-pkg location
@@ -1411,7 +1411,7 @@ buildCommand progConf =
-- ++ " A module\n"
-- ++ " " ++ pname ++ " build Foo/Bar.hs"
-- ++ " A file\n\n"
--- ++ "If a target is ambigious it can be qualified with the component "
+-- ++ "If a target is ambiguous it can be qualified with the component "
-- ++ "name, e.g.\n"
-- ++ " " ++ pname ++ " build foo:Foo.Bar\n"
-- ++ " " ++ pname ++ " build testsuite1:Foo/Bar.hs\n"
@@ -1455,7 +1455,7 @@ instance Monoid BuildFlags where
where combine field = field a `mappend` field b
-- ------------------------------------------------------------
--- * Repl Flags
+-- * REPL Flags
-- ------------------------------------------------------------
data ReplFlags = ReplFlags {
@@ -1508,7 +1508,7 @@ replCommand progConf = CommandUI {
-- ++ " A module\n"
-- ++ " " ++ pname ++ " repl Foo/Bar.hs"
-- ++ " A file\n\n"
--- ++ "If a target is ambigious it can be qualified with the component "
+-- ++ "If a target is ambiguous it can be qualified with the component "
-- ++ "name, e.g.\n"
-- ++ " " ++ pname ++ " repl foo:Foo.Bar\n"
-- ++ " " ++ pname ++ " repl testsuite1:Foo/Bar.hs\n"
View
2 Cabal/Distribution/Simple/SrcDist.hs
@@ -29,7 +29,7 @@ module Distribution.Simple.SrcDist (
prepareTree,
createArchive,
- -- ** Snaphots
+ -- ** Snapshots
prepareSnapshotTree,
snapshotPackage,
snapshotVersion,
View
4 Cabal/Distribution/Simple/UHC.hs
@@ -118,7 +118,7 @@ packageDbPaths user system db =
UserPackageDB -> [ user ]
SpecificPackageDB path -> [ path ]
--- | Hack to add version numbers to UHC-builtin packages. This should sooner or
+-- | Hack to add version numbers to UHC-built-in packages. This should sooner or
-- later be fixed on the UHC side.
addBuiltinVersions :: String -> String
{-
@@ -240,7 +240,7 @@ installLib verbosity _lbi targetDir _dynlibTargetDir builtDir pkg _library = do
-- putStrLn $ "built: " ++ builtDir
installDirectoryContents verbosity (builtDir </> display (packageId pkg)) targetDir
--- currently hardcoded UHC code generator and variant to use
+-- currently hard-coded UHC code generator and variant to use
uhcTarget, uhcTargetVariant :: String
uhcTarget = "bc"
uhcTargetVariant = "plain"
View
2 Cabal/Distribution/Simple/UserHooks.hs
@@ -71,7 +71,7 @@ data UserHooks = UserHooks {
-- |Hook to run before build command. Second arg indicates verbosity level.
preBuild :: Args -> BuildFlags -> IO HookedBuildInfo,
- -- |Over-ride this hook to gbet different behavior during build.
+ -- |Over-ride this hook to get different behavior during build.
buildHook :: PackageDescription -> LocalBuildInfo -> UserHooks -> BuildFlags -> IO (),
-- |Hook to run after build command. Second arg indicates verbosity level.
postBuild :: Args -> BuildFlags -> PackageDescription -> LocalBuildInfo -> IO (),
View
8 Cabal/Distribution/Simple/Utils.hs
@@ -398,7 +398,7 @@ syncProcess fun c = do
return ()
#endif /* mingw32_HOST_OS */
--- Exit with the same exitcode if the subcommand fails
+-- Exit with the same exit code if the subcommand fails
rawSystemExit :: Verbosity -> FilePath -> [String] -> IO ()
rawSystemExit verbosity path args = do
printRawCommandAndArgs verbosity path args
@@ -580,7 +580,7 @@ findProgramVersion versionArg selectVersion verbosity path = do
return version
--- | Like the unix xargs program. Useful for when we've got very long command
+-- | Like the Unix xargs program. Useful for when we've got very long command
-- lines that might overflow an OS limit on command line length and so you
-- need to invoke a command multiple times to get all the args in.
--
@@ -825,7 +825,7 @@ createDirectoryIfMissingVerbose verbosity create_parents path0
-- createDirectory (and indeed POSIX mkdir) does not distinguish
-- between a dir already existing and a file already existing. So we
-- check for it here. Unfortunately there is a slight race condition
- -- here, but we think it is benign. It could report an exeption in
+ -- here, but we think it is benign. It could report an exception in
-- the case that the dir did exist but another process deletes the
-- directory and creates a file in its place before we can check
-- that the directory did indeed exist.
@@ -1263,7 +1263,7 @@ writeUTF8File path = writeFileAtomic path . BS.Char8.pack . toUTF8
normaliseLineEndings :: String -> String
normaliseLineEndings [] = []
normaliseLineEndings ('\r':'\n':s) = '\n' : normaliseLineEndings s -- windows
-normaliseLineEndings ('\r':s) = '\n' : normaliseLineEndings s -- old osx
+normaliseLineEndings ('\r':s) = '\n' : normaliseLineEndings s -- old OS X
normaliseLineEndings ( c :s) = c : normaliseLineEndings s
-- ------------------------------------------------------------
View
8 Cabal/Distribution/System.hs
@@ -45,13 +45,13 @@ import Text.PrettyPrint ((<>))
-- The reason we have multiple ways to do the classification is because there
-- are two situations where we need to do it.
--
--- For parsing os and arch names in .cabal files we really want everyone to be
+-- For parsing OS and arch names in .cabal files we really want everyone to be
-- referring to the same or or arch by the same name. Variety is not a virtue
-- in this case. We don't mind about case though.
--
-- For the System.Info.os\/arch different Haskell implementations use different
-- names for the same or\/arch. Also they tend to distinguish versions of an
--- os\/arch which we just don't care about.
+-- OS\/arch which we just don't care about.
--
-- The 'Compat' classification allows us to recognise aliases that are already
-- in common use but it allows us to distinguish them from the canonical name
@@ -64,7 +64,7 @@ data ClassificationStrictness = Permissive | Compat | Strict
-- ------------------------------------------------------------
data OS = Linux | Windows | OSX -- tier 1 desktop OSs
- | FreeBSD | OpenBSD | NetBSD -- other free unix OSs
+ | FreeBSD | OpenBSD | NetBSD -- other free Unix OSs
| DragonFly
| Solaris | AIX | HPUX | IRIX -- ageing Unix OSs
| HaLVM -- bare metal / VMs / hypervisors
@@ -74,7 +74,7 @@ data OS = Linux | Windows | OSX -- tier 1 desktop OSs
--TODO: decide how to handle Android and iOS.
-- They are like Linux and OSX but with some differences.
--- Should they be separate from linux/osx, or a subtype?
+-- Should they be separate from Linux/OS X, or a subtype?
-- e.g. should we have os(linux) && os(android) true simultaneously?
knownOSs :: [OS]
View
4 Cabal/Distribution/Version.hs
@@ -224,7 +224,7 @@ removeUpperBound = fromVersionIntervals . relaxLastInterval . toVersionIntervals
-- | Fold over the basic syntactic structure of a 'VersionRange'.
--
--- This provides a syntacic view of the expression defining the version range.
+-- This provides a syntactic view of the expression defining the version range.
-- The syntactic sugar @\">= v\"@, @\"<= v\"@ and @\"== v.*\"@ is presented
-- in terms of the other basic syntax.
--
@@ -478,7 +478,7 @@ checkInvariant is = assert (invariant is) is
-- | Directly construct a 'VersionIntervals' from a list of intervals.
--
-- Each interval must be non-empty. The sequence must be in increasing order
--- and no invervals may overlap or touch. If any of these conditions are not
+-- and no intervals may overlap or touch. If any of these conditions are not
-- satisfied the function returns @Nothing@.
--
mkVersionIntervals :: [VersionInterval] -> Maybe VersionIntervals
View
2 Cabal/Language/Haskell/Extension.hs
@@ -692,7 +692,7 @@ deprecatedExtensions =
]
-- NOTE: when adding deprecated extensions that have new alternatives
-- we must be careful to make sure that the deprecation messages are
--- valid. We must not recomend aliases that cannot be used with older
+-- valid. We must not recommend aliases that cannot be used with older
-- compilers, perhaps by adding support in Cabal to translate the new
-- name to the old one for older compilers. Otherwise we are in danger
-- of the scenario in ticket #689.
View
2 Cabal/tests/README
@@ -4,7 +4,7 @@ Writing Package Tests
The tests under the `PackageTests` directory define and build packages which
exercise various components of Cabal. Each test case is an `HUnit` test. The
entry point for the test suite, where all the test cases are listed, is
-`PackageTests.hs`. There are utilites for calling the stages of Cabal's build
+`PackageTests.hs`. There are utilities for calling the stages of Cabal's build
process in `PackageTests/PackageTester.hs`; have a look at an existing test case
to see how they're used.
View
2 Cabal/tests/UnitTests/Distribution/Compat/ReadP.hs
@@ -8,7 +8,7 @@
-- Portability : portable
--
-- This code was originally in Distribution.Compat.ReadP. Please see that file
--- for provenace. The tests have been integrated into the test framework.
+-- for provenance. The tests have been integrated into the test framework.
-- Some properties cannot be tested, as they hold over arbitrary ReadP values,
-- and we don't have a good Arbitrary instance (nor Show instance) for ReadP.
--
View
2 cabal-install/Distribution/Client/Compat/Environment.hs
@@ -54,7 +54,7 @@ setEnv key value_
| otherwise = setEnv_ key value
where
-- NOTE: Anything that follows NUL is ignored on both POSIX and Windows. We
- -- still strip it manually so that the null check above succeds if a value
+ -- still strip it manually so that the null check above succeeds if a value
-- starts with NUL.
value = takeWhile (/= '\NUL') value_
View
2 cabal-install/Distribution/Client/Config.hs
@@ -429,7 +429,7 @@ configFieldDescriptions =
++ toSavedConfig liftReportFlag
(commandOptions reportCommand ParseArgs)
["verbose", "username", "password"] []
- --FIXME: this is a hack, hiding the username and password.
+ --FIXME: this is a hack, hiding the user name and password.
-- But otherwise it masks the upload ones. Either need to
-- share the options or make then distinct. In any case
-- they should probably be per-server.
View
8 cabal-install/Distribution/Client/Dependency.hs
@@ -235,7 +235,7 @@ dontUpgradeNonUpgradeablePackages params =
, isInstalled pkgname ]
-- TODO: the top down resolver chokes on the base constraints
-- below when there are no targets and thus no dep on base.
- -- Need to refactor contraints separate from needing packages.
+ -- Need to refactor constraints separate from needing packages.
isInstalled = not . null
. InstalledPackageIndex.lookupPackageName
(depResolverInstalledPkgIndex params)
@@ -466,7 +466,7 @@ chooseSolver verbosity Choose (CompilerId f v) = do
return chosenSolver
runSolver :: Solver -> SolverConfig -> DependencyResolver
-runSolver TopDown = const topDownResolver -- TODO: warn about unsuported options
+runSolver TopDown = const topDownResolver -- TODO: warn about unsupported options
runSolver Modular = modularResolver
-- | Run the dependency solver.
@@ -508,7 +508,7 @@ resolveDependencies platform comp solver params =
-- The modular solver can properly deal with broken
-- packages and won't select them. So the
-- 'hideBrokenInstalledPackages' function should be moved
- -- into a module that is specific to the Topdown solver.
+ -- into a module that is specific to the top-down solver.
. (if solver /= Modular then hideBrokenInstalledPackages
else id)
$ params
@@ -577,7 +577,7 @@ interpretPackagesPreference selected defaultPref prefs =
-- It is suitable for tasks such as selecting packages to download for user
-- inspection. It is not suitable for selecting packages to install.
--
--- Note: if no installed package index is available, it is ok to pass 'mempty'.
+-- Note: if no installed package index is available, it is OK to pass 'mempty'.
-- It simply means preferences for installed packages will be ignored.
--
resolveWithoutDependencies :: DepResolverParams
View
2 cabal-install/Distribution/Client/Dependency/Modular/IndexConversion.hs
@@ -41,7 +41,7 @@ convPIs os arch cid sip iidx sidx =
-- more uniform index format of the solver.
convIPI' :: Bool -> SI.PackageIndex -> [(PN, I, PInfo)]
convIPI' sip idx =
- -- apply shadowing whenever there are multple installed packages with
+ -- apply shadowing whenever there are multiple installed packages with
-- the same version
[ maybeShadow (convIP idx pkg)
| (_pkgid, pkgs) <- SI.allPackagesBySourcePackageId idx
View
2 cabal-install/Distribution/Client/Dependency/Modular/PSQ.hs
@@ -2,7 +2,7 @@ module Distribution.Client.Dependency.Modular.PSQ where
-- Priority search queues.
--
--- I am not yet sure what exactly is needed. But we need a datastructure with
+-- I am not yet sure what exactly is needed. But we need a data structure with
-- key-based lookup that can be sorted. We're using a sequence right now with
-- (inefficiently implemented) lookup, because I think that queue-based
-- operations and sorting turn out to be more efficiency-critical in practice.
View
2 cabal-install/Distribution/Client/Dependency/Modular/Validate.hs
@@ -23,7 +23,7 @@ import Distribution.Client.Dependency.Modular.Tree
-- In practice, most constraints are implication constraints (IF we have made
-- a number of choices, THEN we also have to ensure that). We call constraints
--- that for which the precondiditions are fulfilled ACTIVE. We maintain a set
+-- that for which the preconditions are fulfilled ACTIVE. We maintain a set
-- of currently active constraints that we pass down the node.
--
-- We aim at detecting inconsistent states as early as possible.
View
4 cabal-install/Distribution/Client/Dependency/Types.hs
@@ -130,7 +130,7 @@ data PackageConstraint
-- | A per-package preference on the version. It is a soft constraint that the
-- 'DependencyResolver' should try to respect where possible. It consists of
-- a 'InstalledPreference' which says if we prefer versions of packages
--- that are already installed. It also hase a 'PackageVersionPreference' which
+-- that are already installed. It also has a 'PackageVersionPreference' which
-- is a suggested constraint on the version number. The resolver should try to
-- use package versions that satisfy the suggested version constraint.
--
@@ -192,7 +192,7 @@ isAllowNewer AllowNewerAll = True
-- | A type to represent the unfolding of an expensive long running
-- calculation that may fail. We may get intermediate steps before the final
--- retult which may be used to indicate progress and\/or logging messages.
+-- result which may be used to indicate progress and\/or logging messages.
--
data Progress step fail done = Step step (Progress step fail done)
| Fail fail
View
2 cabal-install/Distribution/Client/Freeze.hs
@@ -66,7 +66,7 @@ import Distribution.Version
-- ------------------------------------------------------------
--TODO:
--- * Don't overwrite all of `cabal.config`, just the constaints section.
+-- * Don't overwrite all of `cabal.config`, just the constraints section.
-- * Should the package represented by `UserTargetLocalDir "."` be
-- constrained too? What about `base`?
View
4 cabal-install/Distribution/Client/Get.hs
@@ -105,7 +105,7 @@ get verbosity repos globalFlags getFlags userTargets = do
where
resolverParams sourcePkgDb pkgSpecifiers =
- --TODO: add commandline constraint and preference args for unpack
+ --TODO: add command-line constraint and preference args for unpack
standardInstallPolicy mempty sourcePkgDb pkgSpecifiers
prefix = fromFlagOrDefault "" (getDestDir getFlags)
@@ -214,7 +214,7 @@ findUsableBranchers = do
return (Data.Map.fromList pairs)
-- | Fork a single package from a remote source repository to the local
--- filesystem.
+-- file system.
forkPackage :: Verbosity
-> Data.Map.Map PD.RepoType Brancher
-- ^ Branchers supported by the local machine.
View
2 cabal-install/Distribution/Client/HttpUtils.hs
@@ -43,7 +43,7 @@ import System.Directory
data DownloadResult = FileAlreadyInCache | FileDownloaded FilePath deriving (Eq)
--- Trime
+-- Trim
trim :: String -> String
trim = f . f
where f = reverse . dropWhile isSpace
View
6 cabal-install/Distribution/Client/IndexUtils.hs
@@ -93,7 +93,7 @@ getInstalledPackages verbosity comp packageDbs conf =
convert :: InstalledPackageIndex.PackageIndex -> PackageIndex InstalledPackage
convert index' = PackageIndex.fromList
-- There can be multiple installed instances of each package version,
- -- like when the same package is installed in the global & user dbs.
+ -- like when the same package is installed in the global & user DBs.
-- InstalledPackageIndex.allPackagesBySourcePackageId gives us the
-- installed packages with the most preferred instances first, so by
-- picking the first we should get the user one. This is almost but not
@@ -109,7 +109,7 @@ convert index' = PackageIndex.fromList
-- other packages that do not exist then we have a problem we cannot find
-- the original source package id. Instead we make up a bogus package id.
-- This should have the same effect since it should be a dependency on a
- -- non-existant package.
+ -- nonexistent package.
sourceDeps index ipkg =
[ maybe (brokenPackageId depid) packageId mdep
| let depids = InstalledPackageInfo.depends ipkg
@@ -281,7 +281,7 @@ packageDesc (BuildTreeRef _ _ descr _ _) = descr
-- | Read a compressed \"00-index.tar.gz\" file into a 'PackageIndex'.
--
-- This is supposed to be an \"all in one\" way to easily get at the info in
--- the hackage package index.
+-- the Hackage package index.
--
-- It takes a function to map a 'GenericPackageDescription' into any more
-- specific instance of 'Package' that you might want to use. In the simple
View
6 cabal-install/Distribution/Client/Init/Heuristics.hs
@@ -118,7 +118,7 @@ sfToFileName projectRoot (SourceFileEntry relPath m ext _ _)
= projectRoot </> relPath </> toFilePath m <.> ext
-- |Search for source files in the given directory
--- and return pairs of guessed haskell source path and
+-- and return pairs of guessed Haskell source path and
-- module names.
scanForModules :: FilePath -> IO [SourceFileEntry]
scanForModules rootDir = scanForModulesIn rootDir rootDir
@@ -329,7 +329,7 @@ maybeReadFile f = do
then fmap Just $ readFile f
else return Nothing
--- |Get list of categories used in hackage. NOTE: Very slow, needs to be cached
+-- |Get list of categories used in Hackage. NOTE: Very slow, needs to be cached
knownCategories :: SourcePackageDb -> [String]
knownCategories (SourcePackageDb sourcePkgIndex _) = nubSet
[ cat | pkg <- map head (allPackagesByName sourcePkgIndex)
@@ -352,7 +352,7 @@ trim = removeLeadingSpace . reverse . removeLeadingSpace . reverse
where
removeLeadingSpace = dropWhile isSpace
--- split string at given character, and remove whitespaces
+-- split string at given character, and remove whitespace
splitString :: Char -> String -> [String]
splitString sep str = go str where
go s = if null s' then [] else tok : go rest where
View
8 cabal-install/Distribution/Client/Install.hs
@@ -207,12 +207,12 @@ install verbosity packageDBs repos comp platform conf useSandbox mSandboxPkgInfo
++ "recreating the sandbox."
logMsg message rest = debugNoWrap verbosity message >> rest
--- TODO: Make InstallContext a proper datatype with documented fields.
+-- TODO: Make InstallContext a proper data type with documented fields.
-- | Common context for makeInstallPlan and processInstallPlan.
type InstallContext = ( PackageIndex, SourcePackageDb
, [UserTarget], [PackageSpecifier SourcePackage] )
--- TODO: Make InstallArgs a proper datatype with documented fields or just get
+-- TODO: Make InstallArgs a proper data type with documented fields or just get
-- rid of it completely.
-- | Initial arguments given to 'install' or 'makeInstallContext'.
type InstallArgs = ( PackageDBStack
@@ -1388,7 +1388,7 @@ installUnpackedPackage verbosity buildLimit installLock numJobs
reexec cmd = do
-- look for our own executable file and re-exec ourselves using a helper
- -- program like sudo to elevate priviledges:
+ -- program like sudo to elevate privileges:
self <- getExecutablePath
weExist <- doesFileExist self
if weExist
@@ -1412,7 +1412,7 @@ onFailure result action =
-- ------------------------------------------------------------
--- * Wierd windows hacks
+-- * Weird windows hacks
-- ------------------------------------------------------------
withWin32SelfUpgrade :: Verbosity
View
6 cabal-install/Distribution/Client/InstallPlan.hs
@@ -321,7 +321,7 @@ checkConfiguredPackage pkg =
internalError $ "not configured or no such pkg " ++ display (packageId pkg)
-- ------------------------------------------------------------
--- * Checking valididy of plans
+-- * Checking validity of plans
-- ------------------------------------------------------------
-- | A valid installation plan is a set of packages that is 'acyclic',
@@ -428,11 +428,11 @@ closed = null . PackageIndex.brokenPackages
-- most one version of any package in the set. It only requires that of
-- packages which have more than one other package depending on them. We could
-- actually make the condition even more precise and say that different
--- versions are ok so long as they are not both in the transitive closure of
+-- versions are OK so long as they are not both in the transitive closure of
-- any other package (or equivalently that their inverse closures do not
-- intersect). The point is we do not want to have any packages depending
-- directly or indirectly on two different versions of the same package. The
--- current definition is just a safe aproximation of that.
+-- current definition is just a safe approximation of that.
--
-- * if the result is @False@ use 'PackageIndex.dependencyInconsistencies' to
-- find out which packages are.
View
16 cabal-install/Distribution/Client/InstallSymlink.hs
@@ -77,18 +77,18 @@ import Data.Maybe
-- directory will be on the user's PATH. However some people are a bit nervous
-- about letting a package manager install programs into @~/bin/@.
--
--- A comprimise solution is that instead of installing binaries directly into
+-- A compromise solution is that instead of installing binaries directly into
-- @~/bin/@, we could install them in a private location under @~/.cabal/bin@
-- and then create symlinks in @~/bin/@. We can be careful when setting up the
-- symlinks that we do not overwrite any binary that the user installed. We can
-- check if it was a symlink we made because it would point to the private dir
-- where we install our binaries. This means we can install normally without
-- worrying and in a later phase set up symlinks, and if that fails then we
--- report it to the user, but even in this case the package is still in an ok
+-- report it to the user, but even in this case the package is still in an OK
-- installed state.
--
-- This is an optional feature that users can choose to use or not. It is
--- controlled from the config file. Of course it only works on posix systems
+-- controlled from the config file. Of course it only works on POSIX systems
-- with symlinks so is not available to Windows users.
--
symlinkBinaries :: ConfigFlags
@@ -168,7 +168,7 @@ symlinkBinary :: FilePath -- ^ The canonical path of the public bin dir
-- bin dir, eg @foo@
-> String -- ^ The name of the executable to in the private bin
-- dir, eg @foo-1.0@
- -> IO Bool -- ^ If creating the symlink was sucessful. @False@
+ -> IO Bool -- ^ If creating the symlink was successful. @False@
-- if there was another file there already that we
-- did not own. Other errors like permission errors
-- just propagate as exceptions.
@@ -185,11 +185,11 @@ symlinkBinary publicBindir privateBindir publicName privateName = do
(publicBindir </> publicName)
rmLink = removeLink (publicBindir </> publicName)
--- | Check a filepath of a symlink that we would like to create to see if it
--- is ok. For it to be ok to overwrite it must either not already exist yet or
+-- | Check a file path of a symlink that we would like to create to see if it
+-- is OK. For it to be OK to overwrite it must either not already exist yet or
-- be a symlink to our target (in which case we can assume ownership).
--
-targetOkToOverwrite :: FilePath -- ^ The filepath of the symlink to the private
+targetOkToOverwrite :: FilePath -- ^ The file path of the symlink to the private
-- binary that we would like to create
-> FilePath -- ^ The canonical path of the private binary.
-- Use 'canonicalizePath' to make this.
@@ -214,7 +214,7 @@ targetOkToOverwrite symlink target = handleNotExist $ do
data SymlinkStatus
= NotExists -- ^ The file doesn't exist so we can make a symlink.
| OkToOverwrite -- ^ A symlink already exists, though it is ours. We'll
- -- have to delete it first bemore we make a new symlink.
+ -- have to delete it first before we make a new symlink.
| NotOurFile -- ^ A file already exists and it is not one of our existing
-- symlinks (either because it is not a symlink or because
-- it points somewhere other than our managed space).
View
2 cabal-install/Distribution/Client/List.hs
@@ -240,7 +240,7 @@ sourcePkgsInfo prefs name installedPkgIndex sourcePkgIndex =
-- | The info that we can display for each package. It is information per
--- package name and covers all installed and avilable versions.
+-- package name and covers all installed and available versions.
--
data PackageDisplayInfo = PackageDisplayInfo {
pkgName :: PackageName,
View
8 cabal-install/Distribution/Client/PackageIndex.hs
@@ -76,7 +76,7 @@ import Distribution.Simple.Utils (lowercase, equating, comparing)
-- | The collection of information about packages from one or more 'PackageDB's.
--
--- It can be searched effeciently by package name and version.
+-- It can be searched efficiently by package name and version.
--
newtype PackageIndex pkg = PackageIndex
-- This index package names to all the package records matching that package
@@ -285,12 +285,12 @@ lookupDependency index (Dependency name versionRange) =
-- | Does a case-insensitive search by package name.
--
--- If there is only one package that compares case-insentiviely to this name
+-- If there is only one package that compares case-insensitively to this name
-- then the search is unambiguous and we get back all versions of that package.
--- If several match case-insentiviely but one matches exactly then it is also
+-- If several match case-insensitively but one matches exactly then it is also
-- unambiguous.
--
--- If however several match case-insentiviely and none match exactly then we
+-- If however several match case-insensitively and none match exactly then we
-- have an ambiguous result, and we get back all the versions of all the
-- packages. The list of ambiguous results is split by exact package name. So
-- it is a non-empty list of non-empty lists.
View
2 cabal-install/Distribution/Client/SrcDist.hs
@@ -117,7 +117,7 @@ createZipArchive verbosity pkg tmpDir targetPref = do
zipfile = targetPref </> dir <.> "zip"
(zipProg, _) <- requireProgram verbosity zipProgram emptyProgramDb
- -- zip has an annoying habbit of updating the target rather than creating
+ -- zip has an annoying habit of updating the target rather than creating
-- it from scratch. While that might sound like an optimisation, it doesn't
-- remove files already in the archive that are no longer present in the
-- uncompressed tree.
View
10 cabal-install/Distribution/Client/Tar.hs
@@ -230,7 +230,7 @@ data Format =
V7Format
-- | The \"USTAR\" format is an extension of the classic V7 format. It was
- -- later standardised by POSIX. It has some restructions but is the most
+ -- later standardised by POSIX. It has some restrictions but is the most
-- portable format.
--
| UstarFormat
@@ -255,7 +255,7 @@ directoryPermissions :: Permissions
directoryPermissions = 0o0755
isExecutable :: Permissions -> Bool
-isExecutable p = testBit p 0 || testBit p 6 -- user or other exectuable
+isExecutable p = testBit p 0 || testBit p 6 -- user or other executable
-- | An 'Entry' with all default values except for the file name and type. It
-- uses the portable USTAR/POSIX format (see 'UstarHeader').
@@ -319,7 +319,7 @@ directoryEntry name = simpleEntry name Directory
--
-- So it's understandable but rather annoying.
--
--- * Tar paths use posix format (ie @\'/\'@ directory separators), irrespective
+-- * Tar paths use POSIX format (ie @\'/\'@ directory separators), irrespective
-- of the local path conventions.
--
-- * The directory separator between the prefix and name is /not/ stored.
@@ -368,7 +368,7 @@ toTarPath isDir = splitLongPath
-- | Take a sanitized path, split on directory separators and try to pack it
-- into the 155 + 100 tar file name format.
--
--- The stragey is this: take the name-directory components in reverse order
+-- The strategy is this: take the name-directory components in reverse order
-- and try to fit as many components into the 100 long name area as possible.
-- If all the remaining components fit in the 155 name area then we win.
--
@@ -484,7 +484,7 @@ entriesIndex = foldlEntries (\m e -> Map.insert (entryTarPath e) e m) Map.empty
-- * file names are valid
--
-- These checks are from the perspective of the current OS. That means we check
--- for \"@C:\blah@\" files on Windows and \"\/blah\" files on unix. For archive
+-- for \"@C:\blah@\" files on Windows and \"\/blah\" files on Unix. For archive
-- entry types 'HardLink' and 'SymbolicLink' the same checks are done for the
-- link target. A failure in any entry terminates the sequence of entries with
-- an error.
View
8 cabal-install/Distribution/Client/Win32SelfUpgrade.hs
@@ -25,7 +25,7 @@ module Distribution.Client.Win32SelfUpgrade (
--
-- * Move our own exe file to a new name
-- * Copy a new exe file to the previous name
--- * Run the new exe file, passing our own pid and new path
+-- * Run the new exe file, passing our own PID and new path
-- * Wait for the new process to start
-- * Close the new exe file
-- * Exit old process
@@ -61,7 +61,7 @@ import Prelude hiding (log)
-- that the nested action can replace our own exe file.
--
-- We require that the new process accepts a command line invocation that
--- calls 'deleteOldExeFile', passing in the pid and exe file.
+-- calls 'deleteOldExeFile', passing in the PID and exe file.
--
possibleSelfUpgrade :: Verbosity
-> [FilePath]
@@ -87,7 +87,7 @@ possibleSelfUpgrade verbosity newPaths action = do
-- old and new processes. We need to synchronise to make sure that the old
-- process has not yet terminated by the time the new one starts up and looks
-- for the old process. Otherwise the old one might have already terminated
--- and we could not wait on it terminating reliably (eg the pid might get
+-- and we could not wait on it terminating reliably (eg the PID might get
-- re-used).
--
syncEventName :: String
@@ -131,7 +131,7 @@ scheduleOurDemise verbosity dstPath tmpPath mkArgs = do
-- | Assuming we're now in the new child process, we've been asked by the old
-- process to wait for it to terminate and then we can remove the old exe file
--- that it renamted itself to.
+-- that it renamed itself to.
--
deleteOldExeFile :: Verbosity -> Int -> FilePath -> IO ()
deleteOldExeFile verbosity oldPID tmpPath = do
View
2 cabal-install/cabal-install.cabal
@@ -146,7 +146,7 @@ executable cabal
build-depends: unix >= 2.0 && < 2.8
if arch(arm) && impl(ghc < 7.6)
- -- older ghc on arm does not supprt -threaded
+ -- older ghc on arm does not support -threaded
cc-options: -DCABAL_NO_THREADED
else
ghc-options: -threaded

0 comments on commit b5b4289

Please sign in to comment.