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

Clarify documentation that commit refs are unsupported 

Following the discussion in #5823 it has become clear that this feature is supplied at-your-own-risk, this should be more explicitly reflected in its documentation.
pull/5832/head
Niels Keurentjes 2016-10-31 16:26:37 +01:00
parent f23cdf59e3
commit f99a33bfc7
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/04-schema.md
View File

@ -316,12 +316,12 @@ Example:
}
```
> **Note:** While this is convenient at times, it should not be how you use
> packages in the long term because it comes with a technical limitation. The
> **Note:** This feature has severe technical limitations, as the
> composer.json metadata will still be read from the branch name you specify
> before the hash. Because of that in some cases it will not be a practical
> workaround, and you should always try to switch to tagged releases as soon
> as you can.
> before the hash. You should therefore only use this as a temporary solution
> during development to remediate transient issues, until you can switch to
> tagged releases. The Composer team does not actively support this feature
> and will not accept bug reports related to it.
It is also possible to inline-alias a package constraint so that it matches
a constraint that it otherwise would not. For more information [see the