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

Merge pull request #6955 from carusogabriel/clean-documentation 

Clean up documentation
pull/6964/merge
Jordi Boggiano 2018-01-03 11:54:04 +01:00 committed by GitHub
parent e137fe9b9d 486e580db2
commit 0edc4175a1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
13 changed files with 17 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/03-cli.md
View File

@ -220,7 +220,6 @@ If you do not specify a package, composer will prompt you to search for a packag
Implicitly enables `--optimize-autoloader`. Implicitly enables `--optimize-autoloader`.
* **--apcu-autoloader:** Use APCu to cache found/not-found classes. * **--apcu-autoloader:** Use APCu to cache found/not-found classes.
## remove ## remove
The `remove` command removes packages from the `composer.json` file from The `remove` command removes packages from the `composer.json` file from

1
doc/04-schema.md
View File

@ -356,7 +356,6 @@ Example:
> use and require. Alternatively you may use third party tools to analyze > use and require. Alternatively you may use third party tools to analyze
> your project for the list of extensions used. > your project for the list of extensions used.
#### require #### require
Lists packages required by this package. The package will not be installed Lists packages required by this package. The package will not be installed

3
doc/05-repositories.md
View File

@ -311,7 +311,6 @@ the credentials like this (more info [here](https://getcomposer.org/doc/06-confi
"consumer-secret": "mySecret" "consumer-secret": "mySecret"
} }
} }
} }
} }
``` ```
@ -708,7 +707,7 @@ You can disable the default Packagist.org repository by adding this to your
You can disable Packagist.org globally by using the global config flag: You can disable Packagist.org globally by using the global config flag:
``` ```bash
composer config -g repo.packagist false composer config -g repo.packagist false
``` ```

2
doc/articles/autoloader-optimization.md
View File

@ -53,7 +53,6 @@ result in slow filesystem checks. To solve this issue two Level 2 optimization
options exist, and you can decide to enable either if you have a lot of options exist, and you can decide to enable either if you have a lot of
class_exists checks that are done for classes that do not exist in your project. class_exists checks that are done for classes that do not exist in your project.
## Optimization Level 2/A: Authoritative class maps ## Optimization Level 2/A: Authoritative class maps
### How to run it? ### How to run it?
@ -82,7 +81,6 @@ then you might experience "class not found" issues in production. Enable this wi
> Note: This can not be combined with Level 2/B optimizations. You have to choose one as > Note: This can not be combined with Level 2/B optimizations. You have to choose one as
> they address the same issue in different ways. > they address the same issue in different ways.
## Optimization Level 2/B: APCu cache ## Optimization Level 2/B: APCu cache
### How to run it? ### How to run it?

1
doc/articles/handling-private-packages-with-satis.md
View File

@ -336,7 +336,6 @@ is set to true.
* `notify-batch`: optional, specify a URL that will be called every time a * `notify-batch`: optional, specify a URL that will be called every time a
user installs a package. See [notify-batch]. user installs a package. See [notify-batch].
[ssh2 context options]: https://secure.php.net/manual/en/wrappers.ssh2.php#refsect1-wrappers.ssh2-options [ssh2 context options]: https://secure.php.net/manual/en/wrappers.ssh2.php#refsect1-wrappers.ssh2-options
[ssl context options]: https://secure.php.net/manual/en/context.ssl.php [ssl context options]: https://secure.php.net/manual/en/context.ssl.php
[Twig]: https://twig.sensiolabs.org/ [Twig]: https://twig.sensiolabs.org/

1
doc/articles/scripts.md
View File

@ -15,7 +15,6 @@ the Composer execution process.
> executed. If a dependency of the root package specifies its own scripts, > executed. If a dependency of the root package specifies its own scripts,
> Composer does not execute those additional scripts. > Composer does not execute those additional scripts.
## Event names ## Event names
Composer fires the following named events during its execution process: Composer fires the following named events during its execution process:

10
doc/articles/troubleshooting.md
View File

@ -244,7 +244,7 @@ following workarounds:
On linux, it seems that running this command helps to make ipv4 traffic have a On linux, it seems that running this command helps to make ipv4 traffic have a
higher prio than ipv6, which is a better alternative than disabling ipv6 entirely: higher prio than ipv6, which is a better alternative than disabling ipv6 entirely:
```Bash ```bash
sudo sh -c "echo 'precedence ::ffff:0:0/96 100' >> /etc/gai.conf" sudo sh -c "echo 'precedence ::ffff:0:0/96 100' >> /etc/gai.conf"
``` ```
@ -256,13 +256,13 @@ On windows the only way is to disable ipv6 entirely I am afraid (either in windo
Get name of your network device: Get name of your network device:
``` ```bash
networksetup -listallnetworkservices networksetup -listallnetworkservices
``` ```
Disable IPv6 on that device (in this case "Wi-Fi"): Disable IPv6 on that device (in this case "Wi-Fi"):
``` ```bash
networksetup -setv6off Wi-Fi networksetup -setv6off Wi-Fi
``` ```
@ -270,7 +270,7 @@ Run composer ...
You can enable IPv6 again with: You can enable IPv6 again with:
``` ```bash
networksetup -setv6automatic Wi-Fi networksetup -setv6automatic Wi-Fi
``` ```
@ -288,7 +288,7 @@ The reason for this is a SSH Bug: https://bugzilla.mindrot.org/show_bug.cgi?id=1
As a workaround, open a SSH connection to your Git host before running Composer: As a workaround, open a SSH connection to your Git host before running Composer:
``` ```bash
ssh -t git@mygitserver.tld ssh -t git@mygitserver.tld
composer update composer update
``` ```

5
doc/articles/vendor-binaries.md
View File

@ -13,7 +13,6 @@ If a package contains other scripts that are not needed by the package
users (like build or compile scripts) that code should not be listed users (like build or compile scripts) that code should not be listed
as a vendor binary. as a vendor binary.
## How is it defined? ## How is it defined?
It is defined by adding the `bin` key to a project's `composer.json`. It is defined by adding the `bin` key to a project's `composer.json`.
@ -34,12 +33,10 @@ for any project that **depends** on that project.
This is a convenient way to expose useful scripts that would This is a convenient way to expose useful scripts that would
otherwise be hidden deep in the `vendor/` directory. otherwise be hidden deep in the `vendor/` directory.
## What happens when Composer is run on a composer.json that defines vendor binaries? ## What happens when Composer is run on a composer.json that defines vendor binaries?
For the binaries that a package defines directly, nothing happens. For the binaries that a package defines directly, nothing happens.
## What happens when Composer is run on a composer.json that has dependencies with vendor binaries listed? ## What happens when Composer is run on a composer.json that has dependencies with vendor binaries listed?
Composer looks for the binaries defined in all of the dependencies. A Composer looks for the binaries defined in all of the dependencies. A
@ -75,7 +72,6 @@ In this case, Composer will make `vendor/my-vendor/project-a/bin/project-a-bin`
available as `vendor/bin/project-a-bin`. On a Unix-like platform available as `vendor/bin/project-a-bin`. On a Unix-like platform
this is accomplished by creating a symlink. this is accomplished by creating a symlink.
## What about Windows and .bat files? ## What about Windows and .bat files?
Packages managed entirely by Composer do not *need* to contain any Packages managed entirely by Composer do not *need* to contain any
@ -90,7 +86,6 @@ Packages that need to support workflows that may not include Composer
are welcome to maintain custom `.bat` files. In this case, the package are welcome to maintain custom `.bat` files. In this case, the package
should **not** list the `.bat` file as a binary as it is not needed. should **not** list the `.bat` file as a binary as it is not needed.
## Can vendor binaries be installed somewhere other than vendor/bin? ## Can vendor binaries be installed somewhere other than vendor/bin?
Yes, there are two ways an alternate vendor binary location can be specified: Yes, there are two ways an alternate vendor binary location can be specified:

2
doc/articles/versions.md
View File

@ -201,7 +201,7 @@ setting. All available stability flags are listed on the minimum-stability
section of the [schema page](../04-schema.md#minimum-stability). section of the [schema page](../04-schema.md#minimum-stability).
## Summary ## Summary
``` ```json
"require": { "require": {
"vendor/package": "1.3.2", // exactly 1.3.2 "vendor/package": "1.3.2", // exactly 1.3.2

1
doc/fixtures/fixtures.md
View File

@ -20,4 +20,3 @@ All these repositories contain the following packages.
* `bar/baz` has a 1.0.0 version and 1.0.x-dev as well as dev-default branches. * `bar/baz` has a 1.0.0 version and 1.0.x-dev as well as dev-default branches.
Additionally, 1.1.x-dev is a branch alias for dev-default. Additionally, 1.1.x-dev is a branch alias for dev-default.