Commit 13ee548e authored by Edward Z. Yang's avatar Edward Z. Yang
Browse files

Document --gen-pkg-config directory case.


Signed-off-by: default avatarEdward Z. Yang <ezyang@cs.stanford.edu>
parent b8d30ee2
......@@ -1083,7 +1083,7 @@ registerCommand = CommandUI
trueArg
,option "" ["gen-pkg-config"]
"instead of registering, generate a package registration file"
"instead of registering, generate a package registration file/directory"
regGenPkgConf (\v flags -> flags { regGenPkgConf = v })
(optArg' "PKG" Flag flagToList)
......
......@@ -4,7 +4,10 @@
* Dropped support for versions of GHC earlier than 6.12 (#3111).
* Convenience/internal libraries are now supported (#269).
An internal library is declared using the stanza "library
'libname'".
'libname'". Packages which use internal libraries can
result in multiple registrations; thus '--gen-pkg-config'
can now output a directory of registration scripts rather than
a single file.
* Backwards incompatible change to preprocessor interface:
the function in 'PPSuffixHandler' now takes an additional
'ComponentLocalBuildInfo' specifying the build information
......
......@@ -1160,7 +1160,8 @@ This command takes the following options:
`--gen-pkg-config`[=_path_]
: Instead of registering the package, generate a package registration
file. This only applies to compilers that support package
file (or directory, in some circumstances).
This only applies to compilers that support package
registration files which at the moment is only GHC. The file should
be used with the compiler's mechanism for registering packages. This
option is mainly intended for packaging systems. If possible use the
......@@ -1170,6 +1171,11 @@ This command takes the following options:
generate. Otherwise, by default the file is the package name and
version with a `.conf` extension.
This option outputs a directory if the package requires multiple
registrations: this can occur if internal/convenience libraries
are used. These configuration file names are sorted so that they
can be registered in order.
`--inplace`
: Registers the package for use directly from the build tree, without
needing to install it. This can be useful for testing: there's no
......
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