rust
/
cargo
mirror of https://github.com/rust-lang/cargo
0
0
Fork 0
Code Issues Releases Wiki Activity
7,421 Commits 75 Branches 98 Tags 90 MiB
Commit Graph

51 Commits

Author SHA1 Message Date
Jonathan Claudius 0c3851c017
HTTPS all the things 2019-01-30 15:34:37 -05:00
Dale Wijnand 62c6de381a
Fixup the docs on crate-type 2019-01-28 06:55:53 +00:00
Dale Wijnand 467f878f08
Mention "private" in publish field docs 2019-01-22 10:16:43 +01:00
Eric Huss e2074dfb41 Document `name` and `authors` in [package] 2018-12-16 10:05:52 -08:00
Dale Wijnand 83fc0760d8
Add an array of tables example to the manifest docs 2018-12-07 10:15:29 +01:00
David Laehnemann a472e7c46f docs: requested clarification and word wrap for profiles doc 2018-11-27 10:22:24 +01:00
David Laehnemann 41f788aac2 docs: specify profile usage for cargo test --release 2018-11-26 12:51:19 +01:00
David Laehnemann b606256fec docs: correct profile usage of cargo test --release 2018-11-23 12:07:31 +01:00
Eric Huss d4b5038d06 Fix `globs` link. 2018-10-29 11:10:42 -07:00
Linda_pp 88d5313c8d
Fix typo 2018-10-02 12:00:48 +09:00
Zach Lute 9c8da172cf Revert any project->package changes that would change URLs or anchors for now. 2018-09-21 18:16:53 -07:00
Zach Lute 4a8bd29f98 Replaced 'project' with 'package' in Cargo documentation. 
I tried to make a distinction between places that were talking about Cargo 'projects' vs. a generic concept of a 'project' or a github 'project'.
 2018-09-21 00:09:45 -07:00
Sönke Hahn 57b3e131bb use more common semver terminology for clarity in docs 2018-09-17 20:40:18 -04:00
Alex Crichton 3d0290398a Stabilize `edition` key and add `cargo new --edition` 
This commit stabilizes the `edition` key in `Cargo.toml`, both in the
`[package]` section and inside subtargets. Additionally the `cargo new` and
`cargo init` subcommands have been enhanced with a `--edition` flag to allow
explicitly specifying the edition to be generated.

This commit does not yet change the default edition that's generated.

Closes #5980
 2018-09-06 11:28:10 -07:00
Eric Huss 462eab8285 Fix minor typo in the book. 2018-07-25 22:46:17 -07:00
Rémi Garde a547302e7a Doc: manifest profile.X.debug can be either an u32 or a bool 
Fixes #5734
 2018-07-17 19:02:50 +02:00
Eric Huss ad5d79c9d5 Document opt-level 's' and 'z' stabilized in 1.28. 2018-07-05 16:37:18 -07:00
bors 71006a7732 Auto merge of #5645 - clarcharr:master, r=matklad 
Cargo book: clarify that a maintenance of 'none' shows no badge on crates.io

I recently released a new version of [`bow`](https://crates.io/crates/bow), where I clarified that the crate will stop working in newer versions of Rust and that I have no intention of fixing it. Initially, I set the maintenance badge to "none" because I have no plans to maintain it, when I later realised that this means "badge: none" and not "maintenance: none" and had to release a new version with the badge set to "deprecated."

This seems like a reasonable enough mistake for someone to make, so, I've updated the docs for it.
 2018-06-27 19:10:12 +00:00
Clar Charr 8cdb83881d Clarify that a maintenance of 'none' shows no badge on crates.io 2018-06-21 20:12:54 -04:00
Siddhartha Sahu f0be7a3987
Fix indentation of directory hierarchy 2018-06-15 15:23:12 -04:00
Kornel 59f35af8d1 A more complete example of authors 2018-05-26 16:41:52 +01:00
Eric Huss e881999fb3 Deprecate `doc` profile. 
Fixes #5434
 2018-05-05 08:52:19 -07:00
bors fd3be777a2 Auto merge of #5335 - dwijnand:target-autodiscovery, r=alexcrichton 
Introduce autoXXX keys for target auto-discovery

In Rust 2015 absence of the configuration makes it default to not
include auto-discovered targets (i.e false), with a warnings message.

In Rust 2018 absence makes it default to include auto-discovered
targets (i.e true).

Fixes #5330

---

_original_

Fixes #5330

submitted for early review. feedback very welcome, I'm happy to iterate (and learn).

in particular I require assistance with the borrowing of `warnings` in `clean_benches`.
 2018-04-21 16:10:13 +00:00
Dale Wijnand 107972355f
Drop an old visible doc TODO 
Looks like this originates from
418611304d

But it's even visible in the render docs:
https://doc.rust-lang.org/cargo/reference/manifest.html#package-selection
:-O
 2018-04-21 15:17:24 +01:00
Dale Wijnand e471745e47
Introduce autoXXX keys for target auto-discovery 
In Rust 2015 absence of the configuration makes it default to not
include auto-discovered targets (i.e false), with a warnings message.

In Rust 2018 absence makes it default to include auto-discovered
targets (i.e true).

Fixes #5330
 2018-04-20 20:57:24 +01:00
Dale Wijnand 3fb15acf6d
Add a references to the links key in the manifest docs 
Fixes #4975
 2018-04-09 21:27:34 +01:00
Matthias Krüger e5539627ff Revert "manifest: update default lto for release and bench to 'thin'." 
This reverts commit e74ff4db13.

Turns out I was wrong, sorry for the noise.
 2018-03-22 16:27:14 +01:00
Matthias Krüger e74ff4db13 manifest: update default lto for release and bench to 'thin'. 2018-03-22 12:49:47 +01:00
Matt Brubeck 2c00108de9 Remove old note about pre-1.21 versions 2018-03-15 15:24:09 -07:00
Steven Fackler 0c46ede78c
Update default codegen-units 
It's been 16 since rustc 1.24.
 2018-02-19 14:29:48 -08:00
Matthias Krüger 50d210c058 manifest reference: correct statement: codegen-units=x is not ignored if lto=true. 
Also fix typo along the way.
 2018-02-06 13:27:56 +01:00
Alex Crichton 077feed54c Document string values for LTO 2018-01-31 11:45:26 -08:00
Eric Huss c4d4012d67 Add overflow-checks to reference documentation. 
Fixes #4925.
 2018-01-23 18:23:58 -08:00
E. Dunham fd4f8410cf
Link to crate type docs 
This page (served at https://doc.rust-lang.org/cargo/reference/manifest.html) is the first hit I get when searching "cargo crate-type". The doc which actually explains `crate-type`, https://doc.rust-lang.org/reference/linkage.html, does not appear in the first page of results. I hope that linking the reference doc here will make it easier for others to find instead of having to dig into closed GitHub issues like I did to find it.
 2018-01-21 21:39:27 -08:00
W. Trevor King bc489e255d doc: Replace 'shell' language labels (generally with 'console') 
GitHub uses Linguist for syntax highlighting [1].  Linguist's 'shell'
language is for the *language* [2] (e.g. the contents of a `.sh`
file).  The proper language for a shell session is ShellSession [3],
although in this commit I've used the alias 'console' [4].

The Cargo book uses mdBook (src/doc/README.md), mdBook uses
Highlight.js [5], and Highlight.js also supports 'console' as an alias
for shell sessions [6].

A handful of places where we had been using 'shell' were just command
output, not shell sessions (e.g. they lacked a prompt and command).
In this commit, I've left those without a language label.

[1]: https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
[2]: https://github.com/github/linguist/blob/v5.3.3/lib/linguist/languages.yml#L4208
[3]: https://github.com/github/linguist/blob/v5.3.3/lib/linguist/languages.yml#L4249
[4]: https://github.com/github/linguist/blob/v5.3.3/lib/linguist/languages.yml#L4255
[5]: https://rust-lang-nursery.github.io/mdBook/format/theme/syntax-highlighting.html#syntax-highlighting
[6]: https://github.com/isagalaev/highlight.js/blob/9.12.0/src/languages/shell.js#L10
 2018-01-08 14:48:45 -08:00
bors 93bf2a3c9a Auto merge of #4916 - tari:doc-recovery, r=alexcrichton 
Recover doc changes lost in #4904

Fixes #4906.
 2018-01-08 16:37:05 +00:00
bors daa20af7df Auto merge of #4914 - xftroxgpx:doc_profile_section_in_workspace_only, r=alexcrichton 
doc: [profile.*] sections are for root crate only

ie.
warning: profiles for the non root package will be ignored, specify profiles at the workspace root

rendered:
![untitled2](https://user-images.githubusercontent.com/26243389/34655211-38d7ad18-f406-11e7-9857-76046aa14dea.png)
 2018-01-08 15:49:18 +00:00
Peter Marheine 27d4195d30 Recover non-virtual default-members doc 
First changed in f9a27fc1f7 which failed
to update the book and was replaced in
1271bb4de0.
 2018-01-08 16:29:07 +11:00
Peter Marheine 48b87407e7 Recover docs for workspace.default-members 
First added in 82d563b71b which failed
to update the book and was replaced in
1271bb4de0.
 2018-01-08 16:26:19 +11:00
Peter Marheine 6874929649 Recover implied --all for virtual workspace docs 
First changed in 1240f42c89 which failed
to update the book and was replaced in
1271bb4de0.
 2018-01-08 16:24:23 +11:00
Peter Marheine 97584002bd Recover 'Add missing spaces around = sign' 
First changed in e8a1ba6f63 which failed
to update the book and was replaced in
1271bb4de0.
 2018-01-08 16:22:15 +11:00
Peter Marheine 97555df856 Recover [patch] doc clarifications 
First added in 1700346a9e which failed
to update the book and was replaced in
1271bb4de0.
 2018-01-08 16:21:09 +11:00
Peter Marheine 1208798cf0 Re-fix spelling of 'workspace' 
First fixed in 4848c30414 which failed
to update the book and was replaced in
1271bb4de0.
 2018-01-08 16:11:26 +11:00
Peter Marheine ea42706d2d Recover doc for appveyor project_name 
First added in 53012bd4df which failed
to update the book and was replaced in
1271bb4de0.
 2018-01-08 16:10:09 +11:00
Peter Marheine 999cba1588 Recover doc for inferred directory targets 
First created in 6b94ed2238 and lost by
1271bb4de0.
 2018-01-08 16:02:46 +11:00
Peter Marheine 74b4d0ff4f Recover workspace member clarification from 8139a5d830 
The original failed to update the book and was lost in
1271bb4de0.
 2018-01-08 15:59:59 +11:00
Peter Marheine bfb72c5776 Recover doc for appveyor project ID 
Cherry-picked from f59eb30bbb which failed
to update the book and was replaced in
1271bb4de0.
 2018-01-08 15:57:56 +11:00
Peter Marheine e0b4c582a1 Recover docs for incremental compilation 
Cherry-picked from 45cc30bc73 which failed
to update the book and was replaced in
1271bb4de0.
 2018-01-08 15:35:28 +11:00
xftroxgpx 06a6a40a99 doc: typo "worksapce" -> "workspace" 
occurs twice
 2018-01-08 04:03:16 +01:00
xftroxgpx 2896e3f148 doc: [profile.*] sections are for root crate only 
ie.
warning: profiles for the non root package will be ignored, specify profiles at the workspace root:
 2018-01-07 23:48:52 +01:00