Add some comments to clear up some of the fields to windows' ap_file_t.

git-svn-id: http://svn.apache.org/repos/asf/apr/apr/trunk@59573 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 15 insertions, 3 deletions

diff --git a/file_io/win32/fileio.h b/file_io/win32/fileio.h
index 59c1bc344..2f7d2297c 100644
--- a/file_io/win32/fileio.h
+++ b/file_io/win32/fileio.h
@@ -83,16 +83,28 @@
 #include "apr_file_io.h"
 #include "apr_errno.h"
 
+/* quick run-down of fields in windows' ap_file_t structure that may have 
+ * obvious uses.
+ * fname --  the filename as passed to the open call.
+ * dwFileAttricutes -- Attributes used to open the file.
+ * demonfname -- the canonicalized filename.  Used to store the result from
+ *               ap_os_canonicalize_filename.
+ * lowerdemonfname -- inserted at Ken Parzygnat's request, because of the
+ *                    ugly way windows deals with case in the filesystem.
+ * append -- Windows doesn't support the append concept when opening files.
+ *           APR needs to keep track of this, and always make sure we append
+ *           correctly when writing to a file with this flag set TRUE.
+ *          
 struct file_t {
     ap_context_t *cntxt;
     HANDLE filehand;
     char *fname;
     DWORD dwFileAttributes;
-    char *demonfname; /* Is this necessary */
-    char *lowerdemonfname; /* Is this necessary */
+    char *demonfname; 
+    char *lowerdemonfname; 
     int buffered;
     int stated;
-    int append; /* is this necessary?*/
+    int append; 
     int eof_hit;
     off_t size;
     time_t atime;