Skip to content

[doc/book] Drop reference/policies.md and small fixes #4462

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.

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
merged 1 commit into from
Sep 2, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 1 addition & 2 deletions src/doc/book/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Summary

[Introduction](introduction.md)
[Introduction](index.md)

* [Getting Started](getting-started.md)
* [Installation](getting-started/installation.md)
Expand All @@ -26,6 +26,5 @@
* [Package ID Specifications](reference/pkgid-spec.md)
* [Source Replacement](reference/source-replacement.md)
* [External Tools](reference/external-tools.md)
* [Crates.io Package Policies](reference/policies.md)

* [FAQ](faq.md)
File renamed without changes.
7 changes: 4 additions & 3 deletions src/doc/book/src/reference/external-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ One of the goals of Cargo is simple integration with third-party tools, like
IDEs and other build systems. To make integration easier, Cargo has several
facilities:

* `cargo metadata` command, which outputs project structure and dependencies
* a `cargo metadata` command, which outputs project structure and dependencies
information in JSON,

* `--message-format` flag, which outputs information about a particular build,
* a `--message-format` flag, which outputs information about a particular build,
and

* support for custom subcommands.

Expand Down Expand Up @@ -85,7 +86,7 @@ Information about dependencies in the Makefile-compatible format is stored in
the `.d` files alongside the artifacts.


### Custom subcommands.
### Custom subcommands

Cargo is designed to be extensible with new subcommands without having to modify
Cargo itself. This is achieved by translating a cargo invocation of the form
Expand Down
16 changes: 8 additions & 8 deletions src/doc/book/src/reference/pkgid-spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,14 @@ Here, brackets indicate that the contents are optional.
These could all be references to a package `foo` version `1.2.3` from the
registry at `crates.io`

| pkgid | name | version | url |
|-------------------------------:|:------:|:---------:|:--------------------:|
| `foo` | foo | * | * |
| `foo:1.2.3` | foo | 1.2.3 | * |
| `crates.io/foo` | foo | * | *://crates.io/foo |
| `crates.io/foo#1.2.3` | foo | 1.2.3 | *://crates.io/foo |
| `crates.io/bar#foo:1.2.3` | foo | 1.2.3 | *://crates.io/bar |
| `http://crates.io/foo#1.2.3` | foo | 1.2.3 | http://crates.io/foo |
| pkgid | name | version | url |
|:-----------------------------|:-----:|:-------:|:----------------------:|
| `foo` | `foo` | `*` | `*` |
| `foo:1.2.3` | `foo` | `1.2.3` | `*` |
| `crates.io/foo` | `foo` | `*` | `*://crates.io/foo` |
| `crates.io/foo#1.2.3` | `foo` | `1.2.3` | `*://crates.io/foo` |
| `crates.io/bar#foo:1.2.3` | `foo` | `1.2.3` | `*://crates.io/bar` |
| `http://crates.io/foo#1.2.3` | `foo` | `1.2.3` | `http://crates.io/foo` |

#### Brevity of specifications

Expand Down
70 changes: 0 additions & 70 deletions src/doc/book/src/reference/policies.md

This file was deleted.

File renamed without changes
7 changes: 4 additions & 3 deletions src/doc/external-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ One of the goals of Cargo is simple integration with third-party tools, like
IDEs and other build systems. To make integration easier, Cargo has several
facilities:

* `cargo metadata` command, which outputs project structure and dependencies
* a `cargo metadata` command, which outputs project structure and dependencies
information in JSON,

* `--message-format` flag, which outputs information about a particular build,
* a `--message-format` flag, which outputs information about a particular build,
and

* support for custom subcommands.

Expand Down Expand Up @@ -85,7 +86,7 @@ Information about dependencies in the Makefile-compatible format is stored in
the `.d` files alongside the artifacts.


# Custom subcommands.
# Custom subcommands

Cargo is designed to be extensible with new subcommands without having to modify
Cargo itself. This is achieved by translating a cargo invocation of the form
Expand Down
16 changes: 8 additions & 8 deletions src/doc/pkgid-spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,14 @@ Here, brackets indicate that the contents are optional.
These could all be references to a package `foo` version `1.2.3` from the
registry at `crates.io`

| pkgid | name | version | url |
|-------------------------------:|:------:|:---------:|:--------------------:|
| `foo` | foo | * | * |
| `foo:1.2.3` | foo | 1.2.3 | * |
| `crates.io/foo` | foo | * | *://crates.io/foo |
| `crates.io/foo#1.2.3` | foo | 1.2.3 | *://crates.io/foo |
| `crates.io/bar#foo:1.2.3` | foo | 1.2.3 | *://crates.io/bar |
| `http://crates.io/foo#1.2.3` | foo | 1.2.3 | http://crates.io/foo |
| pkgid | name | version | url |
|:-----------------------------|:-----:|:-------:|:----------------------:|
| `foo` | `foo` | `*` | `*` |
| `foo:1.2.3` | `foo` | `1.2.3` | `*` |
| `crates.io/foo` | `foo` | `*` | `*://crates.io/foo` |
| `crates.io/foo#1.2.3` | `foo` | `1.2.3` | `*://crates.io/foo` |
| `crates.io/bar#foo:1.2.3` | `foo` | `1.2.3` | `*://crates.io/bar` |
| `http://crates.io/foo#1.2.3` | `foo` | `1.2.3` | `http://crates.io/foo` |

## Brevity of specifications

Expand Down