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

Update docs

pull/575/head
Jordi Boggiano 2012-04-14 23:52:52 +02:00
parent 89e095b4b5
commit 8d4f8543fc
2 changed files with 28 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/03-cli.md
View File

@ -39,11 +39,9 @@ resolution.
* **--dry-run:** If you want to run through an installation without actually * **--dry-run:** If you want to run through an installation without actually
installing a package, you can use `--dry-run`. This will simulate the installing a package, you can use `--dry-run`. This will simulate the
installation and show you what would happen. installation and show you what would happen.
* **--no-install-recommends:** By default composer will install all packages * **--dev:** By default composer will only install required packages. By
that are referenced by `recommend`. By passing this option you can disable passing this option you can also make it install packages referenced by
that. `require-dev`.
* **--install-suggests:** The packages referenced by `suggest` will not be
installed by default. By passing this option, you can install them.
## update ## update
@ -59,8 +57,7 @@ into `composer.lock`.
* **--prefer-source:** Install packages from `source` when available. * **--prefer-source:** Install packages from `source` when available.
* **--dry-run:** Simulate the command without actually doing anything. * **--dry-run:** Simulate the command without actually doing anything.
* **--no-install-recommends:** Do not install packages referenced by `recommend`. * **--dev:** Install packages listed in `require-dev`.
* **--install-suggests:** Install packages referenced by `suggest`.
## search ## search
@ -111,8 +108,8 @@ specific version.
## depends ## depends
The `depends` command tells you which other packages depend on a certain The `depends` command tells you which other packages depend on a certain
package. You can specify which link types (`require`, `recommend`, `suggest`) package. You can specify which link types (`require`, `require-dev`)
should be included in the listing. should be included in the listing. By default both are used.
$ php composer.phar depends --link-type=require monolog/monolog $ php composer.phar depends --link-type=require monolog/monolog

27
doc/04-schema.md
View File

@ -41,7 +41,7 @@ Required for published packages (libraries).
A short description of the package. Usually this is just one line long. A short description of the package. Usually this is just one line long.
Optional but recommended. Required for published packages (libraries).
### version ### version
@ -165,14 +165,13 @@ An example:
Optional, but highly recommended. Optional, but highly recommended.
### Link types <span>(require, recommend, suggest, replace, provide)</span> ### Package links <span>(require, require-dev, conflict, replace, provide)</span>
Each of these takes an object which maps package names to version constraints. Each of these takes an object which maps package names to version constraints.
* **require:** Packages required by this package. * **require:** Packages required by this package.
* **recommend:** Recommended packages, installed by default. * **require-dev:** Packages required for developing this package, or running
* **suggest:** Suggested packages. These are displayed after installation, tests, etc. They are installed if install or update is ran with `--dev`.
but not installed by default.
* **conflict:** Mark this version of this package as conflicting with other * **conflict:** Mark this version of this package as conflicting with other
packages. packages.
* **replace:** Packages that can be replaced by this package. This is useful * **replace:** Packages that can be replaced by this package. This is useful
@ -193,6 +192,24 @@ Example:
Optional. Optional.
### suggest
Suggested packages that can enhance or work well with this package. These are
just informational and are displayed after the package is installed, to give
your users a hint that they could add more packages, even though they are not
strictly required.
The format is like package links above, except that the values are free text
and not version constraints.
Example:
{
"suggest": {
"monolog/monolog": "Allows more advanced logging of the application flow"
}
}
### autoload ### autoload
Autoload mapping for a PHP autoloader. Autoload mapping for a PHP autoloader.