engine: update cli reference yamldocs for v28.0.1

Signed-off-by: Paweł Gronowski <[email protected]>

Author: vvoland

data/engine-cli/docker_container_restart.yaml

@@ -75,7 +75,7 @@ examples: |-
     ### Stop container with timeout (-t, --timeout) {#timeout}
 
     The `--timeout` flag sets the number of seconds to wait for the container
-    to stop after sending the pre-defined (see [`--signal`]{#signal)) system call signal.
+    to stop after sending the pre-defined (see [`--signal`](#signal)) system call signal.
     If the container does not exit after the timeout elapses, it's forcibly killed
     with a `SIGKILL` signal.
 

data/engine-cli/docker_container_run.yaml

@@ -2318,6 +2318,26 @@ examples: |-
     > $ docker run -it --ulimit as=1024 fedora /bin/bash
     > ```
 
+    #### Supported options for `--ulimit`:
+
+    | Option       | Description                                               |
+    |:-------------|:----------------------------------------------------------|
+    | `core`       | Maximum size of core files created (`RLIMIT_CORE`)        |
+    | `cpu`        | CPU time limit in seconds (`RLIMIT_CPU`)                  |
+    | `data`       | Maximum data segment size (`RLIMIT_DATA`)                 |
+    | `fsize`      | Maximum file size (`RLIMIT_FSIZE`)                        |
+    | `locks`      | Maximum number of file locks (`RLIMIT_LOCKS`)             |
+    | `memlock`    | Maximum locked-in-memory address space (`RLIMIT_MEMLOCK`) |
+    | `msgqueue`   | Maximum bytes in POSIX message queues (`RLIMIT_MSGQUEUE`) |
+    | `nice`       | Maximum nice priority adjustment (`RLIMIT_NICE`)          |
+    | `nofile`     | Maximum number of open file descriptors (`RLIMIT_NOFILE`) |
+    | `nproc`      | Maximum number of processes available (`RLIMIT_NPROC`)    |
+    | `rss`        | Maximum resident set size (`RLIMIT_RSS`)                  |
+    | `rtprio`     | Maximum real-time scheduling priority (`RLIMIT_RTPRIO`)   |
+    | `rttime`     | Maximum real-time execution time (`RLIMIT_RTTIME`)        |
+    | `sigpending` | Maximum number of pending signals (`RLIMIT_SIGPENDING`)   |
+    | `stack`      | Maximum stack size (`RLIMIT_STACK`)                       |
+
     Docker sends the values to the appropriate OS `syscall` and doesn't perform any byte conversion.
     Take this into account when setting the values.
 

data/engine-cli/docker_network_ls.yaml

@@ -39,6 +39,7 @@ options:
       value_type: bool
       default_value: "false"
       description: Do not truncate the output
+      details_url: '#no-trunc'
       deprecated: false
       hidden: false
       experimental: false
@@ -79,6 +80,8 @@ examples: |-
     78b03ee04fc4        multi-host          overlay         swarm
     ```
 
+    ### List networks without truncating the ID column (--no-trun) {#no-trunc}
+
     Use the `--no-trunc` option to display the full network id:
 
     ```console

data/engine-cli/docker_swarm_join-token.yaml

@@ -21,6 +21,7 @@ options:
       value_type: bool
       default_value: "false"
       description: Only display token
+      details_url: '#quiet'
       deprecated: false
       hidden: false
       experimental: false
@@ -31,6 +32,7 @@ options:
       value_type: bool
       default_value: "false"
       description: Rotate join token
+      details_url: '#rotate'
       deprecated: false
       hidden: false
       experimental: false
@@ -97,7 +99,7 @@ examples: |-
     SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-b30ljddcqhef9b9v4rs7mel7t
     ```
 
-    ### `--rotate`
+    ### `--rotate` {#rotate}
 
     Because tokens allow new nodes to join the swarm, you should keep them secret.
     Be particularly careful with manager tokens since they allow new manager nodes
@@ -116,7 +118,7 @@ examples: |-
     using the old token. Rotation does not affect existing nodes in the swarm
     because the join token is only used for authorizing new nodes joining the swarm.
 
-    ### `--quiet`
+    ### `--quiet` {#quiet}
 
     Only print the token. Do not print a complete command for joining.
 deprecated: false

data/engine-cli/docker_swarm_join.yaml

@@ -11,6 +11,7 @@ options:
     - option: advertise-addr
       value_type: string
       description: 'Advertised address (format: `<ip|interface>[:port]`)'
+      details_url: '#advertise-addr'
       deprecated: false
       hidden: false
       experimental: false
@@ -21,6 +22,7 @@ options:
       value_type: string
       default_value: active
       description: Availability of the node (`active`, `pause`, `drain`)
+      details_url: '#availability'
       deprecated: false
       hidden: false
       experimental: false
@@ -31,6 +33,7 @@ options:
       value_type: string
       description: |
         Address or interface to use for data path traffic (format: `<ip|interface>`)
+      details_url: '#data-path-addr'
       deprecated: false
       hidden: false
       min_api_version: "1.31"
@@ -42,6 +45,7 @@ options:
       value_type: node-addr
       default_value: 0.0.0.0:2377
       description: 'Listen address (format: `<ip|interface>[:port]`)'
+      details_url: '#listen-addr'
       deprecated: false
       hidden: false
       experimental: false
@@ -51,6 +55,7 @@ options:
     - option: token
       value_type: string
       description: Token for entry into the swarm
+      details_url: '#token'
       deprecated: false
       hidden: false
       experimental: false
@@ -102,7 +107,7 @@ examples: |-
     dvfxp4zseq4s0rih1selh0d20 *  manager1  Ready   Active        Leader
     ```
 
-    ### `--listen-addr value`
+    ### `--listen-addr value` {#listen-addr}
 
     If the node is a manager, it will listen for inbound swarm manager traffic on this
     address. The default is to listen on 0.0.0.0:2377. It is also possible to specify a
@@ -113,7 +118,7 @@ examples: |-
 
     This flag is generally not necessary when joining an existing swarm.
 
-    ### `--advertise-addr value`
+    ### `--advertise-addr value` {#advertise-addr}
 
     This flag specifies the address that will be advertised to other members of the
     swarm for API access. If unspecified, Docker will check if the system has a
@@ -133,7 +138,7 @@ examples: |-
     ensure the node advertises its IP address and not the IP address of the load
     balancer.
 
-    ### `--data-path-addr`
+    ### `--data-path-addr` {#data-path-addr}
 
     This flag specifies the address that global scope network drivers will publish towards
     other nodes in order to reach the containers running on this node.
@@ -142,11 +147,11 @@ examples: |-
     If unspecified, Docker will use the same IP address or interface that is used for the
     advertise address.
 
-    ### `--token string`
+    ### `--token string` {#token}
 
     Secret value required for nodes to join the swarm
 
-    ### `--availability`
+    ### `--availability` {#availability}
 
     This flag specifies the availability of the node at the time the node joins a master.
     Possible availability values are `active`, `pause`, or `drain`.

data/engine-cli/docker_swarm_unlock-key.yaml

@@ -22,6 +22,7 @@ options:
       value_type: bool
       default_value: "false"
       description: Only display token
+      details_url: '#quiet'
       deprecated: false
       hidden: false
       experimental: false
@@ -32,6 +33,7 @@ options:
       value_type: bool
       default_value: "false"
       description: Rotate unlock key
+      details_url: '#rotate'
       deprecated: false
       hidden: false
       experimental: false
@@ -87,12 +89,12 @@ examples: |-
     SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8
     ```
 
-    ### `--rotate`
+    ### `--rotate` {#rotate}
 
     This flag rotates the unlock key, replacing it with a new randomly-generated
     key. The old unlock key will no longer be accepted.
 
-    ### `--quiet`
+    ### `--quiet` {#quiet}
 
     Only print the unlock key, without instructions.
 deprecated: false