From 31359bab86e8fad55a7c0643a9984eb8b3b59d24 Mon Sep 17 00:00:00 2001
From: Bill Wendling <isanbard@gmail.com>
Date: Thu, 13 Nov 2008 01:02:51 +0000
Subject: [PATCH] Update docs for ssp and sspreq function attributes.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@59203 91177308-0d34-0410-b5e6-96231b3b80d8
---
 docs/LangRef.html | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/docs/LangRef.html b/docs/LangRef.html
index f1869c31d96..221cc492ebb 100644
--- a/docs/LangRef.html
+++ b/docs/LangRef.html
@@ -985,6 +985,18 @@ caller functions.  It may dereference pointer arguments and read state that may
 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>
-- 
2.34.1