Commit 1813fec6 authored by Jan Hrček's avatar Jan Hrček

Fix typos and language issues

parent 0538dd1e
# 3.2.0.0 [Herbert Valerio Riedel](mailto:hvr@gnu.org) April 2020
* Change free text `String` fields to use `ShortText` in package description
and installed packge info.
and installed package info.
* Split `Distribution.Types.Flag` and `Distribution.Types.ConfVar`
`Distribution.Types.GenericPackageDescription`.
* Add GHC-8.10 support, including new extensions to
......@@ -28,7 +28,7 @@
([#6372](https://github.com/haskell/cabal/pull/6372)).
* Limit version number parts to contain at most 9 digits
([#6386](https://github.com/haskell/cabal/pull/6386)).
* Fix boundless sublibrary depedency parse failure
* Fix boundless sublibrary dependency parse failure
([#5846](https://github.com/haskell/cabal/issues/5846)).
* `cabal check` verifies `cpp-options` more pedantically, allowing only
options starting with `-D` and `-U`.
......@@ -165,7 +165,7 @@
[#784](https://github.com/haskell/cabal/issues/784),
[#5057](https://github.com/haskell/cabal/issues/5057)).
* Wildcard syntax errors (misplaced `*`, etc), wildcards that
refer to missing directoies, and wildcards that do not match
refer to missing directories, and wildcards that do not match
anything are now all detected by `cabal check`.
* Wildcard ('globbing') functions have been moved from
`Distribution.Simple.Utils` to `Distribution.Simple.Glob` and
......@@ -626,7 +626,7 @@
* Support for finding installed packages for hugs
* Cabal version macros now have proper parenthesis
* Reverted change to filter out deps of non-buildable components
* Fix for registering implace when using a specific package db
* Fix for registering inplace when using a specific package db
* Fix mismatch between $os and $arch path template variables
* Fix for finding ar.exe on Windows, always pick ghc's version
* Fix for intra-package dependencies with ghc-6.12
......@@ -788,7 +788,7 @@
# 1.2.0 [Duncan Coutts](mailto:duncan.coutts@worc.ox.ac.uk) Sept 2007
* To be included in GHC 6.8.x
* New configurations feature
* Can make haddock docs link to hilighted sources (with hscolour)
* Can make haddock docs link to highlighted sources (with hscolour)
* New flag to allow linking to haddock docs on the web
* Supports pkg-config
* New field `build-tools` for tool dependencies
......@@ -828,7 +828,7 @@
* Released with GHC 6.6
* Added support for hoogle
* Allow profiling and normal builds of libs to be chosen indepentantly
* Allow profiling and normal builds of libs to be chosen independently
* Default installation directories on Win32 changed
* Register haddock docs with ghc-pkg
* Get haddock to make hyperlinks to dependent package docs
......@@ -908,7 +908,7 @@
* Lots of bug fixes
* spaces can sometimes be used instead of commas
* A user manual has appeared (Thanks, ross!)
* for ghc 6.4, configures versionsed depends properly
* for ghc 6.4, configures versioned depends properly
* more features to `./setup haddock`
----
......
......@@ -14,7 +14,7 @@
-- like to encourage. There is a 'PackageCheck' type that distinguishes the
-- 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
-- we consider only basic problems. The higher standard is uses when
-- 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
......@@ -796,7 +796,7 @@ checkGhcOptions fieldName getOptions pkg =
, checkFlags ["-fhpc"] $
PackageDistInexcusable $
"'" ++ fieldName ++ ": -fhpc' is not not necessary. Use the configure flag "
"'" ++ fieldName ++ ": -fhpc' is not necessary. Use the configure flag "
++ " --enable-coverage instead."
, checkFlags ["-prof"] $
......
......@@ -702,7 +702,7 @@ checkForUndefinedFlags gpd = do
--
-- Before 'cabal-version: 3.0' we didn't have a syntax specially
-- for referring to internal libraries. Internal library names
-- shadowed the the outside ones.
-- shadowed the outside ones.
--
-- Since 'cabal-version: 3.0' we have ability to write
--
......
......@@ -17,7 +17,7 @@ module Distribution.Parsec (
eitherParsec,
explicitEitherParsec,
explicitEitherParsec',
-- * CabalParsing and and diagnostics
-- * CabalParsing and diagnostics
CabalParsing (..),
-- ** Warnings
PWarnType (..),
......
......@@ -442,7 +442,7 @@ configure (pkg_descr0, pbi) cfg = do
installedPackageSet
-- pkg_descr: The resolved package description, that does not contain any
-- conditionals, because we have have an assignment for
-- conditionals, because we have an assignment for
-- every flag, either picking them ourselves using a
-- simple naive algorithm, or having them be passed to
-- us by 'configConfigurationsFlags')
......
......@@ -100,7 +100,7 @@ configure verbosity hcPath hcPkgPath conf0 = do
warn verbosity $
"Unknown/unsupported 'ghc' version detected "
++ "(Cabal " ++ prettyShow cabalVersion ++ " supports 'ghc' version < 8.8): "
++ programPath ghcjsProg ++ " is is based on GHC version " ++
++ programPath ghcjsProg ++ " is based on GHC version " ++
prettyShow ghcjsGhcVersion
let implInfo = ghcjsVersionImplInfo ghcjsVersion ghcjsGhcVersion
......
......@@ -23,7 +23,7 @@
-- build multi-package systems.
--
-- This module does not delegate anything to the per-compiler modules but just
-- mixes it all in in this module, which is rather unsatisfactory. The script
-- mixes it all in this module, which is rather unsatisfactory. The script
-- generation and the unregister feature are not well used or tested.
module Distribution.Simple.Register (
......
......@@ -274,7 +274,7 @@ data ConfigFlags = ConfigFlags {
configDebugInfo :: Flag DebugInfoLevel, -- ^ Emit debug info.
configUseResponseFiles :: Flag Bool,
-- ^ Whether to use response files at all. They're used for such tools
-- as haddock, or or ld.
-- as haddock, or ld.
configAllowDependingOnPrivateLibs :: Flag Bool
-- ^ Allow depending on private sublibraries. This is used by external
-- tools (like cabal-install) so they can add multiple-public-libraries
......
......@@ -887,7 +887,7 @@ rawSystemStdInOut verbosity path args mcwd menv input _ = withFrozenCallStack $
Just (IODataText inp) -> "\nstdin input:\n" ++ inp
Just (IODataBinary inp) -> "\nstdin input (binary):\n" ++ show inp
-- Check if we we hit an exception while consuming the output
-- Check if we hit an exception while consuming the output
-- (e.g. a text decoding error)
out <- reportOutputIOError mberr1
......
......@@ -60,7 +60,7 @@ import qualified Text.PrettyPrint as Disp
-- are two situations where we need to do it.
--
-- 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
-- referring to the same 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
......
......@@ -88,7 +88,7 @@ data BuildInfo = BuildInfo {
-- copying. E.g. [libHS<name>_<flavour> | flavour <- extraLibFlavours]. This
-- should only be needed in very specific cases, e.g. the `rts` package, where
-- there are multiple copies of slightly differently built libs.
extraDynLibFlavours :: [String], -- ^ Hidden Flag. This set of strings will be be appended to all /dynamic/
extraDynLibFlavours :: [String], -- ^ Hidden Flag. This set of strings will be appended to all /dynamic/
-- libraries when copying. This is particularly useful with the `rts` package,
-- where we want different dynamic flavours of the RTS library to be installed.
extraLibDirs :: [String],
......
......@@ -186,7 +186,7 @@ fromUTF8BS = decodeStringUtf8 . SBS.unpack
fromUTF8LBS :: LBS.ByteString -> String
fromUTF8LBS = decodeStringUtf8 . LBS.unpack
-- | Encode 'String' to to UTF8-encoded 'SBS.ByteString'
-- | Encode 'String' to UTF8-encoded 'SBS.ByteString'
--
-- Code-points in the @U+D800@-@U+DFFF@ range will be encoded
-- as the replacement character (i.e. @U+FFFD@).
......
......@@ -286,7 +286,7 @@ isVerboseNoWrap = isVerboseFlag VNoWrap
isVerboseQuiet :: Verbosity -> Bool
isVerboseQuiet = vQuiet
-- | Test if if we should output timestamps when we log.
-- | Test if we should output timestamps when we log.
isVerboseTimestamp :: Verbosity -> Bool
isVerboseTimestamp = isVerboseFlag VTimestamp
......
......@@ -27,7 +27,7 @@ Field syntax is described as they are in the latest cabal file format version.
[ \mathord{"}\mathtt{1}\mathord{"} \cdots \mathord{"}\mathtt{9}\mathord{"} ]
Character set compelements have :math:`c` superscript:
Character set complements have :math:`c` superscript:
.. math::
......@@ -102,7 +102,7 @@ Space separated
.. math::
{\mathop{\mathit{element}}}^\ast_{\bullet}
Comma semarted
Comma separated
Are used for lists of things with complicated grammars, for example :pkg-field:`build-depends`
There can be leading or trailing comma (but not both) since ``cabal-version: 2.2``.
Note, the comma cannot exist alone.
......
......@@ -121,7 +121,7 @@ for all transitive dependencies are built and installed.)
In addition ``cabal v2-build`` accepts these flags:
- ``--only-configure``: When given we will forgoe performing a full build and
- ``--only-configure``: When given we will forego performing a full build and
abort after running the configure phase of each target package.
......
......@@ -771,7 +771,7 @@ The library section should contain the following fields:
that use a flat module namespace or where it is known that the
exposed modules would clash with other common modules.
.. pkg-field:: visibility: visibilty specifiers
.. pkg-field:: visibility: visibility specifiers
:since 3.0
......@@ -1404,7 +1404,7 @@ A typical stanza for a foreign library looks like
.. pkg-section:: foreign-library name
:since: 2.0
:synopsis: Foriegn library build information.
:synopsis: Foreign library build information.
Build information for `foreign libraries`_.
......@@ -1530,7 +1530,7 @@ system-dependent values for these fields.
External libraries are identified by the package's name they're
provided by (currently a package can only publicly expose its
main library compeonent; in future, packages with multiple exposed
main library component; in future, packages with multiple exposed
public library components will be supported and a syntax for
referring to public sub-libraries will be provided).
......@@ -1784,7 +1784,7 @@ system-dependent values for these fields.
1. External dependencies can (and should) contain a version bound like conventional
:pkg-field:`build-depends` dependencies.
2. Internal depenedencies should not contain a version bound, as they will be always
2. Internal dependencies should not contain a version bound, as they will be always
resolved within the same configuration of the package in the build plan.
Specifically, version bounds that include the package's version will be warned for
being extraneous, and version bounds that exclude the package's version will raise
......
......@@ -79,7 +79,7 @@ project are:
There is no command line variant of this field.
.. cfg-field:: extra-packages: package list with version bounds (comma separated)
:synopsis: Adds external pacakges as local
:synopsis: Adds external packages as local
[STRIKEOUT:Specifies a list of external packages from Hackage which
should be considered local packages.] (Not implemented)
......@@ -282,7 +282,7 @@ The following settings control the behavior of the dependency solver:
.. cfg-field:: preferences: preference (comma separated)
--preference="pkg >= 2.0"
:synopsis: Prefered dependency versions.
:synopsis: Preferred dependency versions.
Like :cfg-field:`constraints`, but the solver will attempt to satisfy
these preferences on a best-effort basis. The resulting install is locally
......
......@@ -26,12 +26,12 @@ Added directives
.. rst:directive:: .. cabal::cfg-section
Describes a package.cabal section, such as library or exectuble.
Describes a package.cabal section, such as library or executable.
All following `pkg-field` directives will add section name
to their fields name for disambiguating duplicates.
You can reset the section disambguation with with `.. pkg-section:: None`.
You can reset the section disambiguation with `.. pkg-section:: None`.
.. rst::role:: pkg-section
......@@ -86,7 +86,7 @@ To be done:
These should act in a way similar to `.. std::option` directive, but with
extra meta. And should also end up in reference.
At least setup and 'new-build` subcommands should get special directvies
At least setup and 'new-build` subcommands should get special directives
- Improve rendering of flags in `.. cfg-field::` directive. It should be
possible without copy-pasting code from sphinx.directives.ObjectDescription
......@@ -323,7 +323,7 @@ class CabalObject(ObjectDescription):
def get_index_entry(self, env, name):
'''
Should return index entry and achor
Should return index entry and anchor
By default uses indextemplate attribute to generate name and
index entry by joining directive name, section and field name
......
......@@ -55,7 +55,7 @@ relative to the respective preceding *published* version.
* Remove deprecated ``hs-source-dir``, :pkg-field:`extensions` and
:pkg-field:`build-tools` fields.
* Common stanzas are now allowed also in the beginnning of conditional
* Common stanzas are now allowed also in the beginning of conditional
sections. In other words, the following is valid
::
......@@ -90,11 +90,11 @@ relative to the respective preceding *published* version.
which are autogenerated (e.g. by a ``configure`` script).
* New :pkg-field:`asm-sources` and :pkg-field:`asm-options` fields
added for suppporting bundled foreign routines implemented in
added for supporting bundled foreign routines implemented in
assembler.
* New :pkg-field:`cmm-sources` and :pkg-field:`cmm-options` fields
added for suppporting bundled foreign primops implemented in
added for supporting bundled foreign primops implemented in
C--.
``cabal-version: 2.4``
......
......@@ -74,7 +74,7 @@ You should see the following output in the terminal:
...
Hello, Haskell!
.. note:: The ``:`` prefix in ``:myfirstapp`` signifies that the the
.. note:: The ``:`` prefix in ``:myfirstapp`` signifies that the
``myfirstapp`` target is part of the current package.
Notice that we didn't need to run a `build` command before ``cabal run``, this
......
......@@ -839,7 +839,7 @@ entriesForLibraryComponents = Map.foldrWithKey' (\k v -> mappend (go k v)) []
| otherwise = []
-- | Gets the file file path to the request environment file.
-- | Gets the file path to the request environment file.
getEnvFile :: ClientInstallFlags -> Platform -> Version -> IO FilePath
getEnvFile clientInstallFlags platform compilerVersion = do
appDir <- getGhcAppDir
......
......@@ -552,7 +552,7 @@ baseSavedConfig = do
}
}
-- | This is the initial configuration that we write out to to the config file
-- | This is the initial configuration that we write out to the config file
-- if the file does not exist (or the config we use if the file cannot be read
-- for some other reason). When the config gets loaded it gets layered on top
-- of 'baseSavedConfig' so we do not need to include it into the initial
......
......@@ -2031,7 +2031,7 @@ matchElabPkg p elab =
(Cabal.pkgBuildableComponents (elabPkgDescription elab))
-- | Given an 'ElaboratedPlanPackage', generate the mapping from 'PackageName'
-- and 'ComponentName' to the 'ComponentId' that should be used
-- in this case.
mkCCMapping :: ElaboratedPlanPackage
-> (PackageName, Map ComponentName (AnnotatedId ComponentId))
......
......@@ -135,7 +135,7 @@ mkReqHeaders reqHeaders mRange = concat [
-- Some headers are comma-separated, others need multiple headers for
-- multiple options.
--
-- TODO: Right we we just comma-separate all of them.
-- TODO: Right we just comma-separate all of them.
finalize :: (HTTP.HeaderName, [String]) -> [HTTP.Header]
finalize (name, strs) = [HTTP.Header name (intercalate ", " (reverse strs))]
......
......@@ -334,7 +334,7 @@ dependencyInconsistencies' index =
]
where
-- For each package name (of a dependency, somewhere)
-- and each installed ID of that that package
-- and each installed ID of that package
-- the associated package instance
-- and a list of reverse dependencies (as source IDs)
inverseIndex :: Map PackageName (Map SolverId (SolverPlanPackage, [PackageId]))
......
......@@ -79,7 +79,7 @@ convIPI' (ShadowPkgs sip) idx =
| sip = (pn, i, PInfo fdeps comps fds (Just Shadowed))
shadow x = x
-- | Extract/recover the the package ID from an installed package info, and convert it to a solver's I.
-- | Extract/recover the package ID from an installed package info, and convert it to a solver's I.
convId :: IPI.InstalledPackageInfo -> (PN, I)
convId ipi = (pn, I ver $ Inst $ IPI.installedUnitId ipi)
where MungedPackageId mpn ver = mungedId ipi
......
......@@ -266,7 +266,7 @@ linkDeps target = \deps -> do
Just False -> return () -- stanza not enabled; no new deps
-- For extensions and language dependencies, there is nothing to do.
-- No choice is involved, just checking, so there is nothing to link.
-- The same goes for for pkg-config constraints.
-- The same goes for pkg-config constraints.
(Simple (LDep _ (Ext _)) _, _) -> return ()
(Simple (LDep _ (Lang _)) _, _) -> return ()
(Simple (LDep _ (Pkg _ _)) _, _) -> return ()
......
......@@ -62,7 +62,7 @@ import GHC.Stack (CallStack)
-- active constraints, we must check that they are consistent with
-- the current state.
--
-- We can actually merge (1) and (2) by saying the the current choice is
-- We can actually merge (1) and (2) by saying the current choice is
-- a new active constraint, fixing the choice.
--
-- If a test fails, we have detected an inconsistent state. We can
......
......@@ -3,6 +3,6 @@ Warning: The following warnings are likely to affect your build negatively:
Warning: 'ghc-shared-options: -hide-package' is never needed. Cabal hides all packages.
Warning: The following errors will cause portability problems on other environments:
Warning: 'ghc-options: -fasm' is unnecessary and will not work on CPU architectures other than x86, x86-64, ppc or sparc.
Warning: 'ghc-prof-options: -fhpc' is not not necessary. Use the configure flag --enable-coverage instead.
Warning: 'ghc-prof-options: -fhpc' is not necessary. Use the configure flag --enable-coverage instead.
Warning: 'ghc-shared-options: -Wall -Werror' makes the package very easy to break with future GHC versions because new GHC versions often add new warnings. Use just 'ghc-shared-options: -Wall' instead. Alternatively, if you want to use this, make it conditional based on a Cabal configuration flag (with 'manual: True' and 'default: False') and enable that flag during development.
Warning: Hackage would reject this package.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment