2003-07-21 Andrew Cagney <cagney@redhat.com>

[deliverable/binutils-gdb.git] / libiberty / tmpnam.c

diff --git a/libiberty/tmpnam.c b/libiberty/tmpnam.c
index 8eb77e28c0be3927a889eda972df6390bdfe9cca..406878c49a3eadcac4772f55a4c7bb4bffcbef53 100644 (file)
--- a/libiberty/tmpnam.c
+++ b/libiberty/tmpnam.c
@@ -1,3 +1,17 @@
+/*
+
+@deftypefn Supplemental char* tmpnam (char *@var{s})
+
+This function attempts to create a name for a temporary file, which
+will be a valid file name yet not exist when @code{tmpnam} checks for
+it.  @var{s} must point to a buffer of at least @code{L_tmpnam} bytes,
+or be @code{NULL}.  Use of this function creates a security risk, and it must
+not be used in new projects.  Use @code{mkstemp} instead.
+
+@end deftypefn
+
+*/
+
 #include <stdio.h>
 
 #ifndef L_tmpnam