about summary refs log tree commit diff
path: root/src/doc/reference.md
diff options
context:
space:
mode:
authorSteve Klabnik <steve@steveklabnik.com>2014-10-27 14:28:04 -0400
committerSteve Klabnik <steve@steveklabnik.com>2014-11-06 10:13:29 -0500
commitd108613ba00edea07ff7e233e3e9c0766132cd3e (patch)
treea6536208d74a327c8df44871d84ff45dea9dd6d3 /src/doc/reference.md
parente2cd4597dae1ed0aa3967bd2a656a42daa1ad27f (diff)
downloadrust-d108613ba00edea07ff7e233e3e9c0766132cd3e.tar.gz
rust-d108613ba00edea07ff7e233e3e9c0766132cd3e.zip
expand description of the link attribute
Fixes #18288
Diffstat (limited to 'src/doc/reference.md')
-rw-r--r--src/doc/reference.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/src/doc/reference.md b/src/doc/reference.md
index 11bf895341b..ee069081881 100644
--- a/src/doc/reference.md
+++ b/src/doc/reference.md
@@ -1957,8 +1957,10 @@ On an `extern` block, the following attributes are interpreted:
   name and type. This is feature gated and the exact behavior is
   implementation-defined (due to variety of linker invocation syntax).
 - `link` - indicate that a native library should be linked to for the
-  declarations in this block to be linked correctly. See [external
-  blocks](#external-blocks)
+  declarations in this block to be linked correctly. `link` supports an optional `kind`
+  key with three possible values: `dylib`, `static`, and `framework`. See [external blocks](#external-blocks) for more about external blocks. Two
+  examples: `#[link(name = "readline")]` and
+  `#[link(name = "CoreFoundation", kind = "framework")]`.
 
 On declarations inside an `extern` block, the following attributes are
 interpreted: