svn commit: r758608 - /commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioConstants.java

[se...@apache.org]

Author: sebb
Date: Thu Mar 26 12:19:30 2009
New Revision: 758608

URL: http://svn.apache.org/viewvc?rev=758608&view=rev
Log:
Found missing descriptions

Modified:
    commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioConstants.java

Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioConstants.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioConstants.java?rev=758608&r1=758607&r2=758608&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioConstants.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioConstants.java Thu Mar 26 12:19:30 2009
@@ -22,6 +22,7 @@
  * All constants needed by CPIO.
  * 
  * based on code from the jRPM project (jrpm.sourceforge.net) 
+ * 
  */
 public interface CpioConstants {
     /** magic number of a cpio entry in the new format */
@@ -57,6 +58,9 @@
     /** Mask for all file type bits. */
     final int S_IFMT = 0170000;
 
+ // http://www.opengroup.org/onlinepubs/9699919799/basedefs/cpio.h.html
+ // has a list of the C_xxx constatnts
+
     /** Defines a directory */
     final int C_ISDIR = 0040000;
 
@@ -114,12 +118,12 @@
     /** Permits others to execute the file or to search the file's directory */
     final int C_IXOTH = 000001;
 
-    /** TODO document */
+    /** Set user ID */
     final int C_ISUID = 004000;
 
-    /** TODO document */
+    /** Set group ID */
     final int C_ISGID = 002000;
 
-    /** TODO document */
+    /** On directories, restricted deletion flag. */
     final int C_ISVTX = 001000;
 }