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

Merge pull request #506 from igorw/lockfile-lib-docs 

[docs] clarify lock file insignificance for libs
pull/509/merge
Jordi Boggiano 2012-03-28 06:39:05 -07:00
parent a3185c75fe ea19aba18c
commit 18d2627c22
2 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/01-basic-usage.md
View File

@ -98,7 +98,7 @@ After installing the dependencies, Composer writes the list of the exact
versions it installed into a `composer.lock` file. This locks the project versions it installed into a `composer.lock` file. This locks the project
to those specific versions. to those specific versions.
**Commit your project's `composer.lock` (along with `composer.json`) into version control.** **Commit your application's `composer.lock` (along with `composer.json`) into version control.**
This is important because the `install` command checks if a lock file is present, This is important because the `install` command checks if a lock file is present,
and if it is, it downloads the versions specified there (regardless of what `composer.json` and if it is, it downloads the versions specified there (regardless of what `composer.json`
@ -115,6 +115,9 @@ the lock file with the new version.
$ php composer.phar update $ php composer.phar update
> **Note:** For libraries it is not necessarily recommended to commit the lock file,
> see also: [Libraries - Lock file](02-libraries.md#lock-file).
## Packagist ## Packagist
[Packagist](http://packagist.org/) is the main Composer repository. A Composer [Packagist](http://packagist.org/) is the main Composer repository. A Composer

14
doc/02-libraries.md
View File

@ -78,15 +78,13 @@ See [Repositories](05-repositories.md) for more information.
## Lock file ## Lock file
For projects it is recommended to commit the `composer.lock` file into version For your library you may commit the `composer.lock` file if you want to. This
control. For libraries this is not the case. You do not want your library to can help your team to always test against the same dependency versions.
be tied to exact versions of the dependencies. It should work with any However, this lock file will not have any effect on other projects that depend
compatible version, so make sure you specify your version constraints so that on it. It only has an effect on the main project.
they include all compatible versions.
**Do not commit your library's `composer.lock` into version control.** If you do not want to commit the lock file and you are using git, add it to
the `.gitignore`.
If you are using git, add it to the `.gitignore`.
## Publishing to a VCS ## Publishing to a VCS