Bug 41171 - Invalid use of memset

[fontconfig.git] / doc / fcatomic.fncs

diff --git a/doc/fcatomic.fncs b/doc/fcatomic.fncs
index d99a11042cb2078fbccff79422e36560bd83a62a..017756af1b6de9092094f922433d6e618a62348a 100644 (file)
--- a/doc/fcatomic.fncs
+++ b/doc/fcatomic.fncs
@@ -1,21 +1,21 @@
 /*
- * $Id$
+ * fontconfig/doc/fcatomic.fncs
  *
- * Copyright © 2003 Keith Packard
+ * Copyright © 2003 Keith Packard
  *
  * Permission to use, copy, modify, distribute, and sell this software and its
  * documentation for any purpose is hereby granted without fee, provided that
  * the above copyright notice appear in all copies and that both that
  * copyright notice and this permission notice appear in supporting
- * documentation, and that the name of Keith Packard not be used in
+ * documentation, and that the name of the author(s) not be used in
  * advertising or publicity pertaining to distribution of the software without
- * specific, written prior permission.  Keith Packard makes no
+ * specific, written prior permission.  The authors make no
  * representations about the suitability of this software for any purpose.  It
  * is provided "as is" without express or implied warranty.
  *
- * KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
+ * THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
- * EVENT SHALL KEITH PACKARD BE LIABLE FOR ANY SPECIAL, INDIRECT OR
+ * EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
@@ -38,9 +38,9 @@ a consistent and complete file without the need to lock for reading.
 @TYPE1@         FcAtomic *                      @ARG1@          atomic
 @PURPOSE@      lock a file
 @DESC@
-Attempts to lock the file referenced by <parameter>atomic</parameter>.  Returns FcFalse if the
-file is locked by another process, else returns FcTrue and leaves the file
-locked.
+Attempts to lock the file referenced by <parameter>atomic</parameter>.
+Returns FcFalse if the file is already locked, else returns FcTrue and
+leaves the file locked.
 @@
 
 @RET@           FcChar8 *
@@ -57,7 +57,7 @@ by <parameter>atomic</parameter>.
 @TYPE1@         FcAtomic *                      @ARG1@          atomic
 @PURPOSE@      return original file name
 @DESC@
-Returns the file refernced by <parameter>atomic</parameter>.
+Returns the file referenced by <parameter>atomic</parameter>.
 @@
 
 @RET@           FcBool
@@ -65,7 +65,9 @@ Returns the file refernced by <parameter>atomic</parameter>.
 @TYPE1@         FcAtomic *                      @ARG1@          atomic
 @PURPOSE@      replace original with new
 @DESC@
-Replaces the original file referenced by <parameter>atomic</parameter> with the new file.
+Replaces the original file referenced by <parameter>atomic</parameter> with
+the new file. Returns FcFalse if the file cannot be replaced due to
+permission issues in the filesystem. Otherwise returns FcTrue.
 @@
 
 @RET@           void