Skip to content

Commit ff6cbad

Browse files
committed
[doc/book] Drop reference/policies.md and small fixes
We don't need to put `policies.md` in the book. See <rust-lang/crates.io#1030> for more. Renaming `introduction.md` to `index.md` prevents creating two html files (and URL) for one source. The rest are small styling issues. Tracker: <#4040>
1 parent 34c0674 commit ff6cbad

File tree

8 files changed

+25
-94
lines changed

8 files changed

+25
-94
lines changed

src/doc/book/src/SUMMARY.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Summary
22

3-
[Introduction](introduction.md)
3+
[Introduction](index.md)
44

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

3130
* [FAQ](faq.md)
File renamed without changes.

src/doc/book/src/reference/external-tools.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@ One of the goals of Cargo is simple integration with third-party tools, like
44
IDEs and other build systems. To make integration easier, Cargo has several
55
facilities:
66

7-
* `cargo metadata` command, which outputs project structure and dependencies
7+
* a `cargo metadata` command, which outputs project structure and dependencies
88
information in JSON,
99

10-
* `--message-format` flag, which outputs information about a particular build,
10+
* a `--message-format` flag, which outputs information about a particular build,
11+
and
1112

1213
* support for custom subcommands.
1314

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

8788

88-
### Custom subcommands.
89+
### Custom subcommands
8990

9091
Cargo is designed to be extensible with new subcommands without having to modify
9192
Cargo itself. This is achieved by translating a cargo invocation of the form

src/doc/book/src/reference/pkgid-spec.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,14 @@ Here, brackets indicate that the contents are optional.
2727
These could all be references to a package `foo` version `1.2.3` from the
2828
registry at `crates.io`
2929

30-
| pkgid | name | version | url |
31-
|-------------------------------:|:------:|:---------:|:--------------------:|
32-
| `foo` | foo | * | * |
33-
| `foo:1.2.3` | foo | 1.2.3 | * |
34-
| `crates.io/foo` | foo | * | *://crates.io/foo |
35-
| `crates.io/foo#1.2.3` | foo | 1.2.3 | *://crates.io/foo |
36-
| `crates.io/bar#foo:1.2.3` | foo | 1.2.3 | *://crates.io/bar |
37-
| `http://crates.io/foo#1.2.3` | foo | 1.2.3 | http://crates.io/foo |
30+
| pkgid | name | version | url |
31+
|:-----------------------------|:-----:|:-------:|:----------------------:|
32+
| `foo` | `foo` | `*` | `*` |
33+
| `foo:1.2.3` | `foo` | `1.2.3` | `*` |
34+
| `crates.io/foo` | `foo` | `*` | `*://crates.io/foo` |
35+
| `crates.io/foo#1.2.3` | `foo` | `1.2.3` | `*://crates.io/foo` |
36+
| `crates.io/bar#foo:1.2.3` | `foo` | `1.2.3` | `*://crates.io/bar` |
37+
| `http://crates.io/foo#1.2.3` | `foo` | `1.2.3` | `http://crates.io/foo` |
3838

3939
#### Brevity of specifications
4040

src/doc/book/src/reference/policies.md

-70
This file was deleted.
File renamed without changes.

src/doc/external-tools.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@ One of the goals of Cargo is simple integration with third-party tools, like
44
IDEs and other build systems. To make integration easier, Cargo has several
55
facilities:
66

7-
* `cargo metadata` command, which outputs project structure and dependencies
7+
* a `cargo metadata` command, which outputs project structure and dependencies
88
information in JSON,
99

10-
* `--message-format` flag, which outputs information about a particular build,
10+
* a `--message-format` flag, which outputs information about a particular build,
11+
and
1112

1213
* support for custom subcommands.
1314

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

8788

88-
# Custom subcommands.
89+
# Custom subcommands
8990

9091
Cargo is designed to be extensible with new subcommands without having to modify
9192
Cargo itself. This is achieved by translating a cargo invocation of the form

src/doc/pkgid-spec.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,14 @@ Here, brackets indicate that the contents are optional.
2727
These could all be references to a package `foo` version `1.2.3` from the
2828
registry at `crates.io`
2929

30-
| pkgid | name | version | url |
31-
|-------------------------------:|:------:|:---------:|:--------------------:|
32-
| `foo` | foo | * | * |
33-
| `foo:1.2.3` | foo | 1.2.3 | * |
34-
| `crates.io/foo` | foo | * | *://crates.io/foo |
35-
| `crates.io/foo#1.2.3` | foo | 1.2.3 | *://crates.io/foo |
36-
| `crates.io/bar#foo:1.2.3` | foo | 1.2.3 | *://crates.io/bar |
37-
| `http://crates.io/foo#1.2.3` | foo | 1.2.3 | http://crates.io/foo |
30+
| pkgid | name | version | url |
31+
|:-----------------------------|:-----:|:-------:|:----------------------:|
32+
| `foo` | `foo` | `*` | `*` |
33+
| `foo:1.2.3` | `foo` | `1.2.3` | `*` |
34+
| `crates.io/foo` | `foo` | `*` | `*://crates.io/foo` |
35+
| `crates.io/foo#1.2.3` | `foo` | `1.2.3` | `*://crates.io/foo` |
36+
| `crates.io/bar#foo:1.2.3` | `foo` | `1.2.3` | `*://crates.io/bar` |
37+
| `http://crates.io/foo#1.2.3` | `foo` | `1.2.3` | `http://crates.io/foo` |
3838

3939
## Brevity of specifications
4040

0 commit comments

Comments
 (0)