1
0
Fork 0
Commit Graph

84 Commits (2a13bb2649151932407aae1a37a356179b1f5199)

Author SHA1 Message Date
Tomáš Votruba 10f707e316
basic usage - promote safe version range
I'm aware this just an example, but it [leads readers to see it a best practise](40642df5ec (r29802440)).

Having code with `"php": ">=5.4.0"` is pretty dangerous and will probably break with next major version.

```json
{
    "require": {
        "php": "^5.4"
    }
}
```

```json
{
    "require": {
        "php": "^7.1"
    }
}
```

is much more safer. Promoting best and proven practise should from *Basic usage* helps people to use composer the best way they can.

What do you think?
2018-07-23 18:49:39 +02:00
Jordi Boggiano 945adcf172 Fix doc ambiguity, fixes #7471 2018-07-20 11:38:58 +02:00
Sven Luijten 8f65518ed3 Avoid using 'just' in documentation 2018-03-23 11:37:33 +01:00
Martin Hujer 9bb4cce0b8 Fixes typos in docs 2017-12-29 13:29:13 +01:00
Martin Hujer 58a62dceab Change http to https where possible 2017-12-29 11:37:59 +01:00
Mohamed Chraiet c2815e9df0 Typo correction
Should be repository instead of respository.
2017-08-11 16:33:27 -04:00
Roman Kluth aa784bc1a5 Update 01-basic-usage.md 2017-03-09 12:37:34 +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 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 f1f064981b Add docs about autoloader optimizations, fixes #5947 2017-03-07 12:33:19 +01:00
Jordi Boggiano b3fe9fa1a5 Update example to use psr-4 namespace adding, fixes #6145 2017-02-17 22:17:27 +01:00
Kael Shipman c8c7619a4a Finished reworking docs to clarify points about versioning (fixes #6088) 2017-01-23 13:06:51 -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
Jordi Boggiano c6cc6dd607 Advise the use of absolute paths, fixes #4259 2015-07-21 14:46:38 +01:00
Rob Bast d8d2bcadde added some links and some restructuring 2015-06-30 15:49:00 +02:00
Rob Bast 50db9393e5 better phrasing / structure + moved version testing link 2015-06-30 15:49:00 +02:00
Rob Bast 10b813fc40 reworking basic usage, added versions article 2015-06-30 15:49:00 +02:00
Sam Minnee 5cd1b6d56f Added documentation about -stable suffix in version range comparison. Fixes #4080. 2015-06-30 13:10:16 +01:00
Hannes Van De Vreken 93f73ecc8c Link to semver version constraint tester 2015-04-14 09:21:48 +02:00
Morgan Campbell 7cb9b9a985 Update 01-basic-usage.md
Added a missing "the" so the sentence flows a little better.
2015-03-25 08:32:29 -05:00
findstar 82831bec13 I think 'dump-autoload' command is more proper. 2015-01-28 15:07:44 +09:00
Arfan 70007fee4e Typo edited.
Silly typo edit.
2014-12-21 02:18:29 +05:30
Rob d26f817cfd rewriting some documentation sections 2014-12-13 18:59:14 +01:00
Jordi Boggiano 4a3bc58adf Fix formatting 2014-12-10 15:36:16 +00:00
Jordi Boggiano f363f9d370 Add support for caret (^) operator 2014-12-08 15:39:52 +00:00
Jordi Boggiano ebab9db27a Add support for hyphen ranges 2014-12-08 13:44:42 +00:00
Jordi Boggiano 69ef80124f Add support for capital X in 3.X and || for OR 2014-12-08 12:59:01 +00:00
Jordi Boggiano ca168d478b Spaces are now equivalent to comma in constraints and mean AND 2014-12-07 18:07:29 +00:00
Jordi Boggiano efcdd35cbf Damn 2014-09-30 00:39:21 +01:00
Jordi Boggiano 241627659e Fix formatting bug 2014-09-30 00:38:39 +01:00
Jordi Boggiano 1cbd1a7ba8 Examplify chars and reword, closes #3212 2014-09-30 00:37:28 +01:00
Jordi Boggiano 52308d7db6 Merge pull request #3309 from NAYZO/patch-1
Update 01-basic-usage.md
2014-09-30 00:34:36 +01:00
Ala Eddine Khefifi 03ee649147 Update 01-basic-usage.md 2014-09-29 11:01:02 +01:00
Ala Eddine Khefifi fc986d76c8 Update 01-basic-usage.md 2014-09-29 10:40:29 +01:00
Luis Cordova 1bc6158cd8 note special case for ~1 cases
referenced from https://github.com/symfony/symfony-docs/pull/4267/files#r18030609
2014-09-25 08:27:10 -05:00
Jordi Boggiano 44e25be06d Use inline html to work around parsedown bug, fixes composer/getcomposer.org#68 2014-06-05 09:42:52 +02:00
Jordi Boggiano 0c85ca426d Add code-fences to examples for syntax highlighting 2014-05-19 12:17:07 +02:00
Jordi Boggiano 355dc67038 Tweak wording a bit 2014-03-31 16:33:11 +02:00
Haralan Dobrev aa1745ce2a Specify how ~ constraints handle pre-releases
The "next significant release" a.k.a as the tilde version constraint
would not install a pre-release (alpha, beta, RC) which is not in the same
version namespace.

But in the examples so far it was shown as `~1.2` equals `>=1.2,<2.0` which
would actually install `2.0-beta.1`, because it the pre-release is before
the `2.0` release.

See https://github.com/composer/getcomposer.org/issues/64
2014-03-30 23:33:30 +03:00
Jordi Boggiano 8775a89710 deprecate target-dir and update docs to recommend psr-4, refs #2459 2014-01-03 16:46:56 +01:00
Igor Wiedler 30b5d2f1fc Document logical OR constraints 2013-10-02 12:55:29 +02:00
Igor Wiedler 1c2213ef5d Format the possible version formats as a table
Note I: This syntax is supported by MarkdownExtra, which both getcomposer
and github are using.

Note II: This patch currently breaks the PDF, because pandoc does not like
non-standard markdown tables. Ideas for fixing this appreciated.

Note III: The idea for this patch came up a few weeks ago on IRC. We
agreed back then that a table would be a good idea.

Note IIII: This patch creates a stability section which opens the door for
finally documenting how stability works in the composer docs.
2013-10-02 01:11:53 +02:00
Drak 6c4cee62fe Missing backslashes. 2013-06-06 20:50:43 +02:00