Skip to content

Commit

Permalink
[src/doc/manifest] Add section on Migrating to gitignore-like patte…
Browse files Browse the repository at this point in the history
…rn matching

Tracking issue: #4268
  • Loading branch information
behnam committed Jul 19, 2017
1 parent ffab519 commit 69c74aa
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions src/doc/manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,20 @@ necessary source files may not be included.

[globs]: http://doc.rust-lang.org/glob/glob/struct.Pattern.html

### Migrating to `gitignore`-like pattern matching

The current interpretation of these configs is based on UNIX Globs, as
implemented in the [`glob` crate](https://crates.io/crates/glob). We want
Cargo's `include` and `exclude` configs to work as similar to `gitignore` as
possible. [The `gitignore` specification](https://git-scm.com/docs/gitignore) is
also based on Globs, but has a bunch of additional features that enable easier
pattern writing and more control. Therefore, we are migrating the interpretation
for the rules of these configs to use the [`ignore`
crate](https://crates.io/crates/ignore), and treat them each rule as a single
line in a `gitignore` file. See [the tracking
issue](https://github.com/rust-lang/cargo/issues/4268) for more details on the
migration.

## The `publish` field (optional)

The `publish` field can be used to prevent a package from being published to a
Expand Down

0 comments on commit 69c74aa

Please sign in to comment.