From 3f71cdf8be1c97a41323eeaa539b12895bfe0065 Mon Sep 17 00:00:00 2001 From: Hypolite Petovan Date: Sun, 18 Mar 2018 23:15:31 -0400 Subject: [PATCH] Move util/composer.ohar to bin/ --- INSTALL.txt | 2 +- {util => bin}/composer.phar | Bin doc/Composer.md | 12 ++++++------ doc/Developers-Intro.md | 2 +- doc/Github.md | 2 +- doc/Install.md | 2 +- doc/Update.md | 2 +- doc/de/Install.md | 2 +- 8 files changed, 12 insertions(+), 12 deletions(-) rename {util => bin}/composer.phar (100%) mode change 100755 => 100644 diff --git a/INSTALL.txt b/INSTALL.txt index 01fe65d11..ee3779bc9 100644 --- a/INSTALL.txt +++ b/INSTALL.txt @@ -66,7 +66,7 @@ OR git clone https://github.com/friendica/friendica [web server folder] cd [web server folder] - php util/composer.phar install + php bin/composer.phar install 3. Create an empty database and note the access details (hostname, username, password, database name). diff --git a/util/composer.phar b/bin/composer.phar old mode 100755 new mode 100644 similarity index 100% rename from util/composer.phar rename to bin/composer.phar diff --git a/doc/Composer.md b/doc/Composer.md index 41fc2aca3..306d0fa89 100644 --- a/doc/Composer.md +++ b/doc/Composer.md @@ -12,7 +12,7 @@ It's a command-line tool that downloads required libraries into the `vendor` fol ## How to use Composer -If you don't have Composer installed on your system, Friendica ships with a copy of it at `util/composer.phar`. +If you don't have Composer installed on your system, Friendica ships with a copy of it at `bin/composer.phar`. For the purpose of this help, all examples will use this path to run Composer commands, however feel free to replace them with your own way of calling Composer. Composer requires PHP CLI and the following examples assume it's available system-wide. @@ -30,7 +30,7 @@ Here are the typical commands you will have to run to do so: ```` ~> git clone https://github.com/friendica/friendica.git friendica ~/friendica> cd friendica -~/friendica> util/composer.phar install +~/friendica> bin/composer.phar install ```` That's it! Composer will take care of fetching all the required libraries in the `vendor` folder and build the autoloader to make those libraries available to Friendica. @@ -42,7 +42,7 @@ Updating Friendica to the current stable or the latest develop version is easy w ```` ~> cd friendica ~/friendica> git pull -~/friendica> util/composer.phar install +~/friendica> bin/composer.phar install ```` And that's it. If any library used by Friendica has been upgraded, Composer will fetch the version currently used by Friendica and refresh the autoloader to ensure the best performances. @@ -87,13 +87,13 @@ Or you can specify the exact version of the library if you code requires it, and To add a library, just add its Packagist identifier to the `require` list and set a target version string. -Then you should run `util/composer.phar update` to add it to your local `vendor` folder and update the `composer.lock` file that specifies the current versions of the dependencies. +Then you should run `bin/composer.phar update` to add it to your local `vendor` folder and update the `composer.lock` file that specifies the current versions of the dependencies. #### Updating an existing dependency If a package needs to be updated, whether to the next minor version or to the next major version provided you changed the adequate code in Friendica, simply edit `composer.json` to update the target version string of the relevant library. -Then you should run `util/composer.phar update` to update it in your local `vendor` folder and update the `composer.lock` file that specifies the current versions of the dependencies. +Then you should run `bin/composer.phar update` to update it in your local `vendor` folder and update the `composer.lock` file that specifies the current versions of the dependencies. Please note that you should commit both `composer.json` and `composer.lock` with your work every time you make a change to the former. @@ -111,7 +111,7 @@ This is because `sudo` doesn't always change the `HOME` environment variable, wh However, you can temporarily change environment variable for the execution of a single command. For Composer, this would be: ```` -$> COMPOSER_HOME=/var/tmp/composer sudo -u [web user] util/composer.phar [mode] +$> COMPOSER_HOME=/var/tmp/composer sudo -u [web user] bin/composer.phar [mode] ```` ## Related diff --git a/doc/Developers-Intro.md b/doc/Developers-Intro.md index f0591cddc..53aacafb4 100644 --- a/doc/Developers-Intro.md +++ b/doc/Developers-Intro.md @@ -61,7 +61,7 @@ If you want to have git automatically update the dependencies with composer, you } # `composer install` if the `composer.lock` file gets changed # to update all the php dependencies - check_run composer.lock "util/composer.phar install --no-dev" + check_run composer.lock "bin/composer.phar install --no-dev" just place it into `.git/hooks/post-merge` and make it executable. diff --git a/doc/Github.md b/doc/Github.md index a34855bf7..7c6233d31 100644 --- a/doc/Github.md +++ b/doc/Github.md @@ -13,7 +13,7 @@ Introduction to the workflow with our GitHub repository 3. Fork the Friendica repository from [https://github.com/friendica/friendica.git](https://github.com/friendica/friendica.git). 4. Clone your fork from your GitHub account to your machine. Follow the instructions provided here: [http://help.github.com/fork-a-repo/](http://help.github.com/fork-a-repo/) to create and use your own tracking fork on GitHub -5. Run `util/composer.phar install` in Friendica's folder. +5. Run `bin/composer.phar install` in Friendica's folder. 6. Commit your changes to your fork. Then go to your GitHub page and create a "Pull request" to notify us to merge your work. diff --git a/doc/Install.md b/doc/Install.md index c9fc4e603..23232347e 100644 --- a/doc/Install.md +++ b/doc/Install.md @@ -47,7 +47,7 @@ The Linux commands to clone the repository into a directory "mywebsite" would be git clone https://github.com/friendica/friendica.git mywebsite cd mywebsite - util/composer.phar install + bin/composer.phar install Make sure the folder *view/smarty3* exists and is writable by the webserver user diff --git a/doc/Update.md b/doc/Update.md index 57d29bae4..9e9324da9 100644 --- a/doc/Update.md +++ b/doc/Update.md @@ -21,7 +21,7 @@ You can get the latest changes at any time with cd path/to/friendica git pull - util/composer.phar install + bin/composer.phar install The addon tree has to be updated separately like so: diff --git a/doc/de/Install.md b/doc/de/Install.md index 8c7c72cfc..916c131d6 100644 --- a/doc/de/Install.md +++ b/doc/de/Install.md @@ -49,7 +49,7 @@ Wir planen, diese Einschränkung in einer zukünftigen Version zu beheben. `cd meinewebseite` `git pull` - `util/composer.phar install` + `bin/composer.phar install` - Addons installieren - zunächst solltest du **in** deinem Webseitenordner sein