1
0
Fork 0
Commit Graph

1502 Commits (416b43b401c75cb07e46051efd57611f6a1e2234)

Author SHA1 Message Date
Jordi Boggiano 4f2e2ec4fc
Update docs for renamed COMPOSER_RUNTIME_BIN_DIR 2022-02-04 16:59:57 +01:00
Houssem Zitoun 3ae111140f
Improve documentation (#10477)
Co-authored-by: Houssem ZITOUN <houssem.zitoun@ekino.com>
2022-01-21 17:39:57 +01:00
James Watts 96332161fe
Fix simple typo and slightly reword phrase. (#10456) 2022-01-13 16:00:10 +01:00
Jonas Drieghe b9c368a9c3
Use new url for semver testing tool (#10449)
semver.mwl.be returns a permanent redirect to semver.madewithlove.com
2022-01-10 20:58:42 +01:00
Jordi Boggiano f7ce907148
Update plugin-api in docs 2022-01-05 14:50:30 +01:00
Nico Haase 8486b38fef
Update plugins.md API version (#10427)
Fixing the API version, as changed in 1b5b5c48bf
2022-01-04 11:57:12 +01:00
Jordi Boggiano a8ed352b31
Add docs for the new bin-dir access and bump runtime-api, refs #10402 2021-12-28 22:04:32 +01:00
Jordi Boggiano 8f1b3d21db
Add --no-scripts to all commands and disable plugins/scripts when running self-update (#10371)
* Add --no-scripts as global parameter available to all commands, and handle it by default when creating a Composer instance from Command::getComposer

* Disable scripts/plugins for self-update command, fixes #10351
2021-12-20 14:23:35 +01:00
gnito-org 239638e687
Fix minor spelling & grammar issues in docs (#10370) 2021-12-19 15:15:21 +01:00
Tom Klingenberg 692de949de
$home -> $COMPOSER_HOME (#10363)
the `$home` variable referenced in the conifguration docs for data- and
cache-dir is a reference to an internal PHP variable that contains the
composer home directory.

as on the documentation page it is not visible where that variable comes
from (the document uses only shell/environment variables otherwise) these
two places are hard to read/understand.

the exact meaning of `$home` (lowercase) is the composer-home (or just
home) global configuration setting (composer home is for all user-wide
composer invocations, to store data in the filesystem namespace of the
user executing composer).

that meaning is better documented with the `$COMPOSER_HOME` environment
variable (which when it does not exists the default value is well
documented in [03-cli.md#composer-home].

replace `$home` with `$COMPOSER_HOME`.

additionally small typo fix on "rollback" which is "roll back".

discussion: #10363
[03-cli.md#composer-home]: doc/03-cli.md#composer-home
2021-12-19 14:05:57 +01:00
Jordi Boggiano d274bf0313
Fix PHP x spacing 2021-12-19 12:38:45 +01:00
Markus Staab f051a42bc9
docs: Highlight sudo (#10367) 2021-12-19 10:59:13 +01:00
Jordi Boggiano cc32ebcabd
Search improvements (#10336)
* Search performance improvements, add SEARCH_VENDOR type, fixes #10326, fixes #10324, fixes #10325

* Add extra optimization path for autocompletion of ^foo/* whereas the vendor is fully known, refs #10320
2021-12-08 11:45:18 +01:00
Jordi Boggiano a3e91b5be6
Add allow-plugins config value (#10314)
Fixes #5659

- Automatically switch off plugins by default in July 2022
- reword hash into object in schema

Co-authored-by: Nils Adermann <naderman@naderman.de>
2021-12-07 23:00:48 +01:00
Colan Schwartz 04dbed27a9
Make it explicitly clear that `dev-` shouldn't be in the actual branch name. (#10335) 2021-12-07 21:22:17 +01:00
Jordi Boggiano a4a89f1508
Update archive format docs, refs #10087 2021-12-07 15:56:35 +01:00
Henk Poley 74951b5377
Document archive --format=tar.gz (#10087) 2021-12-07 15:53:07 +01:00
Jordi Boggiano e30a6b0b9b
Add support for ignoring the upper bound of platform requirements using "name+" notation 2021-12-07 13:24:08 +01:00
Nils Adermann 09ffabbf6e Merge branch '2.1' into main
* 2.1:
  Fixed documentation for cache-dir location in case of xdg
2021-12-07 11:21:43 +01:00
Alex Plekhanov 2474d6f526
Fixed documentation for cache-dir location in case of xdg 2021-12-07 01:54:03 +01:00
Tizian Schmidlin 4f789a5f6d
Add "use-parent-dir" config to configure prompt when no composer.json is present in current dir (#10307)
Fixes #10299

Co-authored-by: Jordi Boggiano <j.boggiano@seld.be>
2021-12-04 15:00:28 +01:00
Jordi Boggiano 5d218287d9
Doc clarification 2021-11-30 09:46:38 +01:00
Helmut Hummel ace8a1776c
Add composer platform package with exact Composer version (#10313)
Co-authored-by: Lars Strojny <lars.strojny@internations.org>
Co-authored-by: Nils Adermann <naderman@naderman.de>
2021-11-27 14:26:57 +01:00
Jordi Boggiano 91548d178b
Add support for setting platform packages to false to disable them (#10308)
Fixes #9664
2021-11-25 14:46:25 +01:00
Helmut Hummel f12a5b8214
Expose path to autoload in a global var for binaries (#10137)
Always create proxy files for package binaries,
to avoid not working binaries in case the package
was installed from a path repository and is itself linked

If the binary is a PHP script, a global variable is now exposed,
which holds the path to the vendor/autoload.php file.
This variable can the be used in the binaries to include this file
without guessing where the path to the vendor folder might be.

Additionally it is now checked on binary creation whether
the reference binary has a shebang and if not, generates
a much simple proxy code, because the stream wrapper code,
that is required for PHP <8 to omit the shebang from the output,
can be skipped.

Fixes: #10119

Co-authored-by: Jordi Boggiano <j.boggiano@seld.be>
2021-11-25 09:53:03 +01:00
Yehuda Katz ebf4cbdc69
Add COMPOSER_NO_DEV environment variable to set the --no-dev flag (#10262) 2021-11-24 11:32:19 +01:00
Rafael Dohms 78583ab678
Support ignore-platform-reqs in `composer outdated` (#10293)
This allows users to also find libraries that require major platform
changes to unlock updates.
It addresses #10291.
2021-11-23 17:16:58 +01:00
Jordi Boggiano 807c677865
Improve some linking 2021-11-23 14:48:47 +01:00
Martin Herndl 8386264c98
Fix spelling of Bitbucket (#10290) 2021-11-17 20:54:18 +01:00
Stephan 5297f72e3f
Docs: add transport options example and differentiate between cURL and stream options (#10289)
+ remove Bitbucket mercurial reference
2021-11-17 19:54:30 +01:00
Bruno Baguette 0f5f0fb9e1
(Probable) typo fix (#10286)
Isn't "to" missing before "raise awareness" ?
2021-11-17 11:03:48 +01:00
Yanick Witschi 34183f49f9
Implemented PoolOptimizer 2021-11-11 16:13:24 +01:00
Martin Herndl 7eca450d9b
Add wildcard support to ignore-platform-req, fixes #10045 (#10083) 2021-11-11 15:56:38 +01:00
Jordi Boggiano 8542321a31
Updates to the troubleshooting docs, refs #10129 2021-11-11 15:18:16 +01:00
Stephan 44c5b6cde6
Config: add source option for command to show where a config value is loaded from (#10129) 2021-11-11 15:17:58 +01:00
Raphael de Almeida 150acc5559
Removed HgBitbucketDriver support (#10248) 2021-11-10 21:58:03 +01:00
Matthias Pigulla abf832aa49
Update what GitHub token scope is needed and what it implies (#10257)
Follows up on https://github.com/composer/composer/pull/10256.
2021-11-08 10:53:12 +01:00
Jordi Boggiano c65d09dff7
Fix @inheritDoc annotations 2021-10-27 16:18:53 +02:00
jakobvibe 15934a083c
Added link to composer-allow-superuser (#10215) 2021-10-26 17:43:03 +02:00
Wouter de Jong bb128c465c Capitalize Composer in the docs 2021-10-25 13:11:56 +02:00
Wouter de Jong 6aec6ecbfa Use `composer.phar` consistently in the examples 2021-10-25 13:11:41 +02:00
Markus Staab c9b80bc3b6
Fix reference to main [ci skip] (#10174) 2021-10-17 13:51:42 +02:00
Markus Staab b8e2fcd33d
Fix reference to main branch (#10173) 2021-10-17 13:51:25 +02:00
Jordi Boggiano 0868245589
Rename master branch to main 2021-10-14 16:21:47 +02:00
Rodrigo 131d6ade5d
Add alternative to custom installers (#10149)
Taken from composer/installers readme
2021-10-13 22:48:58 +02:00
immeëmosol bced747ed3
Note that CMPSR_HM/config.json is partially merged (#10152) 2021-10-13 22:45:15 +02:00
Ian Dunn b78570055d
Docs: Place general troubleshooting steps in a more logical order
* `self-update` should be run first, because it may affect the results of `diagnose`. 
* `clear-cache` should be run before `update`, otherwise `update` would need to be run again after clearing the cache.
2021-08-31 11:44:46 -07:00
Jordi Boggiano 17b972f2a9
Update community page 2021-08-19 16:03:36 +02:00
Ryan McCue 812cf836f3
Add documentation for v2 repository fields (#10033) 2021-08-19 15:49:02 +02:00
Jordi Boggiano a72784c4da
Merge pull request #10057 from nicholsonjf/docs-double-pipe-note
Note in docs about how single pipes are treated
2021-08-18 12:11:09 +02:00
小克 d9a94b376a
Update the Composer plugin API version to 2.1.0 2021-08-17 18:36:08 +08:00
James Nicholson 2d79f3381b Single pipe note 2021-08-13 13:50:38 -04:00
Thomas Dutrion 82a7c527f9
Highlight the proprietary license trick
From the Symfony Dev #french slack channel (symfony-devs.slack.com), people look confused regarding the value to use as license for proprietary projects, even though it's written in the documentation.

Because proprietary software is still a massive part of composer's usage, I think it can be interesting to have it as a note, more readable to people.

Extract from the conversation:
> J’étais sur la bonne page, il me manquait deux lignes de scroll pour voir ça -.- On a tous nos petits moments de faiblesse

Which roughly translates to:
> I was looking at the right page, just about two lines above... We all have our weak moments
2021-07-22 12:08:25 +02:00
Sebastian Blank a9031e40eb
Add "symlink" option for "bin-compat" config (#9959) 2021-06-09 11:33:44 +02:00
Jordi Boggiano 6e851edd70
Add `--dev` to `dump-autoload` command to allow force-dumping dev autoload rules even if dev requirements are not present, fixes #9946 2021-06-07 15:48:37 +02:00
Jordi Boggiano 30d38679a8
Update ci job token link 2021-06-03 09:19:18 +02:00
Jordi Boggiano c90cd6f640
Clarify what is checked when with platofrm check, fixes #9307 2021-06-02 10:11:42 +02:00
Nils Adermann 1dc39bda75
Merge pull request #9915 from Seldaek/reinstall
Add a reinstall command
2021-05-31 17:22:32 +02:00
Abi أب 759897e7e8
Update cache dir on macOS to follow OS guidelines (now $HOME/Library/Caches/Composer) (#9898)
Co-authored-by: Jordi Boggiano <j.boggiano@seld.be>
2021-05-27 23:07:23 +02:00
Brad Jones dd625669e8
Introduce gitlab-protocol option to force the gitlab repos to use https or git protocol (#9401) 2021-05-27 23:05:53 +02:00
Nils Adermann 21c70c2606
Merge pull request #9902 from Seldaek/cyclic-deps
Detect and output a better hint for cyclic dependencies
2021-05-25 22:58:50 +02:00
Jordi Boggiano cbef7b9172
Detect and output a better hint for dependencies on the root package, fixes #9837 2021-05-25 22:47:53 +02:00
Jordi Boggiano 387e504437
Undeprecated dump-autoload --no-dev even though it is mostly not needed anymore, refs #9714 2021-05-25 22:39:55 +02:00
Jordi Boggiano 500efbe233
Add a reinstall command, fixes #3112 2021-05-25 22:30:15 +02:00
Guilliam Xavier 41c66b1a2d Revert "Update docs and add more helpful output to validate command, refs #9782"
This reverts commit 458bd41d8f.
2021-05-24 11:46:08 +02:00
Jordi Boggiano da3d5e3143
Merge pull request #9699 from ochorocho/improve-installed-versions-9648
Add install-path and type to installedVersions.php and installed.php,…
2021-05-24 10:29:40 +02:00
Jordi Boggiano 23d1de5d59
Merge branch '2.0' 2021-05-21 16:44:33 +02:00
Jordi Boggiano fee22972ea
Update basic docs on install/update, fixes #9754 2021-05-21 16:44:05 +02:00
Jordi Boggiano 284ec95712
Document new methods and update the composer-runtime-api version to 2.1 2021-05-21 14:34:51 +02:00
Jordi Boggiano 8a3f4a8400
Add secure-svn-domains config option to mark secure svn:// hostnames, fixes #9872 2021-05-20 16:27:58 +02:00
Jordi Boggiano 458bd41d8f
Update docs and add more helpful output to validate command, refs #9782 2021-05-20 16:11:51 +02:00
Gert de Pagter cc7c6e569b
Make a note about lower casing of package names (#9883) 2021-05-17 22:18:06 +02:00
Michael Voříšek 5456cf8197
Fix EOL of text files (#9877) 2021-05-12 15:19:52 +02:00
timrizzi 6b7f795956
Link to GitLab documentation for auth (#9833)
Co-authored-by: Jordi Boggiano <j.boggiano@seld.be>
2021-05-04 16:05:05 +02:00
Jordi Boggiano 6587715d0f
Merge branch '2.0' 2021-04-20 22:05:32 +02:00
Jordi Boggiano 1fd70de32d
Merge branch '2.0' 2021-04-20 22:03:43 +02:00
Andreas Scheibel bb1bb022e4
"composer init --autoload" - Interactive generates PSR-4 autoloader in composer.json (#9829)
- Generates PSR-4 autoload entry in composer.json.
- Run dump-autoload, if no dependencies are set
2021-04-20 21:58:38 +02:00
Jordi Boggiano 9ed241c809
Use jsonc highlighting 2021-04-19 14:16:39 +02:00
Jordi Boggiano 53a4725dbe
Fix source links, fixes #9836 2021-04-18 23:10:17 +02:00
Antoine Makdessi e1b8722bfa
Update 00-intro.md 2021-04-11 14:04:18 +02:00
Jordi Boggiano f13282e555
Change default preferred-install to dist, add --prefer-install=auto|dist|source to allow specifying auto (#9603)
Fixes #9546
Fixes #9674
2021-04-07 16:04:42 +02:00
Jordi Boggiano cb2db16637
Merge branch '2.0' 2021-04-07 13:24:47 +02:00
Jordi Boggiano 52a452c885
Improve InstalledVersions docs slightly 2021-04-07 12:44:23 +02:00
Jordi Boggiano dca8bd7197
Merge branch '2.0' 2021-04-01 10:15:10 +02:00
Jordi Boggiano 53a974f9c9
Tweak virtualbox detection and improve it by detecting vbox additions, refs #9627 2021-04-01 09:48:07 +02:00
ochorocho 35210d99a9
Add --format json to search command (#9747)
Co-authored-by: Jordi Boggiano <j.boggiano@seld.be>
2021-03-09 23:06:02 +01:00
ochorocho 8f315551d4
Remove output "summary" from fund command. Fund does not provide this type of format. (#9748) 2021-03-09 21:49:54 +01:00
Jordi Boggiano ed1fe28ab2
Add --format to fund command docs 2021-02-25 16:54:26 +01:00
Jordi Boggiano d0aac44ed2
Auto-detect dev-mode in autoload-dump and deprecate dump-autoload --no-dev (#9714) 2021-02-24 21:17:05 +01:00
Jordi Boggiano b724adde10
Link source from docs 2021-02-10 16:01:45 +01:00
Jordi Boggiano 40095b20dc
Allow tweaking the max parallel http requests via env var, fixes #9671 2021-02-10 14:34:59 +01:00
sink 66ec8b3d92
docs: fix bad URL 2021-02-08 16:56:57 +08:00
Jordi Boggiano 07b8c23f02
Merge branch '1.10' 2021-01-27 15:46:58 +01:00
Nicolas Grekas 725b33ee5a Handle "versions" option in PathRepository, remove support for "branch-version" 2021-01-27 14:28:26 +01:00
Nicolas Grekas 079e501ac8 Revert "Merge pull request #9273 from nicolas-grekas/dev-version"
This reverts commit d2d606ced2, reversing
changes made to 4a8dbcd145.
2021-01-27 14:03:44 +01:00
Jordi Boggiano f2cdec0f0f
Merge pull request #9639 from glaubinix/t/docs-stability
Docs: explain how Composer gets the stability from a version
2021-01-25 21:28:04 +01:00
Jordi Boggiano b8f9550a2e
Update doc/articles/versions.md 2021-01-25 21:27:43 +01:00
Stephan Vock bb393588ea Docs: explain how Composer gets the stability from a version 2021-01-22 10:04:58 +00:00
Ulrich Eckhardt b4cff190a8
Remove dependency on wget from install docs
Some people have wget, others have cURL, but we all have PHP. ;)
2021-01-21 14:33:49 +01:00
Jordi Boggiano 738a89ffe1
Doc tweaks, fixes composer/getcomposer.org#178 2021-01-12 16:19:29 +01:00
Jordi Boggiano 19eef374d0
Clarify package link docs a little, refs #9569 2021-01-08 09:29:48 +01:00
Brad Jones 4b2df65833
Clarify difference in create-project related scripts
I wasn't entirely clear the difference between post-root-package-install and post-create-project-cmd, so this is an effort to clarify (as to the best of my understanding.)
2020-11-23 10:41:52 -10:00
Jordi Boggiano f129c231b1
Update recommended php req in docs 2020-11-20 09:18:21 +01:00
Jan Slabon 27339aeaf8
Update authentication-for-private-packages.md
Added some information about encoding of username and password for "Inline http-basic" authentication.
2020-11-18 14:41:27 +01:00
Jordi Boggiano 89947c5e37
Bulk up platform config docs, refs https://github.com/composer/composer/issues/9377#issuecomment-719019204 2020-11-13 15:51:24 +01:00
PrinsFrank 3d5be62250
Add article on resolving merge conflicts (#9386) 2020-11-13 15:38:28 +01:00
Karsten Dambekalns 3518dba00f
Mention no-slash requirement for getInstallPath() 2020-11-05 15:17:27 +01:00
Jordi Boggiano 55c7b45de0
Add php-only to docs 2020-11-04 22:15:49 +01:00
Paul DelRe 360ecb45b7
Update `self-update` options 2020-11-04 10:35:20 -05:00
Jordi Boggiano da90410181
Fix links 2020-10-30 14:39:37 +01:00
Jordi Boggiano 5d4bcde454
Allow using --locked with the outdated command directly, fixes #8025 2020-10-26 14:47:52 +01:00
Lucas Werkmeister adf27d61e9
Document availability of self-update command
The self-update command is only available when running as a PHAR (see
commit 761ad6d171); notably, it is not defined in the Ubuntu package.
2020-10-26 13:03:24 +01:00
Christophe Coevoet 8ee3e106d8
Fix the current plugin api version in the doc 2020-10-26 12:16:11 +01:00
Guilliam Xavier 54a537e9b3 Docs: Fix sentence after reformulation 2020-10-26 11:56:40 +01:00
Krzysztof Andrzej Sikorski 938d0470f4
Fix link in documentation 2020-10-26 11:35:40 +01:00
Nils Adermann 8627f1cce6
Clear up plugin doc for modifying downloads 2020-10-25 22:32:44 +01:00
Jordi Boggiano 3dfbd9e9e9
Add plugin-modifies-downloads to docs, refs #9339 2020-10-25 22:07:05 +01:00
schramm-michael 996eb563c0
Update authentication-for-private-packages.md
Typo on line 278
changed cosumer... to consumer-key
2020-10-25 19:05:51 +01:00
Jordi Boggiano 3d1e8b6e75
Apply suggestions from code review
Co-authored-by: Nils Adermann <naderman@naderman.de>
2020-10-25 12:50:13 +01:00
Frank Prins c2a2e48ce9 Add information about dev-dependency of composer/composer to plugin article 2020-10-24 21:20:11 +02:00
Jordi Boggiano b1d2842fa7
Add more backticks for consistency 2020-10-24 18:10:57 +02:00
Dan Wallis 4c424ac32d
Use quotes instead of escaping special characters 2020-10-24 14:37:35 +01:00
Dan Wallis a3f9d300f3
Escape special characters in Markdown files 2020-10-24 11:53:20 +01:00
Jordi Boggiano 0d236858ec
Merge branch '1.10' 2020-10-24 09:59:46 +02:00
Nils Adermann b12b50c679 Docs: Remove unnecessary uses of simple/easy
They only serve to make anyone reading the docs who doesn't find
something as simple or easy as stated feel bad about themselves, they
don't add anything valuable to the docs in these cases.
2020-10-23 21:52:05 +02:00
Jordi Boggiano 49a28f606c
Merge branch '1.10' 2020-10-23 10:38:03 +02:00
Michael McMahon d4e818c22f
Setting permissions prevents a warning from swapon
Warning text:
```
/sbin/swapon /var/swap.1
swapon: /var/swap.1: insecure permissions 0644, 0600 suggested.
```
2020-10-22 17:50:35 +00:00
Christophe Coevoet 8e9262f129
Enhance the doc about provide to reduce mistakes 2020-10-22 15:13:01 +02:00
Ruud Kamphuis 0234b13817
Specify unit for `process-timeout` config in docs 2020-10-22 14:43:26 +02:00
Jordi Boggiano a2c1269488
Make linking less verbose 2020-10-14 14:41:29 +02:00
Frank Prins 53b0930287 Move some duplicate documentation, link across multiple pages and clarify some texts 2020-10-13 23:55:17 +02:00
Frank Prins 2c8cbebd85 Update authentication methods in documentation 2020-10-13 23:30:47 +02:00
Jordi Boggiano aac1a25ee3
Merge pull request #9278 from Seldaek/plugin-helpers
Plugin helpers for v2
2020-10-13 15:49:23 +02:00
Jordi Boggiano bafdf9f705
Merge branch '1.10' 2020-10-13 14:47:23 +02:00
Jordi Boggiano d2d606ced2
Merge pull request #9273 from nicolas-grekas/dev-version
Add support for "extra.branch-version"
2020-10-13 14:02:41 +02:00
Nicolas Grekas 893fbfcb89 Add support for "extra.branch-version" 2020-10-13 13:56:18 +02:00
Jordi Boggiano 3c25d180e6
Add detailed notes about events in upgrade guide, add COMPOSER_DEBUG_EVENTS env var for debugging events 2020-10-13 12:08:42 +02:00
Jordi Boggiano 31cf6788e6
Improve plugin docs 2020-10-13 11:05:37 +02:00
Jordi Boggiano e537ae953e
Add apcu prefix flag to docs, refs #9212 2020-10-13 10:22:46 +02:00
Jordi Boggiano 06ab043f7b
Minor fix, refs #9250 2020-10-12 16:12:48 +02:00
Jordi Boggiano 53de100721
Merge pull request #9250 from PrinsFrank/document-authentication-for-private-packages
Document authentication for private packages
2020-10-12 16:10:11 +02:00
Jordi Boggiano 7ab24bec94
Minor updates 2020-10-12 16:09:21 +02:00
Jordi Boggiano 42ee8a7331
Delete http-basic-authentication.md 2020-10-12 15:58:53 +02:00
Jordi Boggiano 9c4b00be67
Add -w/-W to docs, refs #9257 2020-10-12 10:36:12 +02:00
Jordi Boggiano f966de94a9
Merge branch '1.10' 2020-10-12 08:33:39 +02:00
Jordi Boggiano 28fe3baf9c
Disable secure-http automatically when disable-tls is enabled, fixes #9235 2020-10-12 07:57:14 +02:00
Jaroslav Týc 85070c0afd
Fixed a white-space typo
A colon has been wrapped to a next line due to a redundant space.
2020-10-10 12:01:58 +02:00
Frank Prins 5b34a61b4a Capitalize composer name occurrences 2020-10-05 21:13:02 +02:00
Frank Prins 78f9dd73ce Rename handling private packages page to better reflect content 2020-10-05 21:11:16 +02:00
Frank Prins 2afd7e5913 Readded http basic auth page with link to new page so old links don't break 2020-10-05 14:09:58 +02:00