Skip to content

Commit 8eebc36

Browse files
committed
Fixing up some formatting on new entry
1 parent adf593b commit 8eebc36

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

cookbook/workflow/_vendor_deps.rst.inc

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ Managing Vendor Libraries with bin/vendors and deps
33

44
### How does it work ?
55

6-
76
Every Symfony project uses a group of third-party "vendor" libraries. One
87
way or another the goal is to download these files into your ``vendor/``
98
directory and, ideally, to give you some sane way to manage the exact version
@@ -51,10 +50,8 @@ script to ensure that all of the needed vendor libraries are downloaded.
5150
by updating them to the version specified in ``deps`` and recording it
5251
into the ``deps.lock`` file.
5352

54-
5553
### Hacking vendor libraries
5654

57-
5855
Sometimes, you want a specific branch, tag, or commit of a library to be downloaded
5956
or upgraded. You can set that directly to the ``deps`` file :
6057

@@ -65,21 +62,26 @@ or upgraded. You can set that directly to the ``deps`` file :
6562
target=/bundles/Acme/AwesomeBundle
6663
version=the-awesome-version
6764

65+
* The ``git`` option sets the URL of the library. It can use various protocols,
66+
like ``http://`` as well as ``git://``.
6867

69-
* The ``git`` option sets the URL of the library. It can use various protocols, like ``http://`` as well as ``git://``.
68+
* The ``target`` option specifies where the repository will live : plain Symfony
69+
bundles should go under the ``vendor/bundles/Acme`` directory, other third-party
70+
libraries usually go to ``vendor/my-awesome-library-name``. The target directory
71+
defaults to this last option when not specified.
7072

71-
* The ``target`` option specifies where the repository will live : plain Symfony bundles should go under the ``vendor/bundles/Acme`` directory, other third-party libraries usually go to ``vendor/my-awesome-library-name``. The target directory defaults to this last option when not specified.
73+
* The ``version`` option allows you to set a specific revision. You can use a tag
74+
(``version=origin/0.42``) or a branch name (``refs/remotes/origin/awesome-branch``).
75+
It defaults to ``origin/HEAD``.
7276

73-
* The ``version`` option allows you to set a specific revision. You can use a tag (``version=origin/0.42``) or a branch name (``refs/remotes/origin/awesome-branch``). It defaults to ``origin/HEAD``.
74-
75-
7677
### Updating workflow
7778

79+
When you execute the ``php bin/vendors install``, for every library, the script first
80+
checks if the install directory exists.
7881

79-
When you execute the ``php bin/vendors install``, for every library, the script first checks if the install directory exists.
80-
81-
If it does not (and ONLY if it does not, it runs a ``git clone``.
82+
If it does not (and ONLY if it does not), it runs a ``git clone``.
8283

8384
Then, it does a ``git fetch origin`` and a ``git reset --hard the-awesome-version``.
8485

85-
This means that the repository will only be cloned once. If you want to perform any change of the git remote, you MUST delete the entire target directory, not only its content.
86+
This means that the repository will only be cloned once. If you want to perform any
87+
change of the git remote, you MUST delete the entire target directory, not only its content.

0 commit comments

Comments
 (0)