diff --git a/doc/03-cli.md b/doc/03-cli.md index 0ed5603a3..71a74fd7e 100644 --- a/doc/03-cli.md +++ b/doc/03-cli.md @@ -41,6 +41,7 @@ while using some smart defaults. * **--require:** Package to require with a version constraint. Should be in format `foo/bar:1.0.0`. * **--require-dev:** Development requirements, see **--require**. +* **--stability (-s):** Value for the `minimum-stability` field. ## install @@ -139,6 +140,10 @@ terms you want to search for. You can also search for more than one term by passing multiple arguments. +### Options + +* **--only-name (-N):** Search only in name. + ## show To list all of the available packages, you can use the `show` command. @@ -204,6 +209,22 @@ You should always run the `validate` command before you commit your $ php composer.phar validate +## status + +If you often need to modify the code of your dependencies and they are +installed from source, the `status` command allows you to check if you have +local changes in any of them. + + $ php composer.phar status + +With the `--verbose` option you get some more information about what was +changed: + + $ php composer.phar status -v + You have changes in the following dependencies: + vendor/seld/jsonlint: + M README.mdown + ## self-update To update composer itself to the latest version, just run the `self-update` @@ -283,6 +304,7 @@ By default the command checks for the packages on packagist.org. * **--repository-url:** Provide a custom repository to search for the package, which will be used instead of packagist. Can be either an HTTP URL pointing to a `composer` repository, or a path to a local `packages.json` file. +* **--stability (-s):** Minimum stability of package. Defaults to `stable`. * **--prefer-source:** Install packages from `source` when available. * **--prefer-dist:** Install packages from `dist` when available. * **--dev:** Install packages listed in `require-dev`. diff --git a/doc/05-repositories.md b/doc/05-repositories.md index 697f32518..9d3be231c 100644 --- a/doc/05-repositories.md +++ b/doc/05-repositories.md @@ -97,26 +97,30 @@ Here is a minimal package definition: It may include any of the other fields specified in the [schema](04-schema.md). -#### notify +#### notify_batch -The `notify` field allows you to specify an URL template for a URL that will -be called every time a user installs a package. The URL can be either an -absolute path (that will use the same domain as the repository) or a fully -qualified URL. +The `notify_batch` field allows you to specify an URL that will be called +every time a user installs a package. The URL can be either an absolute path +(that will use the same domain as the repository) or a fully qualified URL. An example value: { - "notify": "/downloads/%package%" + "notify_batch": "/downloads/" } For `example.org/packages.json` containing a `monolog/monolog` package, this -would send a `POST` request to `example.org/downloads/monolog/monolog` with -following parameters: +would send a `POST` request to `example.org/downloads/` with following +JSON request body: -* **version:** The version of the package. -* **version_normalized:** The normalized internal representation of the - version. + { + "downloads": [ + {"name": "monolog/monolog", "version": "1.2.1.0"}, + ] + } + +The version field will contain the normalized representation of the version +number. This field is optional.