mirror
/
rustc-dev-guide
mirror of https://github.com/rust-lang/rustc-dev-guide.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

mention `git clone --depth`

This commit is contained in:
y21 2023-04-05 22:44:23 +02:00 committed by jyn
parent 1fd8ddbdc2
commit 42b4a3b105
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
src/building/how-to-build-and-run.md
View File

@ -24,6 +24,27 @@ git clone https://github.com/rust-lang/rust.git
cd rust
```
### Shallow clone the repository
Due to the size of the repository, cloning on a slower internet connection can take a long time.
To sidestep this, you can use the `--depth N` option with the `git clone` command.
This instructs `git` to perform a "shallow clone", cloning the repository but truncating it to the last `N` commits.
Passing `--depth 1` tells `git` to clone the repository but truncate the history to the latest commit
that is on the `master` branch, which is usually fine for browsing the source code or building the compiler.
```bash
git clone --depth 1 https://github.com/rust-lang/rust.git
cd rust
```
> **NOTE**: A shallow clone limits which `git` commands can be run.
> If you intend to work on and contribute to the compiler, it is
> generally recommended to fully clone the repository [as shown above](#get-the-source-code).
>
> For example, `git bisect` and `git blame` require access to the commit history,
> so they don't work if the repository was cloned with `--depth 1`.
## What is `x.py`?
`x.py` is the build tool for the `rust` repository. It can build docs, run tests, and compile the