about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authorJakub Beránek <berykubik@gmail.com>2025-03-10 13:56:42 +0100
committerJakub Beránek <berykubik@gmail.com>2025-03-10 14:07:46 +0100
commitdfef1a7b5ab07617d3c5a595f3764bdcc01ef23e (patch)
tree0b0a0af2ab05149faa8c264fa65572697d05bd39 /src/doc/rustc-dev-guide
parent06d86cd60c59d4fb7b0df30248a0c50fbd96b14b (diff)
downloadrust-dfef1a7b5ab07617d3c5a595f3764bdcc01ef23e.tar.gz
rust-dfef1a7b5ab07617d3c5a595f3764bdcc01ef23e.zip
Handle backticks in try job patterns
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/src/tests/ci.md27
1 files changed, 16 insertions, 11 deletions
diff --git a/src/doc/rustc-dev-guide/src/tests/ci.md b/src/doc/rustc-dev-guide/src/tests/ci.md
index 7fd4c169722..0c0f750a45d 100644
--- a/src/doc/rustc-dev-guide/src/tests/ci.md
+++ b/src/doc/rustc-dev-guide/src/tests/ci.md
@@ -133,29 +133,34 @@ There are several use-cases for try builds:
   Again, a working compiler build is needed for this, which can be produced by
   the [dist-x86_64-linux] CI job.
 - Run a specific CI job (e.g. Windows tests) on a PR, to quickly test if it
-  passes the test suite executed by that job. You can select which CI jobs will
-  be executed in the try build by adding lines containing `try-job:
-  <job patter>` to the PR description. All such specified jobs will be executed
-  in the try build once the `@bors try` command is used on the PR. If no try
-  jobs are specified in this way, the jobs defined in the `try` section of
-  [`jobs.yml`] will be executed by default. Each pattern can either be an exact
-  name of a job or a glob pattern that matches multiple jobs, for example
-  `*msvc*` or `*-alt`. You can start at most 20 jobs in a single try build.
+  passes the test suite executed by that job.
+
+You can select which CI jobs will
+be executed in the try build by adding lines containing `try-job:
+<job pattern>` to the PR description. All such specified jobs will be executed
+in the try build once the `@bors try` command is used on the PR. If no try
+jobs are specified in this way, the jobs defined in the `try` section of
+[`jobs.yml`] will be executed by default.
+
+Each pattern can either be an exact name of a job or a glob pattern that matches multiple jobs,
+for example `*msvc*` or `*-alt`. You can start at most 20 jobs in a single try build. When using
+glob patterns, you might want to wrap them in backticks (`` ` ``) to avoid GitHub rendering
+the pattern as Markdown.
 
 > **Using `try-job` PR description directives**
 >
 > 1. Identify which set of try-jobs you would like to exercise. You can
 >    find the name of the CI jobs in [`jobs.yml`].
 >
-> 2. Amend PR description to include (usually at the end of the PR description)
->    e.g.
+> 2. Amend PR description to include a set of patterns (usually at the end
+>    of the PR description), for example:
 >
 >    ```text
 >    This PR fixes #123456.
 >
 >    try-job: x86_64-msvc
 >    try-job: test-various
->    try-job: *-alt
+>    try-job: `*-alt`
 >    ```
 >
 >    Each `try-job` pattern must be on its own line.