about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authorTshepang Mbambo <hopsi@tuta.io>2025-07-21 12:19:20 +0200
committerTshepang Mbambo <hopsi@tuta.io>2025-07-21 12:19:20 +0200
commit4304b7b80ad954643e0477f5e2cbd04e9ed6c79f (patch)
tree8ffdeee6ccc7a7bc7b8fb46dfaafdc419a9d5275 /src/doc/rustc-dev-guide
parent4a45ab5ad4d6955285f79f331e677ecb5cdb60f1 (diff)
add rdg push git config entry for git protocol pushers (again)
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/src/external-repos.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/doc/rustc-dev-guide/src/external-repos.md b/src/doc/rustc-dev-guide/src/external-repos.md
index ecc65b26ab7..667cca317b9 100644
--- a/src/doc/rustc-dev-guide/src/external-repos.md
+++ b/src/doc/rustc-dev-guide/src/external-repos.md
@@ -80,6 +80,16 @@ switch to its repository checkout directory in your terminal).
 
 #### Performing push
 
+> NOTE:
+> If you use Git protocol to push to your fork of `rust-lang/rust`,
+> ensure that you have this entry in your Git config,
+> else the 2 steps that follow would prompt for a username and password:
+>
+> ```
+> [url "git@github.com:"]
+> insteadOf = "https://github.com/"
+> ```
+
 1) Run the push command to create a branch named `<branch-name>` in a `rustc` fork under the `<gh-username>` account
     ```
     rustc-josh-sync push <branch-name> <gh-username>