From 4a5f1babf7524cca1e942cc31751128ac9126b68 Mon Sep 17 00:00:00 2001 From: Jordi Boggiano Date: Wed, 3 Apr 2013 09:17:46 +0200 Subject: [PATCH] Add note about package naming in VCS repos/fork, fixes #1761 --- doc/05-repositories.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/doc/05-repositories.md b/doc/05-repositories.md index efdd3872f..ce023810a 100644 --- a/doc/05-repositories.md +++ b/doc/05-repositories.md @@ -240,9 +240,16 @@ Example assuming you patched monolog to fix a bug in the `bugfix` branch: When you run `php composer.phar update`, you should get your modified version of `monolog/monolog` instead of the one from packagist. -It is possible to inline-alias a package constraint so that it matches a -constraint that it otherwise would not. For more information [see the -aliases article](articles/aliases.md). +Note that you should not rename the package unless you really intend to fork +it in the long term, and completely move away from the original package. +Composer will correctly pick your package over the original one since the +custom repository has priority over packagist. If you want to rename the +package, you should do so in the default (often master) branch and not in a +feature branch, since the package name is taken from the default branch. + +If other dependencies rely on the package you forked, it is possible to +inline-alias it so that it matches a constraint that it otherwise would not. +For more information [see the aliases article](articles/aliases.md). #### Using private repositories