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

Repositories docs reference (#11840) 

* doc: Adds docs for reference field on package repo

* fixes double space

* minor grammar fix
pull/11844/head
theoboldalex 2024-02-09 13:17:21 +00:00 committed by GitHub
parent 690fe716c5
commit 9acf6bc0a1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/05-repositories.md
View File

@ -548,6 +548,14 @@ Here is an example for the smarty template engine:
Typically, you would leave the source part off, as you don't really need it.
If a source key is included, the reference field should be a reference to the version that will be installed.
Where the type field is `git`, this will the be the commit id, branch or tag name.
**Note**: It is not recommended to use a git branch name for the reference field. While this is valid since it is supported by `git checkout`,
branch names are mutable so cannot be locked.
Where the type field is `svn`, the reference field should contain the reference that gets appended to the URL when running `svn co`.
> **Note**: This repository type has a few limitations and should be avoided
> whenever possible:
>