documentation for cylc config --platform-*

Author: wxtim

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

@@ -177,6 +177,22 @@ View the parsed workflow configuration:
 
          cylc config <name/path>
 
+
+List configured platforms and platform groups
+---------------------------------------------
+
+.. seealso::
+
+   :ref:`ListingAvailablePlatforms`
+
+
+``cylc config --platform-names``
+   Print a list of configured platforms and platform groups.
+
+``cylc config --platform-meta``
+   Print out the full configuration of ``[platfroms]`` and
+   ``[platform groups]``
+
 Opening User Interfaces
 -----------------------
 
@@ -230,7 +246,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,21 @@ 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 available platforms::
+To see the full configuration of available platforms::
 
-   cylc config -i [platforms]
-   cylc config -i [platform groups]
+   cylc config --platform-meta
 
 What Are Platforms?
 -------------------