opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: escape enum pipe (#11513)

Browse Source
This commit is contained in:
Marcin Tojek
2024-01-09 13:39:38 +00:00
committed by GitHub
parent 525e6e5dc8
commit e5b9d63901
7 changed files with 23 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cli/clibase/values.go
+1 -1
View File
@@ -484,7 +484,7 @@ func (e *Enum) Set(v string) error {
}
func (e *Enum) Type() string {
return fmt.Sprintf("enum[%v]", strings.Join(e.Choices, "|"))
return fmt.Sprintf("enum[%v]", strings.Join(e.Choices, "\\|"))
}
func (e *Enum) String() string {
docs/cli/config-ssh.md
Generated
+2 -2
View File
@@ -93,8 +93,8 @@ Specifies whether or not to keep options from previous run of config-ssh.
### --wait
| | |
| ----------- | ---------------------------------- | --- | ------------ |
| Type | <code>enum[yes | no | auto]</code> |
| ----------- | ---------------------------------- |
| Type | <code>enum[yes\|no\|auto]</code> |
| Environment | <code>$CODER_CONFIGSSH_WAIT</code> |
| Default | <code>auto</code> |
docs/cli/speedtest.md
Generated
+4 -4
View File
@@ -22,10 +22,10 @@ Specifies whether to wait for a direct connection before testing speed.
### --direction
| | |
| ------- | ----------------- | ------------ |
| Type | <code>enum[up | down]</code> |
| Default | <code>down</code> |
| | |
| ------- | --------------------------- |
| Type | <code>enum[up\|down]</code> |
| Default | <code>down</code> |
Specifies whether to run in reverse mode where the client receives and the server sends.
docs/cli/ssh.md
Generated
+5 -5
View File
@@ -87,11 +87,11 @@ Specifies whether to emit SSH output over stdin/stdout.
### --wait
| | |
| ----------- | ---------------------------- | --- | ------------ |
| Type | <code>enum[yes | no | auto]</code> |
| Environment | <code>$CODER_SSH_WAIT</code> |
| Default | <code>auto</code> |
| | |
| ----------- | -------------------------------- |
| Type | <code>enum[yes\|no\|auto]</code> |
| Environment | <code>$CODER_SSH_WAIT</code> |
| Default | <code>auto</code> |
Specifies whether or not to wait for the startup script to finish executing. Auto means that the agent startup script behavior configured in the workspace template is used.
docs/cli/stat_disk.md
Generated
+4 -4
View File
@@ -32,9 +32,9 @@ Path for which to check disk usage.
### --prefix
| | |
| ------- | --------------- | --- | --- | ---------- |
| Type | <code>enum[Ki | Mi | Gi | Ti]</code> |
| Default | <code>Gi</code> |
| | |
| ------- | --------------------------------- |
| Type | <code>enum[Ki\|Mi\|Gi\|Ti]</code> |
| Default | <code>Gi</code> |
SI Prefix for disk measurement.
docs/cli/stat_mem.md
Generated
+4 -4
View File
@@ -31,9 +31,9 @@ Output format. Available formats: text, json.
### --prefix
| | |
| ------- | --------------- | --- | --- | ---------- |
| Type | <code>enum[Ki | Mi | Gi | Ti]</code> |
| Default | <code>Gi</code> |
| | |
| ------- | --------------------------------- |
| Type | <code>enum[Ki\|Mi\|Gi\|Ti]</code> |
| Default | <code>Gi</code> |
SI Prefix for memory measurement.
docs/cli/templates_init.md
Generated
+3 -3
View File
@@ -14,8 +14,8 @@ coder templates init [flags] [directory]
### --id
| | |
| ---- | --------------------------- | --------- | ----------- | ----------- | -------- | ------ | ---------------- | --------- | ---------------- | ----------- | ---------- | -------------------- |
| Type | <code>enum[aws-devcontainer | aws-linux | aws-windows | azure-linux | do-linux | docker | gcp-devcontainer | gcp-linux | gcp-vm-container | gcp-windows | kubernetes | nomad-docker]</code> |
| | |
| ---- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Type | <code>enum[aws-devcontainer\|aws-linux\|aws-windows\|azure-linux\|do-linux\|docker\|gcp-devcontainer\|gcp-linux\|gcp-vm-container\|gcp-windows\|kubernetes\|nomad-docker]</code> |
Specify a given example template by ID.