Skip to content

Commit

Permalink
Document the new manifest keys
Browse files Browse the repository at this point in the history
  • Loading branch information
alexcrichton committed Oct 27, 2014
1 parent 640487c commit f8acf4e
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 4 deletions.
8 changes: 4 additions & 4 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

33 changes: 33 additions & 0 deletions src/doc/manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,39 @@ the VCS's ignore settings (`.gitignore` for git for example).
exclude = ["build/**/*.o", "doc/**/*.html"]
```

## Package metadata

There are a number of optional metadata fields also accepted under the
`[package]` section:

```toml
[package]
# ...

# A short blurb about the package. This is not rendered in any format when
# uploaded to registries.
description = "..."

# These URLs point to more information about the repository
documentation = "..."
homepage = "..."
repository = "..."

# This points to a file in the repository (relative to this Cargo.toml). The
# contents of this file are stored and indexed in the registry.
readme = "..."

# This is a small list of keywords used to categorize and search for this
# package.
keywords = ["...", "..."]

# This is a string description of the license for this package. Currently
# the registry will validate the license provided against a whitelist of known
# licenses.
license = "..."
```


# The `[dependencies.*]` Sections

You list dependencies using `[dependencies.<name>]`. For example, if you
Expand Down

6 comments on commit f8acf4e

@alexcrichton
Copy link
Member Author

Choose a reason for hiding this comment

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

r=brson

@bors
Copy link
Collaborator

@bors bors commented on f8acf4e Oct 27, 2014

Choose a reason for hiding this comment

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

saw approval from brson
at alexcrichton@f8acf4e

@bors
Copy link
Collaborator

@bors bors commented on f8acf4e Oct 27, 2014

Choose a reason for hiding this comment

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

merging alexcrichton/cargo/registry-fixes = f8acf4e into auto-cargo

@bors
Copy link
Collaborator

@bors bors commented on f8acf4e Oct 27, 2014

Choose a reason for hiding this comment

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

alexcrichton/cargo/registry-fixes = f8acf4e merged ok, testing candidate = 9f081ef

@bors
Copy link
Collaborator

@bors bors commented on f8acf4e Oct 27, 2014

Choose a reason for hiding this comment

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

@bors
Copy link
Collaborator

@bors bors commented on f8acf4e Oct 27, 2014

Choose a reason for hiding this comment

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

fast-forwarding master to auto-cargo = 9f081ef

Please sign in to comment.