diff options
| author | Gauvain Pocentek <gauvain@pocentek.net> | 2017-09-07 21:31:03 +0200 |
|---|---|---|
| committer | Gauvain Pocentek <gauvain@pocentek.net> | 2017-09-07 21:31:03 +0200 |
| commit | 60efc83b5a00c733b5fc19fc458674709cd7f9ce (patch) | |
| tree | 2b180a318e6ff9d5729a89dd0a305dac365af3a4 /docs/cli.rst | |
| parent | 0268fc91e9596b8b02c13648ae4ea94ae0540f03 (diff) | |
| download | gitlab-60efc83b5a00c733b5fc19fc458674709cd7f9ce.tar.gz | |
Improve the docs to make v4 a first class citizen
Diffstat (limited to 'docs/cli.rst')
| -rw-r--r-- | docs/cli.rst | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/cli.rst b/docs/cli.rst index 349ee02..e4d3437 100644 --- a/docs/cli.rst +++ b/docs/cli.rst @@ -28,7 +28,8 @@ Content ------- The configuration file uses the ``INI`` format. It contains at least a -``[global]`` section, and a new section for each GitLab server. For example: +``[global]`` section, and a specific section for each GitLab server. For +example: .. code-block:: ini @@ -98,7 +99,7 @@ CLI Objects and actions ------------------- -The ``gitlab`` command expects two mandatory arguments. This first one is the +The ``gitlab`` command expects two mandatory arguments. The first one is the type of object that you want to manipulate. The second is the action that you want to perform. For example: @@ -140,8 +141,8 @@ These options must be defined before the mandatory arguments. Output format. Defaults to a custom format. Can also be ``yaml`` or ``json``. ``--fields``, ``-f`` - Comma-separated list of fields to display (``yaml`` and ``json`` formats - only). If not used, all the object fields are displayed. + Comma-separated list of fields to display (``yaml`` and ``json`` output + formats only). If not used, all the object fields are displayed. Example: |