From 471c410c3f64ae411a4d095743ea81a202ab6884 Mon Sep 17 00:00:00 2001 From: Jason Orendorff Date: Fri, 3 Jun 2022 10:32:03 -0500 Subject: [PATCH 1/2] Update manifest.md clearer example --- src/doc/src/reference/manifest.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/doc/src/reference/manifest.md b/src/doc/src/reference/manifest.md index 81ea65ce79a..b32d8531674 100644 --- a/src/doc/src/reference/manifest.md +++ b/src/doc/src/reference/manifest.md @@ -364,7 +364,8 @@ script guide. ```toml [package] # ... -links = "foo" +# this package links with a native library called "git2", e.g. "libgit2.a" on Linux +links = "git2" ``` From c586652fdfaa5e109ae8d5bc2ce3e14f033614e6 Mon Sep 17 00:00:00 2001 From: Jason Orendorff Date: Mon, 6 Jun 2022 11:55:47 -0500 Subject: [PATCH 2/2] Update manifest.md Remove comment from example toml to prose. --- src/doc/src/reference/manifest.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/doc/src/reference/manifest.md b/src/doc/src/reference/manifest.md index b32d8531674..e239042dcfc 100644 --- a/src/doc/src/reference/manifest.md +++ b/src/doc/src/reference/manifest.md @@ -361,10 +361,12 @@ script guide. [links]: build-scripts.md#the-links-manifest-key +For example, a crate that links a native library called "git2" (e.g. `libgit2.a` +on Linux) may specify: + ```toml [package] # ... -# this package links with a native library called "git2", e.g. "libgit2.a" on Linux links = "git2" ```