about summary refs log tree commit diff
diff options
context:
space:
mode:
authorTshepang Mbambo <tshepang@gmail.com>2025-05-10 10:28:33 +0200
committerGitHub <noreply@github.com>2025-05-10 10:28:33 +0200
commit90ec9da857a49f8458d92c555c118adc096a02b0 (patch)
treede6c6d1d65b99840118d6bae950eebc822b36c14
parent6831638f205b9fe99fcca1730768bba74ac795f5 (diff)
parent80758c39ebeded017dd7682d1d8eb5960464ed9d (diff)
downloadrust-90ec9da857a49f8458d92c555c118adc096a02b0.tar.gz
rust-90ec9da857a49f8458d92c555c118adc096a02b0.zip
Merge pull request #2369 from rust-lang/tshepang-patch-1
add rdg push git config entry for git protocol pushers
-rw-r--r--src/doc/rustc-dev-guide/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/doc/rustc-dev-guide/README.md b/src/doc/rustc-dev-guide/README.md
index 08158801788..0425c15f83c 100644
--- a/src/doc/rustc-dev-guide/README.md
+++ b/src/doc/rustc-dev-guide/README.md
@@ -91,6 +91,16 @@ Older versions of `josh-proxy` may not round trip commits losslessly so it is im
 3) Push the branch to your fork and create a PR into `rustc-dev-guide`
 
 ### Push changes from this repository into `rust-lang/rust`
+
+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
     ```
     cargo run --manifest-path josh-sync/Cargo.toml rustc-push <branch-name> <gh-username>