Skip to content

Add guidance on setting homepage in manifest #13293

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

Merged
bors merged 1 commit into from
Jan 14, 2024
Merged

Add guidance on setting homepage in manifest #13293

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions src/doc/src/reference/manifest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,9 +244,13 @@ package.
```toml
[package]
# ...
homepage = "https://serde.rs/"
homepage = "https://serde.rs"

@dtolnay dtolnay Jan 14, 2024

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Deleted trailing slash to match the real serde. https://github.com/serde-rs/serde/blob/v1.0.195/serde/Cargo.toml#L10

```

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
Expand All @@ -255,7 +259,7 @@ package.
```toml
[package]
# ...
repository = "https://github.com/rust-lang/cargo/"
repository = "https://github.com/rust-lang/cargo"

@dtolnay dtolnay Jan 14, 2024

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Deleted trailing slash to match the real cargo.

cargo/Cargo.toml

Line 18 in 92395d9

repository = "https://github.com/rust-lang/cargo"

```

### The `license` and `license-file` fields
Expand Down