From d6f310d85c7dd458c4ae222465c9efbb094a15d7 Mon Sep 17 00:00:00 2001 From: Thibaut <17176051+ThibautPlg@users.noreply.github.com> Date: Thu, 14 Sep 2023 15:02:27 +0200 Subject: [PATCH 1/2] Rewriting part of the occ group:list documentation to match the actual behaviour Adding the "--info" flag and the correct comments to the occ group:list command. Signed-off-by: Thibaut <17176051+ThibautPlg@users.noreply.github.com> --- admin_manual/occ_command.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/admin_manual/occ_command.rst b/admin_manual/occ_command.rst index 516cf660f..e55192e35 100644 --- a/admin_manual/occ_command.rst +++ b/admin_manual/occ_command.rst @@ -1602,14 +1602,15 @@ removes the existing group "beer":: List configured groups via the ``group:list`` command. The syntax is:: - group:list [-l|--limit] [-o|--offset] [--output="..."] + group:list [-l|--limit [LIMIT]] [-o|--offset [OFFSET]] [-i|--info] [--output [OUTPUT]] -``limit`` allows you to specify the number of groups to retrieve. +``limit`` allows you to specify the number of groups to retrieve. (default 500) ``offset`` is an offset for retrieving groups. -``output`` specifies the output format (plain, json or json_pretty). Default is -plain. +``info`` Show additional info (backend) + +``output`` Output format (plain, json or json_pretty, default is plain) .. _versions_label: From 4cc2ae41cbb6edae3ced4f5a35f8b428ce337311 Mon Sep 17 00:00:00 2001 From: Ferdinand Thiessen Date: Wed, 13 Nov 2024 00:44:13 +0100 Subject: [PATCH 2/2] fix: Add missing rst syntax Co-authored-by: Josh Signed-off-by: Ferdinand Thiessen --- admin_manual/occ_command.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/admin_manual/occ_command.rst b/admin_manual/occ_command.rst index e55192e35..2f6e85427 100644 --- a/admin_manual/occ_command.rst +++ b/admin_manual/occ_command.rst @@ -1604,13 +1604,13 @@ List configured groups via the ``group:list`` command. The syntax is:: group:list [-l|--limit [LIMIT]] [-o|--offset [OFFSET]] [-i|--info] [--output [OUTPUT]] -``limit`` allows you to specify the number of groups to retrieve. (default 500) +``limit`` allows you to specify the number of groups to retrieve (default: ``500``). ``offset`` is an offset for retrieving groups. -``info`` Show additional info (backend) +``info`` Show additional info (backend). -``output`` Output format (plain, json or json_pretty, default is plain) +``output`` Output format: ``plain``, ``json`` or ``json_pretty`` (default: ``plain``). .. _versions_label: