rust
/
cargo
mirror of https://github.com/rust-lang/cargo
0
0
Fork 0
Code Issues Releases Wiki Activity

Use proper git URL for GitHub repos 

It can be seen in the following link that a git repo URL from GitHub should end with ".git":
https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories#about-remote-repositories
This commit is contained in:
Chocobo1 2022-12-12 15:35:42 +08:00
parent 4a8d17e236
commit ce174d4efc
No known key found for this signature in database
GPG Key ID: 210D9C873253A68C
2 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
src/doc/src/reference/overriding-dependencies.md
View File

@ -108,7 +108,7 @@ request is merged you could change your `path` dependency to:
```toml
[patch.crates-io]
uuid = { git = 'https://github.com/uuid-rs/uuid' }
uuid = { git = 'https://github.com/uuid-rs/uuid.git' }
```
[uuid-repository]: https://github.com/uuid-rs/uuid
@ -135,7 +135,7 @@ version = "0.1.0"
uuid = "1.0.1"
[patch.crates-io]
uuid = { git = 'https://github.com/uuid-rs/uuid' }
uuid = { git = 'https://github.com/uuid-rs/uuid.git' }
```
Note that our local dependency on `uuid` has been updated to `1.0.1` as it's
@ -161,7 +161,7 @@ my-library = { git = 'https://example.com/git/my-library' }
uuid = "1.0"
[patch.crates-io]
uuid = { git = 'https://github.com/uuid-rs/uuid' }
uuid = { git = 'https://github.com/uuid-rs/uuid.git' }
```
Remember that `[patch]` is applicable *transitively* but can only be defined at
@ -197,7 +197,7 @@ we've submitted all changes upstream we can update our manifest for
uuid = "2.0"
[patch.crates-io]
uuid = { git = "https://github.com/uuid-rs/uuid", branch = "2.0.0" }
uuid = { git = "https://github.com/uuid-rs/uuid.git", branch = "2.0.0" }
```
And that's it! Like with the previous example the 2.0.0 version doesn't actually
@ -215,7 +215,7 @@ my-library = { git = 'https://example.com/git/my-library' }
uuid = "1.0"
[patch.crates-io]
uuid = { git = 'https://github.com/uuid-rs/uuid', branch = '2.0.0' }
uuid = { git = 'https://github.com/uuid-rs/uuid.git', branch = '2.0.0' }
```
Note that this will actually resolve to two versions of the `uuid` crate. The
@ -234,8 +234,8 @@ configure this we'd do:
```toml
[patch.crates-io]
serde = { git = 'https://github.com/serde-rs/serde' }
serde2 = { git = 'https://github.com/example/serde', package = 'serde', branch = 'v2' }
serde = { git = 'https://github.com/serde-rs/serde.git' }
serde2 = { git = 'https://github.com/example/serde.git', package = 'serde', branch = 'v2' }
```
The first `serde = ...` directive indicates that serde `1.*` should be used
@ -256,14 +256,14 @@ with other copies. The syntax is similar to the
```toml
[patch.crates-io]
foo = { git = 'https://github.com/example/foo' }
foo = { git = 'https://github.com/example/foo.git' }
bar = { path = 'my/local/bar' }
[dependencies.baz]
git = 'https://github.com/example/baz'
git = 'https://github.com/example/baz.git'
[patch.'https://github.com/example/baz']
baz = { git = 'https://github.com/example/patched-baz', branch = 'my-branch' }
baz = { git = 'https://github.com/example/patched-baz.git', branch = 'my-branch' }
```
> **Note**: The `[patch]` table can also be specified as a [configuration
@ -305,7 +305,7 @@ copies. The syntax is similar to the `[dependencies]` section:
```toml
[replace]
"foo:0.1.0" = { git = 'https://github.com/example/foo' }
"foo:0.1.0" = { git = 'https://github.com/example/foo.git' }
"bar:1.0.2" = { path = 'my/local/bar' }
```

8
src/doc/src/reference/specifying-dependencies.md
View File

@ -131,7 +131,7 @@ you need to specify is the location of the repository with the `git` key:
```toml
[dependencies]
regex = { git = "https://github.com/rust-lang/regex" }
regex = { git = "https://github.com/rust-lang/regex.git" }
```
Cargo will fetch the `git` repository at this location then look for a
@ -147,7 +147,7 @@ the latest commit on a branch named `next`:
```toml
[dependencies]
regex = { git = "https://github.com/rust-lang/regex", branch = "next" }
regex = { git = "https://github.com/rust-lang/regex.git", branch = "next" }
```
Anything that is not a branch or tag falls under `rev`. This can be a commit
@ -227,7 +227,7 @@ bitflags = { path = "my-bitflags", version = "1.0" }
# Uses the given git repo when used locally, and uses
# version 1.0 from crates.io when published.
smallvec = { git = "https://github.com/servo/rust-smallvec", version = "1.0" }
smallvec = { git = "https://github.com/servo/rust-smallvec.git", version = "1.0" }
# N.B. that if a version doesn't match, Cargo will fail to compile!
```
@ -417,7 +417,7 @@ version = "0.0.1"
[dependencies]
foo = "0.1"
bar = { git = "https://github.com/example/project", package = "foo" }
bar = { git = "https://github.com/example/project.git", package = "foo" }
baz = { version = "0.1", registry = "custom", package = "foo" }
```