1
0
Fork 0
Commit Graph

1151 Commits (db32d6bc1870c9be596095e178886f22a9f15e6c)

Author SHA1 Message Date
Mathias Brodala 8424235fac Rename to "scripts-descriptions" 2017-12-18 10:47:01 +01:00
Mathias Brodala 80d0c2029b Move "scripts-description" to toplevel
Fixes #6881
2017-12-18 10:14:24 +01:00
Jordi Boggiano 8bc02d1aed
Merge pull request #6904 from brettsantore/doc-update
clarify optionality of package in require command
2017-12-17 15:02:18 +01:00
Jordi Boggiano 226eb7e657
Merge pull request #6906 from sonjaq/patch-1
Corrects troubleshooting.md documentation link by removing space
2017-12-16 22:38:39 +01:00
Jordi Boggiano 0a09886307
Merge pull request #6880 from mbrodala/patch-2
Document arguments for custom commands
2017-12-16 22:19:44 +01:00
Jordi Boggiano 525e6cddaa
Add check-platform-reqs to docs 2017-12-16 22:04:48 +01:00
Jordi Boggiano 5f382e1e63
Merge pull request #6899 from kohkimakimoto/update-doc
update doc
2017-12-16 21:59:54 +01:00
Sonja Leaf 20cdfd09ae
Corrects documentation link by removing space
There was an extra space lurking that prevented a link from rendering. The space is now removed.
2017-12-15 12:33:31 -06:00
Brett Santore 449ecf098d clarify optionality of package in require command 2017-12-14 11:44:54 -05:00
Kohki Makimoto afa0b14389 update doc 2017-12-13 11:58:42 +09:00
Mathias Brodala 4721a7c2c8
Document arguments for custom commands
Custom commands support the same pattern to pass arbitrary arguments like the "run-script" Composer command.
2017-12-07 12:21:41 +01:00
Dane Powell 8695fd6948
Clarified language on branch naming for forks 2017-12-05 11:15:17 -08:00
Saul Wilcox bb97383772
Add 'remove' to example global commands
Common and useful enough to be explicitly stated in docs
2017-11-15 10:06:24 +00:00
Jordi Boggiano 308cf07973
Merge pull request #6781 from cafferata/patch-1
Update 03-cli.md
2017-11-03 19:59:19 +01:00
Jordi Boggiano 4ab34c22fa
Merge pull request #6740 from croensch/master
also support NO_PROXY
2017-11-03 19:50:28 +01:00
Jordi Boggiano 41a9357d4b Merge remote-tracking branch 'thom8/script_help' 2017-11-03 17:19:36 +01:00
Jordi Boggiano 9df22654c3 Merge remote-tracking branch 'grasmash/issue-6661-whitelist-all-deps' 2017-11-03 14:20:38 +01:00
Jeffrey Cafferata b36622d316
Update 03-cli.md
Package `fabpot/php-cs-fixer` is, so I replaced it with `friendsofphp/php-cs-fixer`.
2017-11-03 11:49:42 +01:00
croensch 6da92e98ac also support NO_PROXY
since WINDOWS can only have one case and that is usually upperase
2017-10-12 16:35:05 +02:00
Petr Heinz 7d06c3b9b8 typo "semvar" => "semver" 2017-09-19 09:37:28 +02:00
Bartek Zdanowski dc693c3a6e fixed caret sub title link in the article
Fixed link to Caret version range paragraph
2017-09-12 09:11:47 +02:00
Thom Toogood bf880ad5e0 Allow custom script descriptions. 2017-09-12 13:17:08 +10:00
Matthew Grasmick 2e9e7ddd99 Updating docs. 2017-09-11 12:43:32 -04:00
Jordi Boggiano 92458596ea Merge branch '1.5' 2017-09-11 16:23:25 +02:00
Jordi Boggiano 69ecb2403e Add upgrade alias to update, fixes #6649 2017-09-11 16:13:33 +02:00
Jordi Boggiano 7c0a774157 Merge pull request #6654 from andrewryantech/patch-1
Update why-can't-composer-load-repositories-recursively.md
2017-09-11 10:32:55 +02:00
Nils Adermann 90b802a732 Documentation: Wording on multi version package repo doc 2017-09-11 00:11:20 +02:00
Jordi Boggiano eb61069058 Merge pull request #6613 from decadence/patch-1
Note for aliases
2017-09-09 12:41:49 +02:00
andrewryantech a6d0ecd13f Update why-can't-composer-load-repositories-recursively.md 2017-09-05 08:55:37 +10:00
Deamon bff904d11c add example on how to add several version of a package 2017-08-25 15:39:52 +02:00
Victor Isadov 4a4bd4a6a2 Note for short names 2017-08-16 16:14:29 +03:00
Victor Isadov 884a605bbe Update 03-cli.md 2017-08-16 16:11:41 +03:00
Victor Isadov 7968016d26 Update 03-cli.md 2017-08-16 16:11:04 +03:00
Victor Isadov 4c165f9718 Update 03-cli.md 2017-08-16 16:08:05 +03:00
Jordi Boggiano 0292a2f78f Merge pull request #6605 from decadence/patch-1
Update versions.md
2017-08-14 09:24:59 +02:00
Victor Isadov 2bb5c79ea4 Update versions.md 2017-08-12 14:49:54 +03:00
Mohamed Chraiet c2815e9df0 Typo correction
Should be repository instead of respository.
2017-08-11 16:33:27 -04:00
Jordi Boggiano b07be842a0 Remove feature-branches option as it is misnamed and duplicates the non-feature-branches option, refs #6475 2017-08-07 18:14:04 +02:00
Jordi Boggiano c2da4e0e0e Merge pull request #6582 from jasonquick/patch-1
Improve BitBucket driver usage documentation
2017-08-07 11:17:58 +02:00
Jordi Boggiano 474834e8a9 Wording tweaks 2017-08-07 10:57:15 +02:00
jasonquick 5b6d954528 Clarify use of auth.json file 2017-08-04 13:29:21 -04:00
jasonquick 88b88319b5 Improve BitBucket driver usage documentation
Clarified and expanded the documentation for private repositories using the BitBucket driver. Emphasized the use of the COMPOSER_AUTH variable to encourage people not to save their credentials in composer.json. Pointed out that git endpoints don't seem to work.
2017-08-01 21:32:13 -04:00
Alex Mersdorf 1d66852c6e Update 04-schema.md
Added line to try and clarify, that any dev/non-minimum-stability Requirement needs to be added to root composer.json as well.
2017-07-10 14:27:01 +02:00
Jordi Boggiano 020805dd6f More version doc updates 2017-07-04 08:18:43 +02:00
Jordi Boggiano 91fcb6cba1 Clarify version doc titles 2017-07-04 08:16:56 +02:00
Jordi Boggiano 69282de829 Fix env var docs 2017-06-17 15:38:05 +02:00
Wil Hall 9e2cd9e717 Word wrap htaccess-protect option documentation 2017-06-16 08:26:43 -04:00
Wil Hall 6b806d3afd Add cli documentation for COMPOSER_HTACCESS_PROTECT env variable 2017-06-15 11:53:13 -04:00
Wil Hall bf088c76c4 Simplify documentation for htaccess-protect config option 2017-06-15 11:43:11 -04:00
Wil Hall f0924fb878 Add htaccess-protect option for disabling the creation of .htaccess files 2017-06-15 11:06:13 -04:00
Jordi Boggiano cc9234562d Merge pull request #6475 from NamelessCoder/featurebranches
Add support for feature-branches setting
2017-06-15 15:49:10 +02:00
Jordi Boggiano 1d9434af45 Merge pull request #6095 from teolaz/teolaz1990-doc-patch
Teolaz1990 doc patch
2017-06-15 14:44:46 +02:00
Mathias Brodala 112ff7b61d Fix typo in docs
Fixes a typo from #6477
2017-06-13 14:52:52 +02:00
Michael King e7d2682204 Example of disabling packagist.org globally
Obviously this is not a common use case, but it is good for isolated networks. As far as I could tell, this was not documented, but I figured it out by looking through the code.
2017-06-13 08:06:13 -04:00
Claus Due 965f1f42d1 Add support for feature-branches setting
A negative list of non-feature-branches names
is already supported - this patch adds a list of
branches names which *will* be considered as
feature branches.

Allows changing the currently hardcoded set of
expected feature branch names, from:

* master|trunk|default|develop

To any set of names or patterns that you desire.
2017-06-11 19:02:51 +02:00
Jordi Boggiano 9aadbe2728 Minor wording tweak
Closes https://github.com/composer/getcomposer.org/issues/113
2017-06-06 15:49:06 +02:00
Jonas Thelemann f3aa1885bb Remove Deprecated Licenses
These licenses are deprecated in spdx spec v2 (https://spdx.org/licenses/).
2017-05-25 23:33:20 +02:00
Nick Booher 222440c7f2 Rename how-do-i-install-composer-programmatically.md to how-to-install-composer-programmatically.md 2017-05-19 06:17:38 -05:00
Nick Booher c79d4b6a9f Fix grammar and match form of similar questions 2017-05-18 14:15:27 -05:00
Javier Eguiluz 4a3d57b166 Typo 2017-04-05 11:31:41 +02:00
Javier Eguiluz 5f6d42a0b0 Package names are case insensitive 2017-04-05 10:04:19 +02:00
Javier Eguiluz 5f09df6070 [Doc] Explained a bit more about the possible contents of the "name" property 2017-04-05 09:15:06 +02:00
Fabien Bourigault df85bc3ac3 update cli documentation 2017-03-27 16:52:50 +02:00
frezno 5a3891d5d9 Correct path 2017-03-11 16:15:19 +01:00
Roman Kluth aa784bc1a5 Update 01-basic-usage.md 2017-03-09 12:37:34 +01:00
Thorsten Frommen 8c388a6a4d Fix typo 2017-03-09 11:14:27 +01:00
Nils Adermann 001fe8afcf Merge branch 'docs-improve'
* docs-improve:
  Docs: cleanup version branches section
  Docs: those/these composer/Composer
  Docs: notice => note
  Docs: Fix shell sample output
  Docs: Add back a second clear note about hardcoded versions in VCS
  Docs: HHVM is not called HipHop
  Docs: versions plural, and update == rm lock&install
  Docs: don't use short forms, it => composer
  Docs: composer.lock lists versions, not constraints
  Docs: superfluous comma & it => Composer
  The confusing part is probably rather constraints and how versions work, not what they are
  Docs: Clarify what "It" stands for
  Finished reworking docs to clarify points about versioning (fixes #6088)
  Updated basic usage and versions pages to clarify how versioning and package resolution works (refs #6088)
  Added some useful overview information about repositories in the Basic Usage documentation.
2017-03-08 11:21:05 +01:00
Nils Adermann cd224ad44b Docs: cleanup version branches section 2017-03-08 11:20:23 +01:00
Nils Adermann 6c07bb1fb7 Docs: those/these composer/Composer 2017-03-08 11:13:08 +01:00
Nils Adermann 4a20d5d98b Docs: notice => note 2017-03-08 11:10:51 +01:00
Nils Adermann 138fb5b6af Docs: Fix shell sample output 2017-03-08 11:02:24 +01:00
Nils Adermann d835983b15 Docs: Add back a second clear note about hardcoded versions in VCS 2017-03-08 10:58:55 +01:00
Nils Adermann faac4d56b4 Docs: HHVM is not called HipHop 2017-03-08 10:49:06 +01:00
Nils Adermann 78565d00b9 Docs: versions plural, and update == rm lock&install 2017-03-08 10:45:46 +01:00
Nils Adermann 4ccf5b6535 Docs: don't use short forms, it => composer 2017-03-08 10:42:54 +01:00
Nils Adermann 586e0d6cdb Docs: composer.lock lists versions, not constraints 2017-03-08 10:36:27 +01:00
Nils Adermann 18a4aecef5 Docs: superfluous comma & it => Composer 2017-03-08 10:29:02 +01:00
Nils Adermann 7bdc929e6d The confusing part is probably rather constraints and how versions work, not what they are 2017-03-08 10:23:14 +01:00
Nils Adermann c15baed33a Docs: Clarify what "It" stands for 2017-03-08 10:15:27 +01:00
Jordi Boggiano a286c39f20 Add docs about new --format, refs #6228 2017-03-07 14:19:51 +01:00
Jordi Boggiano 6260bb70d0 Warn about using autoloader optimizations in dev 2017-03-07 14:04:10 +01:00
Jordi Boggiano f1f064981b Add docs about autoloader optimizations, fixes #5947 2017-03-07 12:33:19 +01:00
Jordi Boggiano e2b2baf48a Merge pull request #6205 from Xerkus/patch-1
Update current plugin api version in docs
2017-03-06 15:43:09 +01:00
Jordi Boggiano 0ecd1f5eb5 Merge branch '1.3' 2017-03-06 12:30:33 +01:00
Jordi Boggiano 4b11bbccef Add note about requiring composer for plugin dev, fixes #6132 2017-03-06 09:01:07 +01:00
Jordi Boggiano 78d81cc473 Fix typo 2017-03-01 09:13:04 +01:00
Aleksei Khudiakov acc1238ac2 Update current plugin api version in docs 2017-02-24 05:02:57 +10:00
Jordi Boggiano b3fe9fa1a5 Update example to use psr-4 namespace adding, fixes #6145 2017-02-17 22:17:27 +01:00
Christian Schnegelberger 86b2e01a8b Dead link to Mercurial
https://www.mercurial-scm.org/ <-- new one
2017-02-16 18:02:39 +01:00
Jordi Boggiano 363bab90fa Replace toran 2017-02-10 13:32:08 +01:00
Kael Shipman 9a755fa7d4 Merge remote-tracking branch 'upstream/master' 2017-01-23 13:07:22 -06:00
Kael Shipman c8c7619a4a Finished reworking docs to clarify points about versioning (fixes #6088) 2017-01-23 13:06:51 -06:00
Richard B. Porter 231f56b4ae use 'in the case of' instead of 'in case of' 2017-01-20 13:44:19 -06:00
Kael Shipman a0d2934946 Updated basic usage and versions pages to clarify how versioning and package resolution works (refs #6088) 2017-01-20 11:49:29 -06:00
Kael Shipman 7a9f24b913 Added some useful overview information about repositories in the Basic Usage documentation. 2017-01-19 19:04:24 -06:00
Tilo Baller 89a2e66293 Add GitLab as supported downloads source in docs 2017-01-19 00:12:05 +01:00
Matteo 9e605c85e2 Update 05-repositories.md
another thing forgot learned here #6056 and here https://github.com/composer/composer/issues/5166#issuecomment-226110812
2017-01-10 15:19:54 +01:00
Matteo 60cf410acf Update 05-repositories.md
Another thing noted while trying to solve the problem here #6056
2017-01-10 15:09:03 +01:00
Matteo 639c0fb5ce Update 05-repositories.md
Refer to #6056
2017-01-10 13:46:33 +01:00
Nils Adermann b3bd409a30 Clarify Private Packagist description a bit 2017-01-03 01:03:08 +01:00
Filippo Tessarotto 498d49f1ba Fix php.net HTTPS links; always use HTTPS for getcomposer.org 2017-01-02 12:49:45 +01:00
Michael Cullum 97a80b6249 Update memory limit in docs
As per 0bc75c3fb6
2017-01-01 21:18:52 +00:00
Jordi Boggiano 77ad36c067 More doc updates 2016-12-29 18:12:21 +01:00
Jordi Boggiano fdd63de8ac Typo fix 2016-12-29 18:02:08 +01:00
Jordi Boggiano 173a601d27 Update private package hosting docs 2016-12-29 18:01:02 +01:00
johnstevenson 25ff290e4c Document COMPOSER_DISABLE_XDEBUG_WARN variable 2016-12-28 15:22:00 +00:00
johnstevenson d57a89d5af Update xdebug troubleshooting, fixes #5997 2016-12-28 12:13:23 +00:00
Jordi Boggiano 9042147674 Merge pull request #5931 from Jean85/patch-1
[Documentation] Update troubleshooting article
2016-12-24 01:08:39 +01:00
Jordi Boggiano da097aa6fc Clarify PATH modification, refs #5970 2016-12-18 11:39:05 +01:00
Jordi Boggiano b0000617cc Support @php prefix for scripts to reuse the current PHP interpreter, fixes #5957 2016-12-11 16:17:34 +01:00
Jordi Boggiano 1dcb2b5758 Merge remote-tracking branch 'nicolas-grekas/apcu' 2016-12-07 00:21:13 +01:00
Jordi Boggiano cd21d7e7d4 Merge pull request #5897 from baptistedonaux/patch-1
Permanent swap file tutorial proposed
2016-12-06 22:44:11 +01:00
Alessandro Lai 7b966f9355 Remove reference to COMPOSER_IGNORE_XDEBUG_WARN 2016-12-06 17:48:23 +01:00
Nicolas Grekas 6d4e60b991 Add --apcu-autoloader option to enable APCu caching of found/not-found classes 2016-12-06 11:21:44 +01:00
Mark Watney a8a432c580 Fix wrong Composer package "type" example
Details: https://wiki.typo3.org/Composer#TYPO3_Composer_installers
2016-12-02 20:22:07 +01:00
Alessandro Lai 365e3feba9 [Documentation] Update troubleshooting article
- remove the xdebug section, since it will be irrelevant from v1.3
 - add cPanel shell fork bomb protection as an other possible root cause of memory errors
2016-12-02 18:26:07 +01:00
Rob Bast 960607afc8
Merge branch '1.2' of github.com:composer/composer
* '1.2' of github.com:composer/composer:
  semver.mwl.be moved to HTTPS
2016-12-02 10:09:28 +01:00
Filippo Tessarotto 35a5036c3e semver.mwl.be moved to HTTPS 2016-12-02 09:09:31 +01:00
Bill Lovett 9e16882d12 Clean up a merge conflict in repositories doc
A merge conflict slipped through recently, corrupting the page a bit.
2016-12-01 09:44:35 -05:00
Jordi Boggiano 193d53921b Merge branch '1.2' 2016-12-01 00:00:32 +01:00
Jordi Boggiano 91e7372c6e Backport update packagist default repo to be packagist.org 2016-11-30 22:57:11 +01:00
debugteam 2333a0120e disabling packagist.org did not work
While testing i found that 

"packagist.org": false 

didn't work to disable packagist.

I have read following issue 

https://github.com/composer/composer/issues/3713

afterwards i've testet 

"composer config repositories.packagist false"

did the review on the composer.json and found that 

"packagist": false 

actually disabled packagist.
2016-11-29 18:02:38 +01:00
Baptiste Donaux 90b79d685a Permanent swap file tutorial proposed 2016-11-23 12:05:55 +01:00
Rob Bast 4abb02dbe8
fix #5884 - mardown issues + move urls to footnotes 2016-11-21 08:19:10 +01:00
Rob Bast 96540d4139
apply proper word wrapping 2016-11-18 14:33:42 +01:00
copitz cc932e5bda Add documentation for providers option
With composer/satis#295 an option for dumping provider includes was added which is missing here in the docs
2016-11-18 11:48:26 +01:00
Jordi Boggiano 027de2960b Merge pull request #5794 from andrewjt71/issue-5769
Issue 5769 dev mode varaible
2016-11-06 16:58:41 +01:00
Viktor Szépe d0918b0594 Make download shell script PSR-2 compatible
Avoid `else`
2016-11-04 23:25:21 +01:00
Jordi Boggiano 9c8617cd33 Merge branch '1.2' 2016-11-03 11:05:42 +01:00
Jordi Boggiano e38ebefc7e Update packagist default repo to be packagist.org 2016-11-03 11:00:40 +01:00
Niels Keurentjes f99a33bfc7 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.
2016-10-31 16:26:37 +01:00
Rob Bast 235b1cca81
wordwrap and minor rephrasing 2016-10-19 08:40:06 +02:00
Andrew Taylor ce6a3c0dd7 Issue 5769 dev mode varaible 2016-10-18 22:56:32 +01:00
Rob e1d1a73cad Update 04-schema.md
Wrap line-length and modify phrasing
2016-10-10 10:10:06 +02:00
Tomáš Fejfar dbc5d3a83f Clarify allowed format for repositories key
Using JSON object should be discouraged as there is no explicit order
of keys in JSON object. Even though it's deterministic in current PHP
version, it may change any time. As stated on http://json.org/:
"An object is an unordered set of name/value pairs. An object begins
with { (left brace) and ends with } (right brace). Each name is
followed by : (colon) and the name/value pairs are separated
by , (comma)."

Fixes #2802.
2016-10-09 22:24:14 +02:00
Rob Bast 7377db32ae
remove 'includes' references from docs
Relates to #5739 - we do not want to mention attributes/properties that
are considered legacy and/or deprecated.

Also reflowed some lines.
2016-10-03 10:14:57 +02:00
Jordi Boggiano b6cc2c7b83 Merge pull request #5665 from radmiraal/default-strategy-from-environment
Allow setting default transport strategy for path repositories
2016-09-29 08:41:11 +02:00
Jordi Boggiano e3a5b4c723 Wording tweaks, refs #5733 2016-09-29 08:20:23 +02:00
vbashkirtsev eb494e5464 Elaborated on importance of PHP extension dependencies
@Seldaek: As discussed yesterday here addition to the docs re PHP extensions. I have put it as a note as it appears emphasized for users to notice easily.
2016-09-28 21:10:16 +09:30
Rens Admiraal a294af3f16 Allow setting default transport strategy for path repositories
This change allows setting COMPOSER_MIRROR_PATH_REPOS to 1
in the environment to set the default strategy to 'mirror'.

This allows using 'mirror' during deployments while still symlinking
on a development machine. The default is still overwritten by the
options on the repository configuration.
2016-09-25 19:56:12 +02:00
Jordi Boggiano cada55dde6 Merge pull request #5491 from moolex/support_gitlab_private_token
Support gitlab private-token for easier access via Gitlab API
2016-09-10 12:15:35 +02:00
Yaman Jain 66950f0354 JSON standard do not allow trailing comma 2016-09-02 17:33:06 +05:30
Jordi Boggiano f3af3ede40 Merge pull request #5552 from fvdb/add-minor-only-option
Added minor-only option to show command to only show packages with minor updates
2016-08-29 19:38:18 +02:00
Frank van den Brink d5dbe5743a
Fixed typo in --minor-only option documentation 2016-08-26 11:14:08 +02:00
Frank van den Brink 12cee0b927
Added --minor-only option to documentation 2016-08-26 11:12:27 +02:00
Jesse Donat 9f7ea6e2dc Updates docs 2016-08-18 15:09:16 -05:00
José Carlos Chávez c28fe2b507 Adds --no-suggestion flag to the documentation for the install and update commands. 2016-08-16 11:18:19 +02:00
James Brooks c283067602 Fix link to CONTRIBUTING.md 2016-07-19 17:34:42 +01:00
snipe 35821fc0ce Update troubleshooting.md 2016-07-19 02:35:50 -07:00
snipe 1b96882736 Fixed typo 2016-07-19 00:52:08 -07:00