From 5317f9e542782ff095113c51135eb9fc50d3722d Mon Sep 17 00:00:00 2001 From: Igor Wiedler Date: Fri, 30 Nov 2012 16:46:22 +0100 Subject: [PATCH 1/9] [docs] create-project command --stability option --- doc/03-cli.md | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/03-cli.md b/doc/03-cli.md index 4c422c756..43e18e33f 100644 --- a/doc/03-cli.md +++ b/doc/03-cli.md @@ -244,6 +244,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:** 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`. From ae2c3e8ddb9e8a90d9891af3eb5dd19dcb031ad6 Mon Sep 17 00:00:00 2001 From: Igor Wiedler Date: Fri, 30 Nov 2012 16:55:04 +0100 Subject: [PATCH 2/9] [docs] Batch notification API --- doc/05-repositories.md | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/doc/05-repositories.md b/doc/05-repositories.md index 697f32518..55c2d9260 100644 --- a/doc/05-repositories.md +++ b/doc/05-repositories.md @@ -99,24 +99,32 @@ It may include any of the other fields specified in the [schema](04-schema.md). #### notify -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 +The `notify_batch` 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. 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. + +> **Note:** There is a non-batch notification API, but it is deprecated +> for performance reasons. This field is optional. From 77062eb792bb3fdabe4d3345cc4de3229a2ae462 Mon Sep 17 00:00:00 2001 From: Igor Wiedler Date: Fri, 30 Nov 2012 17:07:30 +0100 Subject: [PATCH 3/9] [docs] --stability option for init command --- doc/03-cli.md | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/03-cli.md b/doc/03-cli.md index 43e18e33f..31b05245a 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:** Value for the `minimum-stability` field. ## install From 2b48d6835b089d577ae5bb4eda82c5b7683a2f48 Mon Sep 17 00:00:00 2001 From: Igor Wiedler Date: Fri, 30 Nov 2012 17:07:58 +0100 Subject: [PATCH 4/9] [docs] Remove mention of deprecated non-batch notification API --- doc/05-repositories.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/doc/05-repositories.md b/doc/05-repositories.md index 55c2d9260..47f267448 100644 --- a/doc/05-repositories.md +++ b/doc/05-repositories.md @@ -123,9 +123,6 @@ JSON request body: The version field will contain the normalized representation of the version number. -> **Note:** There is a non-batch notification API, but it is deprecated -> for performance reasons. - This field is optional. #### includes From 162b1f6653aef7b7df9feb1a1652f5756193573e Mon Sep 17 00:00:00 2001 From: Igor Wiedler Date: Fri, 30 Nov 2012 17:10:37 +0100 Subject: [PATCH 5/9] [docs] -s shorthand for --stability --- doc/03-cli.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/03-cli.md b/doc/03-cli.md index 31b05245a..6c7516054 100644 --- a/doc/03-cli.md +++ b/doc/03-cli.md @@ -41,7 +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:** Value for the `minimum-stability` field. +* **--stability (-s):** Value for the `minimum-stability` field. ## install @@ -245,7 +245,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:** Minimum stability of package. Defaults to `stable`. +* **--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`. From 303debe047aaedc8c22545d1a5483416f0fcec78 Mon Sep 17 00:00:00 2001 From: Igor Wiedler Date: Fri, 30 Nov 2012 17:15:36 +0100 Subject: [PATCH 6/9] [docs] --name-only option for search command --- doc/03-cli.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/03-cli.md b/doc/03-cli.md index 6c7516054..b186c74fa 100644 --- a/doc/03-cli.md +++ b/doc/03-cli.md @@ -140,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. From 7461be280b3ded3364cde551044f9239e36d83a6 Mon Sep 17 00:00:00 2001 From: Igor Wiedler Date: Fri, 30 Nov 2012 17:23:01 +0100 Subject: [PATCH 7/9] [docs] status command --- doc/03-cli.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/doc/03-cli.md b/doc/03-cli.md index b186c74fa..ffbdeb581 100644 --- a/doc/03-cli.md +++ b/doc/03-cli.md @@ -209,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` From c441f94d1a462bccebb07e3ac0ffd9e4fd54017d Mon Sep 17 00:00:00 2001 From: Igor Wiedler Date: Fri, 30 Nov 2012 17:29:15 +0100 Subject: [PATCH 8/9] [docs] Update repositories notify_batch title --- doc/05-repositories.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/05-repositories.md b/doc/05-repositories.md index 47f267448..4fddee014 100644 --- a/doc/05-repositories.md +++ b/doc/05-repositories.md @@ -97,7 +97,7 @@ 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_batch` 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 From 2ef741626d052ef472847cc7e85b4ddf516be559 Mon Sep 17 00:00:00 2001 From: Igor Wiedler Date: Fri, 30 Nov 2012 17:29:56 +0100 Subject: [PATCH 9/9] [docs] notify_batch is no longer URL template --- doc/05-repositories.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/doc/05-repositories.md b/doc/05-repositories.md index 4fddee014..9d3be231c 100644 --- a/doc/05-repositories.md +++ b/doc/05-repositories.md @@ -99,10 +99,9 @@ It may include any of the other fields specified in the [schema](04-schema.md). #### notify_batch -The `notify_batch` 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: