From 06da94c61146f60089bda18f65eabbd9972c0f07 Mon Sep 17 00:00:00 2001
From: Kyle Leonhard <leonhard.kyle@gmail.com>
Date: Tue, 12 Nov 2024 07:41:07 -0800
Subject: [PATCH] docs: update channel toolchain syntax

---
 doc/user-guide/src/concepts/toolchains.md                     | 4 +++-
 doc/user-guide/src/overrides.md                               | 4 +++-
 src/cli/help.rs                                               | 4 +++-
 .../cli-ui/rustup/rustup_toolchain_cmd_help_flag_stdout.toml  | 4 +++-
 4 files changed, 12 insertions(+), 4 deletions(-)

diff --git a/doc/user-guide/src/concepts/toolchains.md b/doc/user-guide/src/concepts/toolchains.md
index 2d2ccf2cda..6e6e4c8351 100644
--- a/doc/user-guide/src/concepts/toolchains.md
+++ b/doc/user-guide/src/concepts/toolchains.md
@@ -15,7 +15,9 @@ Standard release channel toolchain names have the following form:
 ```
 <channel>[-<date>][-<host>]
 
-<channel>       = stable|beta|nightly|<major.minor>|<major.minor.patch>
+<channel>       = stable|beta|nightly|<versioned>[-<prerelease>]
+<versioned>     = <major.minor>|<major.minor.patch>
+<prerelease>    = beta[.<number>]
 <date>          = YYYY-MM-DD
 <host>          = <target-triple>
 ```
diff --git a/doc/user-guide/src/overrides.md b/doc/user-guide/src/overrides.md
index 56923652b9..849ed515d2 100644
--- a/doc/user-guide/src/overrides.md
+++ b/doc/user-guide/src/overrides.md
@@ -122,7 +122,9 @@ string in the following form:
 ```
 (<channel>[-<date>])|<custom toolchain name>
 
-<channel>       = stable|beta|nightly|<major.minor.patch>
+<channel>       = stable|beta|nightly|<versioned>[-<prerelease>]
+<versioned>     = <major.minor>|<major.minor.patch>
+<prerelease>    = beta[.<number>]
 <date>          = YYYY-MM-DD
 ```
 
diff --git a/src/cli/help.rs b/src/cli/help.rs
index 683249629c..8c74e21937 100644
--- a/src/cli/help.rs
+++ b/src/cli/help.rs
@@ -55,7 +55,9 @@ pub(crate) static TOOLCHAIN_HELP: &str = r"Discussion:
 
         <channel>[-<date>][-<host>]
 
-        <channel>       = stable|beta|nightly|<major.minor>|<major.minor.patch>
+        <channel>       = stable|beta|nightly|<versioned>[-<prerelease>]
+        <versioned>     = <major.minor>|<major.minor.patch>
+        <prerelease>    = beta[.<number>]
         <date>          = YYYY-MM-DD
         <host>          = <target-triple>
 
diff --git a/tests/suite/cli-ui/rustup/rustup_toolchain_cmd_help_flag_stdout.toml b/tests/suite/cli-ui/rustup/rustup_toolchain_cmd_help_flag_stdout.toml
index 841e8232ea..8ca4e5ae01 100644
--- a/tests/suite/cli-ui/rustup/rustup_toolchain_cmd_help_flag_stdout.toml
+++ b/tests/suite/cli-ui/rustup/rustup_toolchain_cmd_help_flag_stdout.toml
@@ -28,7 +28,9 @@ Discussion:
 
         <channel>[-<date>][-<host>]
 
-        <channel>       = stable|beta|nightly|<major.minor>|<major.minor.patch>
+        <channel>       = stable|beta|nightly|<versioned>[-<prerelease>]
+        <versioned>     = <major.minor>|<major.minor.patch>
+        <prerelease>    = beta[.<number>]
         <date>          = YYYY-MM-DD
         <host>          = <target-triple>