Merge pull request #379 from wxtim/cylc_config_get_platform_information

documentation for cylc config --platform-*

Author: hjoliver

src/7-to-8/cheat-sheet.rst

@@ -232,7 +232,7 @@ Generate a visualisation for a workflow without running it:
      - ::
 
          cylc graph <name>
-         
+
        This generates a basic image file if Graphviz is installed.
 
        The web UI will have full graph vis. in a future release.

src/7-to-8/major-changes/platforms.rst

@@ -69,6 +69,9 @@ a single platform. Such platforms can be set up to be ``platform groups``
 
 .. seealso::
 
+   :ref:`ListingAvailablePlatforms` for details of how to list platforms
+   already defined.
+
    :ref:`AdminGuide.PlatformConfigs` for detailed examples of platform
    configurations.
 

src/reference/config/writing-platform-configs.rst

@@ -13,16 +13,23 @@ Writing Platform Configurations
    - :cylc:conf:`global.cylc[platforms]`
    - :cylc:conf:`global.cylc[platforms][<platform name>]install target`
 
+.. _ListingAvailablePlatforms:
+
+Listing available platforms
+---------------------------
+
 If you are working on an institutional network platforms may already
 have been configured for you.
 
-.. TODO update the command below after implementing a platform
-   listing command.
+To see a list of available platforms::
+
+   cylc config --platform-names
+
+To see the full configuration of available platforms::
 
-To see available platforms::
+   cylc config --platforms
 
-   cylc config -i [platforms]
-   cylc config -i [platform groups]
+This is equivalent to ``cylc config -i 'platforms' -i 'platform groups'``
 
 What Are Platforms?
 -------------------