Skip to content

Commit

Permalink
Auto merge of #12251 - c-git:patch-1, r=weihanglo
Browse files Browse the repository at this point in the history
docs: clarify the use of `default` branch instead of `main` by default

Update specifying-dependencies.md to show not specifying the branch for git doesn't always use the main branch.
  • Loading branch information
bors committed Jun 13, 2023
2 parents 56bb8c4 + 89ca816 commit 000868e
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/doc/src/reference/specifying-dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,8 @@ Cargo will fetch the `git` repository at this location then look for a
of a workspace and setting `git` to the repository containing the workspace).

Since we haven’t specified any other information, Cargo assumes that
we intend to use the latest commit on the main branch to build our package.
we intend to use the latest commit on the default branch branch
to build our package, which may not necessarily be the main branch.
You can combine the `git` key with the `rev`, `tag`, or `branch` keys to
specify something else. Here's an example of specifying that you want to use
the latest commit on a branch named `next`:
Expand Down

0 comments on commit 000868e

Please sign in to comment.