From 4c75a2db01fba935eec5d584dffa5a30c10ce7d0 Mon Sep 17 00:00:00 2001 From: Jordi Boggiano Date: Thu, 14 Jun 2012 15:08:38 +0200 Subject: [PATCH] Reinforce language about not specifying the version --- doc/02-libraries.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/doc/02-libraries.md b/doc/02-libraries.md index 1b6a6a8a6..83ec57f54 100644 --- a/doc/02-libraries.md +++ b/doc/02-libraries.md @@ -28,19 +28,19 @@ convention is all lowercase and dashes for word separation. ## Specifying the version -You need to specify the version some way. Depending on the type of repository -you are using, it might be possible to omit it from `composer.json`, because -the repository is able to infer the version from elsewhere. +You need to specify the package's version some way. When you publish your +package on Packagist, it is able to infer the version from the VCS (git, svn, +hg) information, so in that case you do not have to specify it, and it is +recommended not to. See [tags](#tags) and [branches](#branches) to see how +version numbers are extracted from these. -If you do want to specify it explicitly, you can just add a `version` field: +If you are creating packages by hand and really have to specify it explicitly, +you can just add a `version` field: { "version": "1.0.0" } -However if you are using git, svn or hg, you don't have to specify it. -Composer will detect versions as follows: - ### Tags For every tag that looks like a version, a package version of that tag will be @@ -65,7 +65,7 @@ name looks like a version, the version will be `{branchname}-dev`. For example a branch `2.0` will get a version `2.0.x-dev` (the `.x` is added for technical reasons, to make sure it is recognized as a branch, a `2.0.x` branch would also be valid and be turned into `2.0.x-dev` as well. If the branch does not look -like a version, it will be `dev-{branchname}`. `master` results in a +like a version, it will be `dev-{branchname}`. `master` results in a `dev-master` version. Here are some examples of version branch names: @@ -75,7 +75,6 @@ Here are some examples of version branch names: 1.1.x > **Note:** When you install a dev version, it will install it from source. -See [Repositories](05-repositories.md) for more information. ### Aliases