Browse Source

Updated documentation and fixed formatting in Bitbucket Util.

Paul Wenke 9 years ago
parent
commit
d2c5479b2d
3 changed files with 8 additions and 2 deletions
  1. 1 1
      doc/03-cli.md
  2. 6 0
      doc/06-config.md
  3. 1 1
      src/Composer/Util/Bitbucket.php

+ 1 - 1
doc/03-cli.md

@@ -778,7 +778,7 @@ file to be used during SSL/TLS peer verification.
 
 The `COMPOSER_AUTH` var allows you to set up authentication as an environment variable.
 The contents of the variable should be a JSON formatted object containing http-basic,
-github-oauth, ... objects as needed, and following the
+github-oauth, bitbucket-oauth, ... objects as needed, and following the
 [spec from the config](06-config.md#gitlab-oauth).
 
 ### COMPOSER_DISCARD_CHANGES

+ 6 - 0
doc/06-config.md

@@ -81,6 +81,12 @@ downloaded via Composer. If you really absolutely need HTTP access to something
 then you can disable it, but using [Let's Encrypt](https://letsencrypt.org/) to
 get a free SSL certificate is generally a better alternative.
 
+## bitbucket-oauth
+
+A list of domain names and consumers. For example using `{"bitbucket.org":
+{"consumer-key": "myKey", "consumer-secret": "mySecret"}}`. [Read](https://confluence.atlassian.com/bitbucket/oauth-on-bitbucket-cloud-238027431.html)
+how to set up a consumer on Bitbucket.
+
 ## cafile
 
 Location of Certificate Authority file on local filesystem. In PHP 5.6+ you

+ 1 - 1
src/Composer/Util/Bitbucket.php

@@ -91,7 +91,7 @@ class Bitbucket
         } catch (TransportException $e) {
             if (in_array($e->getCode(), array(403, 401))) {
                 $this->io->writeError('<error>Invalid consumer provided.</error>');
-                $this->io->writeError('You can also add it manually later by using "composer config bitbucket-oauth.bitbucket.org <consumerKey> <consumerSecret>"');
+                $this->io->writeError('You can also add it manually later by using "composer config bitbucket-oauth.bitbucket.org <consumer-key> <consumer-secret>"');
 
                 return false;
             }