Browse Source

Clarify how check-platform-reqs works, fixes #8191

Jordi Boggiano 5 years ago
parent
commit
45591597f6
2 changed files with 6 additions and 0 deletions
  1. 4 0
      doc/03-cli.md
  2. 2 0
      src/Composer/Command/CheckPlatformReqsCommand.php

+ 4 - 0
doc/03-cli.md

@@ -259,6 +259,10 @@ match the platform requirements of the installed packages. This can be used
 to verify that a production server has all the extensions needed to run a
 project after installing it for example.
 
+Unlike update/install, this command will ignore config.platform settings and
+check the real platform packages so you can be certain you have the required
+platform dependencies.
+
 ## global
 
 The global command allows you to run other commands like `install`, `remove`, `require`

+ 2 - 0
src/Composer/Command/CheckPlatformReqsCommand.php

@@ -34,6 +34,8 @@ class CheckPlatformReqsCommand extends BaseCommand
                 <<<EOT
 Checks that your PHP and extensions versions match the platform requirements of the installed packages.
 
+Unlike update/install, this command will ignore config.platform settings and check the real platform packages so you can be certain you have the required platform dependencies.
+
 <info>php composer.phar check-platform-reqs</info>
 
 EOT