public-mirrors
/
composer
mirror of https://github.com/composer/composer
1
0
Fork 0
Code

Add docs for metapackages

pull/410/merge
Jordi Boggiano 2012-03-24 18:20:27 +01:00
parent ab55490254
commit f0a0d7ffa7
2 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/04-schema.md
View File

@ -66,12 +66,16 @@ installer capable of installing packages of that type.
Out of the box, composer supports two types: Out of the box, composer supports two types:
* **library:** This is the default. It will simply copy the files to `vendor`. - **library:** This is the default. It will simply copy the files to `vendor`.
* **composer-installer:** A package of type `composer-installer` provides an - **metapackage:** An empty package that contains requirements and will trigger
installer for other packages that have a custom type. Symfony could supply a their installation, but contains no files and will not write anything to the
`symfony/bundle-installer` package, which every bundle would depend on. filesystem. As such, it does not require a dist or source key to be
Whenever you install a bundle, it will fetch the installer and register it, in installable.
order to be able to install the bundle. - **composer-installer:** A package of type `composer-installer` provides an
installer for other packages that have a custom type. Symfony could supply a
`symfony/bundle-installer` package, which every bundle would depend on.
Whenever you install a bundle, it will fetch the installer and register it, in
order to be able to install the bundle.
Only use a custom type if you need custom logic during installation. It is Only use a custom type if you need custom logic during installation. It is
recommended to omit this field and have it just default to `library`. recommended to omit this field and have it just default to `library`.

2
res/composer-schema.json
View File

@ -9,7 +9,7 @@
"required": true "required": true
}, },
"type": { "type": {
"description": "Package type, either 'library' for common packages, 'composer-installer' for custom installers, or a custom type defined by whatever project this package applies to.", "description": "Package type, either 'library' for common packages, 'composer-installer' for custom installers, 'metapackage' for empty packages, or a custom type defined by whatever project this package applies to.",
"type": "string" "type": "string"
}, },
"target-dir": { "target-dir": {