Improve comment.
authorBen Pfaff <blp@gnu.org>
Thu, 12 Jan 2006 03:56:54 +0000 (03:56 +0000)
committerBen Pfaff <blp@gnu.org>
Thu, 12 Jan 2006 03:56:54 +0000 (03:56 +0000)
src/file-handle-def.c

index 412c3e7aa8eedc5c7245abde094949102c6cf1fa..f6495786b999f5dd2a7c7ee7840028829e3ad9a6 100644 (file)
@@ -179,6 +179,8 @@ mode_name (const char *mode)
 
    TYPE is the sort of file, e.g. "system file".  Only one given
    type of access is allowed on a given file handle at once.
+   If successful, a reference to TYPE is retained, so it should
+   probably be a string literal.
 
    MODE combines the read or write mode with the sharing mode.
    The first character is 'r' for read, 'w' for write.  The
@@ -190,10 +192,7 @@ mode_name (const char *mode)
    pointer on failure.  For exclusive access modes the void *
    will always be a null pointer at return.  In shared access
    modes the void * will necessarily be null only if no other
-   sharers are active.
-
-   If successful, a reference to type is retained, so it should
-   probably be a string literal. */
+   sharers are active. */
 void **
 fh_open (struct file_handle *h, const char *type, const char *mode) 
 {