about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authorRoss MacArthur <ross@macarthur.io>2019-12-22 17:21:02 +0200
committerWho? Me?! <mark-i-m@users.noreply.github.com>2019-12-22 17:17:47 -0600
commit6cf400b75f3b18004ad448d40eceabd82f7764ab (patch)
treefe864078b389cf64da263d83b7671d235b0480ff /src/doc/rustc-dev-guide
parent4347a2b9f3602bc37323ab17ba65ef3982a45144 (diff)
downloadrust-6cf400b75f3b18004ad448d40eceabd82f7764ab.tar.gz
rust-6cf400b75f3b18004ad448d40eceabd82f7764ab.zip
Update stability documentation, mention `issue = "none"`
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/src/stability.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/doc/rustc-dev-guide/src/stability.md b/src/doc/rustc-dev-guide/src/stability.md
index 86d2a2e693c..9e75495b1ee 100644
--- a/src/doc/rustc-dev-guide/src/stability.md
+++ b/src/doc/rustc-dev-guide/src/stability.md
@@ -14,6 +14,10 @@ attribute explicitly marks an item as unstable. Items that are marked as
 the crate, even on a nightly compiler. This restriction only applies across
 crate boundaries, unstable items may be used within the crate they are defined.
 
+The `issue` field specifies the associated GitHub [issue number]. This field is
+required and all unstable features should have an associated tracking issue. In
+rare cases where there is no sensible value `issue = "none"` is used.
+
 The `unstable` attribute infects all sub-items, where the attribute doesn't
 have to be reapplied. So if you apply this to a module, all items in the module
 will be unstable.
@@ -33,6 +37,7 @@ future-incompatible deny-by-default lint instead of a hard error. This is used
 by the `bench` attribute which was accidentally accepted in the past. This
 prevents breaking dependencies by leveraging Cargo's lint capping.
 
+[issue number]: https://github.com/rust-lang/rust/issues
 [rustc bug]: https://github.com/rust-lang/rust/issues/15702
 
 ## stable