adu.c: Add a comment describing the user table.
authorAndre Noll <maan@systemlinux.org>
Tue, 28 Oct 2008 07:01:25 +0000 (08:01 +0100)
committerAndre Noll <maan@systemlinux.org>
Tue, 28 Oct 2008 07:01:25 +0000 (08:01 +0100)
adu.c

diff --git a/adu.c b/adu.c
index 47eee77..ee4dddb 100644 (file)
--- a/adu.c
+++ b/adu.c
@@ -139,6 +139,15 @@ static struct osl_table_description dir_table_desc = {
        .column_descriptions = dir_table_cols,
 };
 
+/*
+ * The columns of the per-user tables.
+ *
+ * Adu tracks disk usage on a per-user basis. For each user, a user table is
+ * being created. The rows of the user table have three columns: The directory
+ * number that may be resolved to the path using the directory table, the
+ * number of bytes and the number of files in that directory owned by the given
+ * user.
+ */
 static struct osl_column_description user_table_cols[] = {
        [UT_DIR_NUM] = {
                .storage_type = OSL_MAPPED_STORAGE,