]> git.lizzy.rs Git - rust.git/commitdiff
Update Docs to use crateid
authorLuis de Bethencourt <luis@debethencourt.com>
Sat, 28 Dec 2013 20:27:22 +0000 (15:27 -0500)
committerLuis de Bethencourt <luis@debethencourt.com>
Sun, 29 Dec 2013 20:25:43 +0000 (15:25 -0500)
doc/rust.md
doc/rustdoc.md
doc/rustpkg.md

index 48a1ea6f6539d261bc5e105e05142c54573ffe82..c9627a87cb03eeb10cde7763756c0752fb6b2a77 100644 (file)
@@ -610,7 +610,7 @@ the behavior of the compiler.
 
 ~~~~
 // Package ID
-#[ pkgid = "projx#2.5" ];
+#[ crate_id = "projx#2.5" ];
 
 // Additional metadata attributes
 #[ desc = "Project X" ];
@@ -776,9 +776,9 @@ as the `ident` provided in the `extern_mod_decl`.
 The external crate is resolved to a specific `soname` at compile time, and a
 runtime linkage requirement to that `soname` is passed to the linker for
 loading at runtime.  The `soname` is resolved at compile time by scanning the
-compiler's library path and matching the optional `pkgid` provided as a string literal
-against the `pkgid` attributes that were declared on the external crate when
-it was compiled.  If no `pkgid` is provided, a default `name` attribute is
+compiler's library path and matching the optional `crateid` provided as a string literal
+against the `crateid` attributes that were declared on the external crate when
+it was compiled.  If no `crateid` is provided, a default `name` attribute is
 assumed, equal to the `ident` given in the `extern_mod_decl`.
 
 Four examples of `extern mod` declarations:
@@ -1729,7 +1729,7 @@ names are effectively reserved. Some significant attributes include:
 * The `cfg` attribute, for conditional-compilation by build-configuration.
 * The `lang` attribute, for custom definitions of traits and functions that are known to the Rust compiler (see [Language items](#language-items)).
 * The `link` attribute, for describing linkage metadata for a extern blocks.
-* The `pkgid` attribute, for describing the package ID of a crate.
+* The `crate_id` attribute, for describing the package ID of a crate.
 * The `test` attribute, for marking functions as unit tests.
 * The `allow`, `warn`, `forbid`, and `deny` attributes, for
   controlling lint checks (see [Lint check attributes](#lint-check-attributes)).
@@ -3792,7 +3792,7 @@ specified then log level 4 is assumed.  Debug messages can be omitted
 by passing `--cfg ndebug` to `rustc`.
 
 As an example, to see all the logs generated by the compiler, you would set
-`RUST_LOG` to `rustc`, which is the crate name (as specified in its `pkgid`
+`RUST_LOG` to `rustc`, which is the crate name (as specified in its `crate_id`
 [attribute](#attributes)). To narrow down the logs to just crate resolution,
 you would set it to `rustc::metadata::creader`. To see just error logging
 use `rustc=0`.
index 39fc03bca0d1ef0e54b6be04522eae86d7674d3f..684c10405354fb19fb7a9a07bb63074747c71215 100644 (file)
@@ -13,7 +13,7 @@ comments":
 ~~~
 // the "link" crate attribute is currently required for rustdoc, but normally
 // isn't needed.
-#[pkgid = "universe"];
+#[crate_id = "universe"];
 #[crate_type="lib"];
 
 //! Tools for dealing with universes (this is a doc comment, and is shown on
index ff413ec1f1b579494b15ec97e74cc1f23ad9b528..f36cbe7153cfe86121aca3c29e6433fb9316fb22 100644 (file)
@@ -90,7 +90,7 @@ then both `bar` and `bar/extras/baz` are valid package identifiers
 in the workspace `foo`.
 
 Because rustpkg uses generic source file names as the main inputs, you will
-need to specify the package identifier in them using the `pkgid` attribute
+need to specify the package identifier in them using the `crate_id` attribute
 on the crate.
 
 ## Source files