summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Oberhollenzer <david.oberhollenzer@sigma-star.at>2020-01-19 17:56:41 +0100
committerDavid Oberhollenzer <david.oberhollenzer@sigma-star.at>2020-01-19 17:56:41 +0100
commite6588526838caece95296b3169ece4f4429816f4 (patch)
treeeaeba7cd7e5d8167fc1fecee7c32e784d1549ef8
parent1a4af498b497bfe1acb40d8aff0c65d9b22b3aa5 (diff)
Update explanation on directory index accounting
Tests with the Debian image (which is generated with squashfs-tools, so should be interpreted as ground truth) have showed that the count is not stored off-by-one. The code was already doing the right thing, but the documentation was wrong. Signed-off-by: David Oberhollenzer <david.oberhollenzer@sigma-star.at>
-rw-r--r--doc/format.txt4
-rw-r--r--include/sqfs/inode.h4
2 files changed, 4 insertions, 4 deletions
diff --git a/doc/format.txt b/doc/format.txt
index 1e059c2..b1d2df5 100644
--- a/doc/format.txt
+++ b/doc/format.txt
@@ -662,8 +662,8 @@
+------+--------------+------------------------------------------------------+
| u32 | parent inode | Same as above. |
+------+--------------+------------------------------------------------------+
- | u16 | index count | One less than the number of directory index entries |
- | | | following the inode structure. |
+ | u16 | index count | The number of directory index entries following the |
+ | | | inode structure. |
+------+--------------+------------------------------------------------------+
| u16 | block offset | Same as above. |
+------+--------------+------------------------------------------------------+
diff --git a/include/sqfs/inode.h b/include/sqfs/inode.h
index f2b6ede..65ff45e 100644
--- a/include/sqfs/inode.h
+++ b/include/sqfs/inode.h
@@ -447,8 +447,8 @@ struct sqfs_inode_dir_ext_t {
/**
* @brief Number of directory index entries following the inode
*
- * This number is stored off-by one and counts the number of
- * @ref sqfs_dir_index_t entries following the inode.
+ * This number counts the number of @ref sqfs_dir_index_t entries
+ * following the inode.
*/
sqfs_u16 inodex_count;