[llvm-commits] [llvm] r59203 - /llvm/trunk/docs/LangRef.html

[Bill Wendling]

Author: void
Date: Wed Nov 12 19:02:51 2008
New Revision: 59203

URL: http://llvm.org/viewvc/llvm-project?rev=59203&view=rev
Log:
Update docs for ssp and sspreq function attributes.

Modified:
    llvm/trunk/docs/LangRef.html

Modified: llvm/trunk/docs/LangRef.html
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/LangRef.html?rev=59203&r1=59202&r2=59203&view=diff

==============================================================================
--- llvm/trunk/docs/LangRef.html (original)
+++ llvm/trunk/docs/LangRef.html Wed Nov 12 19:02:51 2008
@@ -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"—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>