commit a813017b415fd0eb370d137be74c2da1c2b62c9f
author Bill Wendling <isanbard@gmail.com> Thu Nov 13 01:02:51 2008 +0000
committer Bill Wendling <isanbard@gmail.com> Thu Nov 13 01:02:51 2008 +0000
tree b72ca0485643efd3d0afed79479dba9bf76e5ea7
parent ccb67a3d85a227b045b740ce6c39ae169425f060

Update docs for ssp and sspreq function attributes.

llvm-svn: 59203

llvm/docs/LangRef.html

diff --git a/llvm/docs/LangRef.html b/llvm/docs/LangRef.html
index f1869c3..221cc49 100644
--- a/llvm/docs/LangRef.html
+++ b/llvm/docs/LangRef.html
@@ -985,6 +985,18 @@
 be set in the caller.  A readonly function always returns the same value (or
 throws the same exception) when called with the same set of arguments and global
 state.</dd>
+
+<dt><tt><a name="ssp">ssp</a></tt></dt>
+<dd>This attribute indicates that the function should emit a stack smashing
+protector. It is in the form of a "canary"&mdash;a random value placed on the
+stack before the local variables that's checked upon return from the function to
+see if it has been overwritten. A heuristic is used to determine if a function
+needs stack protectors or not.</dd>
+
+<dt><tt>ssp-req</tt></dt>
+<dd>This attribute indicates that the function should <em>always</em> emit a
+stack smashing protector. This overrides the <tt><a href="#ssp">ssp</a></tt>
+function attribute.</dd>
 </dl>
 
 </div>