development/cargo
development/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo synced 2024-10-13 03:02:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Auto merge of #13293 - dtolnay-contrib:homepage, r=weihanglo

Browse source 
Add guidance on setting homepage in manifest

Carried over from the Rust API Guidelines: https://rust-lang.github.io/api-guidelines/documentation.html#cargotoml-includes-all-common-metadata-c-metadata

This guidance has been in place since 6.5 years ago (350619f84e).
This commit is contained in:
bors 2024-01-14 17:47:22 +00:00
parent 92395d9010 7ccb4d3a79
commit d530b46da2
1 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/doc/src/reference/manifest.md
View file

@ -244,9 +244,13 @@ package.
```toml
[package]
# ...
homepage = "https://serde.rs/"
homepage = "https://serde.rs"
```
A value should only be set for `homepage` if there is a dedicated website for
the crate other than the source repository or API documentation. Do not make
`homepage` redundant with either the `documentation` or `repository` values.
### The `repository` field
The `repository` field should be a URL to the source repository for your
@ -255,7 +259,7 @@ package.
```toml
[package]
# ...
repository = "https://github.com/rust-lang/cargo/"
repository = "https://github.com/rust-lang/cargo"
```
### The `license` and `license-file` fields