]> git.proxmox.com Git - cargo.git/commitdiff
[doc/book] Drop reference/policies.md and small fixes
authorBehnam Esfahbod <behnam@zwnj.org>
Fri, 1 Sep 2017 22:31:37 +0000 (15:31 -0700)
committerBehnam Esfahbod <behnam@zwnj.org>
Sat, 2 Sep 2017 01:36:23 +0000 (18:36 -0700)
We don't need to put `policies.md` in the book. See
<https://github.com/rust-lang/crates.io/issues/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: <https://github.com/rust-lang/cargo/issues/4040>

src/doc/book/src/SUMMARY.md
src/doc/book/src/favicon.ico [deleted file]
src/doc/book/src/index.md [new file with mode: 0644]
src/doc/book/src/introduction.md [deleted file]
src/doc/book/src/reference/external-tools.md
src/doc/book/src/reference/pkgid-spec.md
src/doc/book/src/reference/policies.md [deleted file]
src/doc/book/theme/favicon.png [new file with mode: 0644]
src/doc/external-tools.md
src/doc/pkgid-spec.md

index 858c64b449fb950f6e929483423521827f6a93f7..ff388e770ecb03105fb3a1b34626801b71236aa0 100644 (file)
@@ -1,6 +1,6 @@
 # Summary
 
-[Introduction](introduction.md)
+[Introduction](index.md)
 
 * [Getting Started](getting-started.md)
     * [Installation](getting-started/installation.md)
@@ -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)
diff --git a/src/doc/book/src/favicon.ico b/src/doc/book/src/favicon.ico
deleted file mode 100644 (file)
index a91ad69..0000000
Binary files a/src/doc/book/src/favicon.ico and /dev/null differ
diff --git a/src/doc/book/src/index.md b/src/doc/book/src/index.md
new file mode 100644 (file)
index 0000000..ddbd8b1
--- /dev/null
@@ -0,0 +1,28 @@
+# The Cargo Manual
+
+![Cargo Logo](images/Cargo-Logo-Small.png)
+
+Cargo is the [Rust] *package manager*. Cargo downloads your Rust project’s
+dependencies, compiles your project, makes packages, and upload them to
+[crates.io], the Rust *package registry*.
+
+
+### Sections
+
+**[Getting Started](getting-started.html)**
+
+To get started with Cargo, install Cargo (and Rust) and set up your first crate.
+
+**[Cargo Guide](guide.html)**
+
+The guide will give you all you need to know about how to use Cargo to develop
+Rust projects.
+
+**[Cargo Reference](reference.html)**
+
+The reference covers the details of various areas of Cargo.
+
+**[Frequently Asked Questions](faq.html)**
+
+[rust]: https://www.rust-lang.org/
+[crates.io]: https://crates.io/
diff --git a/src/doc/book/src/introduction.md b/src/doc/book/src/introduction.md
deleted file mode 100644 (file)
index ddbd8b1..0000000
+++ /dev/null
@@ -1,28 +0,0 @@
-# The Cargo Manual
-
-![Cargo Logo](images/Cargo-Logo-Small.png)
-
-Cargo is the [Rust] *package manager*. Cargo downloads your Rust project’s
-dependencies, compiles your project, makes packages, and upload them to
-[crates.io], the Rust *package registry*.
-
-
-### Sections
-
-**[Getting Started](getting-started.html)**
-
-To get started with Cargo, install Cargo (and Rust) and set up your first crate.
-
-**[Cargo Guide](guide.html)**
-
-The guide will give you all you need to know about how to use Cargo to develop
-Rust projects.
-
-**[Cargo Reference](reference.html)**
-
-The reference covers the details of various areas of Cargo.
-
-**[Frequently Asked Questions](faq.html)**
-
-[rust]: https://www.rust-lang.org/
-[crates.io]: https://crates.io/
index 38ae530b4eee70ec6901377d287459755af11cb3..0ba2c518684eedead8da0fb9d394304f8b850a97 100644 (file)
@@ -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
+* `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.
 
@@ -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
index 6365c397c428860f94a30b7465934c2c8c5c0693..bd7ac2d92dbef03ef2f92e4c5c11d2fbc82b5a54 100644 (file)
@@ -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
 
diff --git a/src/doc/book/src/reference/policies.md b/src/doc/book/src/reference/policies.md
deleted file mode 100644 (file)
index 9d48d09..0000000
+++ /dev/null
@@ -1,70 +0,0 @@
-## Crates.io Package Policies
-
-In general, these policies are guidelines. Problems are often contextual, and
-exceptional circumstances sometimes require exceptional measures. We plan to
-continue to clarify and expand these rules over time as new circumstances
-arise. If your problem is not described below, consider [sending us an email].
-
-### Package Ownership
-
-We have a first-come, first-served policy on crate names. Upon publishing a
-package, the publisher will be made owner of the package on Crates.io.
-
-If someone wants to take over a package, and the previous owner agrees, the
-existing maintainer can add them as an owner, and the new maintainer can remove
-them. If necessary, the team may reach out to inactive maintainers and help
-mediate the process of ownership transfer.
-
-### Removal
-
-Many questions are specialized instances of a more general form: “Under what
-circumstances can a package be removed from Crates.io?”
-
-The short version is that packages are first-come, first-served, and we won’t
-attempt to get into policing what exactly makes a legitimate package. We will
-do what the law requires us to do, and address flagrant violations of the Rust
-Code of Conduct.
-
-### Squatting
-
-We do not have any policies to define 'squatting', and so will not hand over
-ownership of a package for that reason.
-
-### The Law
-
-For issues such as DMCA violations, trademark and copyright infringement,
-Crates.io will respect Mozilla Legal’s decisions with regards to content that
-is hosted.
-
-### Code of Conduct
-
-The Rust project has a [Code of Conduct] which governs appropriate conduct for
-the Rust community. In general, any content on Crates.io that violates the Code
-of Conduct may be removed. Here, content can refer to but is not limited to:
-
-- Package Name
-- Package Metadata
-- Documentation
-- Code
-
-There are two important, related aspects:
-
-- We will not be pro-actively monitoring the site for these kinds of violations,
-  but relying on the community to draw them to our attention.
-- “Does this violate the Code of Conduct” is a contextual question that
-  cannot be directly answered in the hypothetical sense. All of the details
-  must be taken into consideration in these kinds of situations.
-
-# Security
-
-Cargo and crates.io are projects that are governed by the Rust Programming
-Language Team. Safety is one of the core principles of Rust, and to that end,
-we would like to ensure that cargo and crates.io have secure implementations.
-To learn more about disclosing security vulnerabilities, please reference the
-[Rust Security policy] for more details.
-
-Thank you for taking the time to responsibly disclose any issues you find.
-
-[Rust Security policy]: https://www.rust-lang.org/security.html
-[Code of Conduct]: https://www.rust-lang.org/conduct.html
-[sending us an email]: mailto:help@crates.io
diff --git a/src/doc/book/theme/favicon.png b/src/doc/book/theme/favicon.png
new file mode 100644 (file)
index 0000000..a91ad69
Binary files /dev/null and b/src/doc/book/theme/favicon.png differ
index d45e4cf647b5e0aa6ca8c1d037f4dc9262c07dd3..8afb762fe69b4a467b6496d11765f85f147ceb41 100644 (file)
@@ -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
+* `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.
 
@@ -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
index 11522f489214a689502ff3be0a78c3d60ac43997..a2d6a067eab26472c4975dc2c409438cfd8961d9 100644 (file)
@@ -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