Skip to content

Commit

Permalink
Add links to cargo metadata.
Browse files Browse the repository at this point in the history 
This is needed for creating registry index entries.
  • Loading branch information
@ehuss
ehuss committed Dec 23, 2018
1 parent e593efc commit 53de08a
Show file tree
Hide file tree
Showing 6 changed files with 128 additions and 5 deletions.
2 changes: 2 additions & 0 deletions src/cargo/core/package.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ struct SerializedPackage<'a> {
readme: Option<&'a str>,
repository: Option<&'a str>,
edition: &'a str,
links: Option<&'a str>,
#[serde(skip_serializing_if = "Option::is_none")]
metabuild: Option<&'a Vec<String>>,
}
Expand Down Expand Up @@ -120,6 +121,7 @@ impl ser::Serialize for Package {
readme,
repository,
edition: &self.manifest.edition().to_string(),
links: self.manifest.links(),
metabuild: self.manifest.metabuild(),
}
.serialize(s)
Expand Down
6 changes: 5 additions & 1 deletion src/doc/man/cargo-metadata.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,11 @@ The output has the following format:
/* The default edition of the package.
Note that individual targets may have different editions.
*/
"edition": "2018"
"edition": "2018",
/* Optional string that is the name of a native library the package
is linking to.
*/
"links": null,
}
],
/* Array of members of the workspace.
Expand Down
6 changes: 5 additions & 1 deletion src/doc/man/generated/cargo-metadata.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,11 @@ <h2 id="cargo_metadata_output_format">OUTPUT FORMAT</h2>
/* The default edition of the package.
Note that individual targets may have different editions.
*/
"edition": "2018"
"edition": "2018",
/* Optional string that is the name of a native library the package
is linking to.
*/
"links": null,
}
],
/* Array of members of the workspace.
Expand Down
10 changes: 7 additions & 3 deletions src/etc/man/cargo-metadata.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: cargo-metadata
.\" Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 1.5.8
.\" Date: 2018-12-18
.\" Date: 2018-12-23
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "CARGO\-METADATA" "1" "2018-12-18" "\ \&" "\ \&"
.TH "CARGO\-METADATA" "1" "2018-12-23" "\ \&" "\ \&"
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.ss \n[.ss] 0
Expand Down Expand Up @@ -191,7 +191,11 @@ The output has the following format:
/* The default edition of the package.
Note that individual targets may have different editions.
*/
"edition": "2018"
"edition": "2018",
/* Optional string that is the name of a native library the package
is linking to.
*/
"links": null,
}
],
/* Array of members of the workspace.
Expand Down
108 changes: 108 additions & 0 deletions tests/testsuite/metadata.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ fn cargo_metadata_simple() {
"edition": "2015",
"license": null,
"license_file": null,
"links": null,
"description": null,
"readme": null,
"repository": null,
Expand Down Expand Up @@ -116,6 +117,7 @@ crate-type = ["lib", "staticlib"]
"edition": "2015",
"license": null,
"license_file": null,
"links": null,
"description": null,
"targets": [
{
Expand Down Expand Up @@ -195,6 +197,7 @@ optional_feat = []
"edition": "2015",
"license": null,
"license_file": null,
"links": null,
"description": null,
"targets": [
{
Expand Down Expand Up @@ -287,6 +290,7 @@ fn cargo_metadata_with_deps_and_version() {
"keywords": [],
"license": null,
"license_file": null,
"links": null,
"manifest_path": "[..]Cargo.toml",
"metadata": null,
"name": "baz",
Expand Down Expand Up @@ -342,6 +346,7 @@ fn cargo_metadata_with_deps_and_version() {
"keywords": [],
"license": "MIT",
"license_file": null,
"links": null,
"manifest_path": "[..]Cargo.toml",
"metadata": null,
"name": "foo",
Expand Down Expand Up @@ -374,6 +379,7 @@ fn cargo_metadata_with_deps_and_version() {
"keywords": [],
"license": null,
"license_file": null,
"links": null,
"manifest_path": "[..]Cargo.toml",
"metadata": null,
"name": "foobar",
Expand Down Expand Up @@ -418,6 +424,7 @@ fn cargo_metadata_with_deps_and_version() {
"keywords": [],
"license": null,
"license_file": null,
"links": null,
"manifest_path": "[..]Cargo.toml",
"metadata": null,
"name": "bar",
Expand Down Expand Up @@ -533,6 +540,7 @@ name = "ex"
"keywords": [],
"license": null,
"license_file": null,
"links": null,
"description": null,
"edition": "2015",
"source": null,
Expand Down Expand Up @@ -615,6 +623,7 @@ crate-type = ["rlib", "dylib"]
"keywords": [],
"license": null,
"license_file": null,
"links": null,
"description": null,
"edition": "2015",
"source": null,
Expand Down Expand Up @@ -698,6 +707,7 @@ fn workspace_metadata() {
"dependencies": [],
"license": null,
"license_file": null,
"links": null,
"description": null,
"edition": "2015",
"targets": [
Expand Down Expand Up @@ -728,6 +738,7 @@ fn workspace_metadata() {
"dependencies": [],
"license": null,
"license_file": null,
"links": null,
"description": null,
"edition": "2015",
"targets": [
Expand Down Expand Up @@ -806,6 +817,7 @@ fn workspace_metadata_no_deps() {
"dependencies": [],
"license": null,
"license_file": null,
"links": null,
"description": null,
"edition": "2015",
"targets": [
Expand Down Expand Up @@ -836,6 +848,7 @@ fn workspace_metadata_no_deps() {
"dependencies": [],
"license": null,
"license_file": null,
"links": null,
"description": null,
"edition": "2015",
"targets": [
Expand Down Expand Up @@ -893,6 +906,7 @@ const MANIFEST_OUTPUT: &str = r#"
"keywords": [],
"license": null,
"license_file": null,
"links": null,
"description": null,
"edition": "2015",
"targets":[{
Expand Down Expand Up @@ -1070,6 +1084,7 @@ fn package_metadata() {
"edition": "2015",
"license": null,
"license_file": null,
"links": null,
"description": null,
"targets": [
{
Expand Down Expand Up @@ -1137,6 +1152,7 @@ fn cargo_metadata_path_to_cargo_toml_project() {
"keywords": [],
"license": null,
"license_file": null,
"links": null,
"manifest_path": "[..]Cargo.toml",
"metadata": null,
"name": "bar",
Expand Down Expand Up @@ -1218,6 +1234,7 @@ fn package_edition_2018() {
"keywords": [],
"license": null,
"license_file": null,
"links": null,
"manifest_path": "[..]Cargo.toml",
"metadata": null,
"name": "foo",
Expand Down Expand Up @@ -1303,6 +1320,7 @@ fn target_edition_2018() {
"keywords": [],
"license": null,
"license_file": null,
"links": null,
"manifest_path": "[..]Cargo.toml",
"metadata": null,
"name": "foo",
Expand Down Expand Up @@ -1423,6 +1441,7 @@ fn rename_dependency() {
"keywords": [],
"license": null,
"license_file": null,
"links": null,
"manifest_path": "[..]",
"metadata": null,
"name": "foo",
Expand Down Expand Up @@ -1455,6 +1474,7 @@ fn rename_dependency() {
"keywords": [],
"license": null,
"license_file": null,
"links": null,
"manifest_path": "[..]",
"metadata": null,
"name": "bar",
Expand Down Expand Up @@ -1487,6 +1507,7 @@ fn rename_dependency() {
"keywords": [],
"license": null,
"license_file": null,
"links": null,
"manifest_path": "[..]",
"metadata": null,
"name": "bar",
Expand Down Expand Up @@ -1554,3 +1575,90 @@ fn rename_dependency() {
)
.run();
}

#[test]
fn metadata_links() {
let p = project()
.file(
"Cargo.toml",
r#"
[project]
name = "foo"
version = "0.5.0"
links = "a"
"#,
)
.file("src/lib.rs", "")
.file("build.rs", "fn main() {}")
.build();

p.cargo("metadata")
.with_json(r#"
{
"packages": [
{
"authors": [],
"categories": [],
"dependencies": [],
"description": null,
"edition": "2015",
"features": {},
"id": "foo 0.5.0 [..]",
"keywords": [],
"license": null,
"license_file": null,
"links": "a",
"manifest_path": "[..]/foo/Cargo.toml",
"metadata": null,
"name": "foo",
"readme": null,
"repository": null,
"source": null,
"targets": [
{
"crate_types": [
"lib"
],
"edition": "2015",
"kind": [
"lib"
],
"name": "foo",
"src_path": "[..]/foo/src/lib.rs"
},
{
"crate_types": [
"bin"
],
"edition": "2015",
"kind": [
"custom-build"
],
"name": "build-script-build",
"src_path": "[..]/foo/build.rs"
}
],
"version": "0.5.0"
}
],
"resolve": {
"nodes": [
{
"dependencies": [],
"deps": [],
"features": [],
"id": "foo 0.5.0 [..]"
}
],
"root": "foo 0.5.0 [..]"
},
"target_directory": "[..]/foo/target",
"version": 1,
"workspace_members": [
"foo 0.5.0 [..]"
],
"workspace_root": "[..]/foo"
}
"#)
.run()
}
1 change: 1 addition & 0 deletions tests/testsuite/read_manifest.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ static MANIFEST_OUTPUT: &'static str = r#"
"keywords": [],
"license": null,
"license_file": null,
"links": null,
"description": null,
"edition": "2015",
"source":null,
Expand Down

0 comments on commit 53de08a

Please sign in to comment.