Add a references to the links key in the manifest docs
authorDale Wijnand <dale.wijnand@gmail.com>
Mon, 9 Apr 2018 20:27:34 +0000 (21:27 +0100)
committerDale Wijnand <dale.wijnand@gmail.com>
Mon, 9 Apr 2018 20:27:34 +0000 (21:27 +0100)
Fixes #4975

src/doc/src/reference/manifest.md

index ebc539dc359dc5a3fb9efe59480a77d4ec40a9ee..334230d422d4c688ae6b1c428a0500db31bcaa0b 100644 (file)
@@ -45,6 +45,21 @@ building native code. More information can be found in the build script
 build = "build.rs"
 ```
 
+#### The `links` field (optional)
+
+This fields specifies the name of a native library that is being linked to.
+More information can be found in the [`links`][links] section of the build
+script guide.
+
+[links]: reference/build-scripts.html#the-links-manifest-key
+
+```toml
+[package]
+# ...
+links = "foo"
+build = "build.rs"
+```
+
 #### The `documentation` field (optional)
 
 This field specifies a URL to a website hosting the crate's documentation.