Commit Graph

41 Commits

Author SHA1 Message Date
jofas 7f0ee92330 properly added links to the 'target' glossary entry of the 'cargo tree' and 'cargo metadata' command man pages 2023-01-20 17:41:44 +01:00
Weihang Lo 65332bc9f1
Expand details for `--config` cli arg 2022-09-13 10:25:54 +01:00
Jon Gjengset 7eefb4221f Include --config in cargo help output 2022-06-21 16:24:41 +00:00
Ed Page f728045729 doc: Include `-F` in option lists
The manual change is to `src/doc/man/includes/section-features.md`, the
rest is code-generated.
2022-04-18 19:19:40 -05:00
Steven Joruk cd4e280458 Update docs 2021-12-08 22:18:47 +00:00
hi-rustin 17c0ea7417 Improve the help text of the --quiet args for all commands
Signed-off-by: hi-rustin <rustin.liu@gmail.com>
2021-11-14 20:41:00 +08:00
flip1995 390af27128
Add rust_metadata to SerializedPackage
After the rust_version field was stabilized in #9732 this adds the
rust_version as output to the `cargo metadata` command, so tools like
Clippy can read and use it as well.
2021-10-12 14:07:19 +02:00
hi-rustin 1abc4f2e8a Add test and update docs 2021-06-08 11:28:58 +08:00
bors 329895f5b5 Auto merge of #8994 - jonhoo:manifest-in-local-deps-meta, r=ehuss
metadata: Supply local path for path dependencies

This is potentially a simpler way to address #7483 than #8988.

/cc https://github.com/rust-lang/rustfmt/issues/4247

Fixes #7483.
2021-01-06 00:01:52 +00:00
Eric Huss d087aeb845 Stabilize -Zfeatures and -Zpackage-features. 2020-12-19 08:26:42 -08:00
Jon Gjengset 25671d3495 path is absolute path 2020-12-18 13:39:52 -08:00
Jon Gjengset 525c5b6239 Switch to path and document 2020-12-18 13:12:03 -08:00
ayazhafiz 600e231789 fixup! Publish target's "doc" setting when emitting metadata 2020-11-23 17:05:37 -06:00
Eric Huss 1a86f232c5 Fix man page links inside `option` blocks. 2020-10-17 12:15:12 -07:00
roblabla 26d1a25d93 Add homepage/documentation to cargo-metadata docs 2020-10-01 09:40:32 +00:00
Eric Huss fac70ee775 Update links to rustup docs. 2020-09-26 10:09:04 -07:00
Eric Huss 389c2782cd Remove asciidoc attribute 2020-09-01 10:46:45 -07:00
Eric Huss 2d4aa38b4f Regenerate man pages using mdman. 2020-08-01 11:14:00 -07:00
Oliver Scherer 95b22d2874 Emit the `test` field in cargo metadata 2020-07-30 09:50:46 +02:00
Eric Huss 337fd9f015 Add some help about rustup's +toolchain syntax. 2020-07-06 07:02:12 -07:00
Eric Huss dec7872acf Update metadata man page. 2020-07-04 15:06:58 -07:00
bors ab2b2c0b05 Auto merge of #7927 - ehuss:metadata-docs-clarify, r=alexcrichton
Try to clarify `cargo metadata`'s relationship with the workspace.

Closes #7893
2020-02-26 21:00:00 +00:00
Eric Huss 7551730403 Try to clarify how feature flags work on the "current" package. 2020-02-24 18:01:30 -08:00
Eric Huss 3099685d98 Try to clarify `cargo metadata`'s relationship with the workspace. 2020-02-24 17:58:44 -08:00
Eric Huss bb3f1325a9 Mention that `--features` can be specified multiple times. 2019-12-18 08:28:28 -08:00
Eric Huss b65ebc6f02 Tweak/fix metadata resolve docs.
Due to how markdown works there can't be blank lines in the embedded HTML.
2019-10-28 17:23:36 -07:00
Eric Huss 2fb093b8e3 Bump docs for release version. 2019-10-28 16:55:19 -07:00
Eric Huss a7faecc34f Add kind/platform info to `cargo metadata` 2019-10-28 16:47:09 -07:00
Eric Huss ca02e038bd Add some documentation for --filter-platform. 2019-10-28 14:51:03 -07:00
Eric Huss da3ac84ecf Rebuild docs for rephrase --manifest-path. 2019-10-28 12:09:26 -07:00
Alex Crichton 45699e9f21 Add support for customizing JSON diagnostics from Cargo
Cargo has of #7143 enabled pipelined compilation by default which
affects how the compiler is invoked, especially with respect to JSON
messages. This, in some testing, has proven to cause quite a few issues
with rustbuild's current integration with Cargo. This commit is aimed at
adding features to Cargo to solve this issue.

This commit adds the ability to customize the stream of JSON messages
coming from Cargo. The new feature for Cargo is that it now also mirrors
rustc in how you can configure the JSON stream. Multiple
`--message-format` arguments are now supported and the value specified
is a comma-separated list of directives. In addition to the existing
`human`, `short`, and `json` directives these new directives have been
added:

* `json-render-diagnostics` - instructs Cargo to render rustc
  diagnostics and only print out JSON messages for artifacts and Cargo
  things.

* `json-diagnostic-short` - indicates that the `rendered` field of rustc
  diagnostics should use the "short" rendering.

* `json-diagnostic-rendered-ansi` - indicates that the `rendered` field of rustc
  diagnostics should embed ansi color codes.

The first option here, `json-render-diagnostics`, will be used by
rustbuild unconditionally. Additionally `json-diagnostic-short` will be
conditionally used based on the input to rustbuild itself.

This should be enough for external tools to customize how Cargo is
invoked and how all kinds of JSON diagnostics get printed, and it's
thought that we can relatively easily tweak this as necessary to extend
it and such.
2019-08-05 12:49:51 -07:00
Eric Huss 3105b7d9c9 Document new `doctest` field. 2019-05-20 07:57:11 -07:00
Eric Huss 309eb874fd Stabilize offline mode. 2019-05-12 10:49:45 -07:00
Eric Huss c3f4b0db2d cargo metadata: Don't show `null` deps.
If a package has a dependency without a library target, the "name" field was
showing up as null in `resolve.nodes.deps`. At this time (AFAIK), binary-only
dependencies are always ignored. Instead of making users filter out this entry
(or more commonly, crash), just don't include it.
2019-02-05 08:25:44 -08:00
Dale Wijnand 96269c27b8
Fix run's help message 2019-02-05 14:41:44 +01:00
Eric Huss 53de08a57d Add `links` to `cargo metadata`.
This is needed for creating registry index entries.
2018-12-23 11:34:14 -08:00
Eric Huss 4338d34006 Fix new man page links.
The rustc link checker found some problems:
- The raw generated HTML files were being included when they shouldn't.
  Fixed by moving them out of the mdbook directory.
- The `print.html` file concatenates all the pages together, causing duplicate
  `id`'s.  Fix by giving each page a unique set of IDs.
2018-12-18 12:06:58 -08:00
Eric Huss d931a95b82 New man pages. 2018-12-08 16:44:37 -08:00
Zach Lute 3492a3905c Replace 'project' with 'package' in many strings and comments. 2018-09-20 23:47:09 -07:00
Daniel Albert 1f8b398802 Add --all-features flag to cargo 2016-08-31 19:03:26 +02:00
Panashe M. Fundira cedf7a2c9e
add man page for metadata subcommand 2016-07-25 21:13:54 -04:00