Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Mention forking before cloning the Rust repo #1921

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Mention forking before cloning the Rust repo #1921

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 5 additions & 3 deletions src/building/how-to-build-and-run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ and a bunch of tools (e.g. `rustdoc`, the bootstrapping infrastructure, etc).

[repo]: https://github.com/rust-lang/rust

The very first step to work on `rustc` is to clone the repository:
The very first step to work on `rustc` is to clone the repository.
However, you might consider to fork it first.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This chapter is "How to build and run the compiler" and I'm not sure how it's useful, while I totally agree if some wants to contribute.

See [this chapter on git](../git.md) for more information.

```bash
git clone https://github.com/rust-lang/rust.git
Expand All @@ -39,7 +41,7 @@ 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`.

Expand Down Expand Up @@ -131,7 +133,7 @@ You can install it with `cargo install --path src/tools/x`.

To clarify that this is another global installed binary util, which is
similar to the one declared in section [What is `x.py`](#what-is-xpy), but
it works as an independent process to execute the `x.py` rather than calling the
it works as an independent process to execute the `x.py` rather than calling the
shell to run the platform related scripts.

## Create a `config.toml`
Expand Down