From e5c86fad5c03a21b6972c3d1a458d89f74cbbf21 Mon Sep 17 00:00:00 2001 From: Jonathan Lebon Date: Wed, 13 Sep 2017 16:05:47 +0000 Subject: [PATCH] lib/commit: add comments to explain dir commit path Add a few comments for each of the central functions used for committing data from a directory. Took me a bit to understand the relationship between those functions. Closes: #1216 Approved by: cgwalters --- src/libostree/ostree-repo-commit.c | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/libostree/ostree-repo-commit.c b/src/libostree/ostree-repo-commit.c index d0f3fa99..fb927605 100644 --- a/src/libostree/ostree-repo-commit.c +++ b/src/libostree/ostree-repo-commit.c @@ -2480,6 +2480,10 @@ write_dfd_iter_to_mtree_internal (OstreeRepo *self, GCancellable *cancellable, GError **error); +/* Given either a dir_enum or a dfd_iter, writes the directory entry to the mtree. For + * subdirs, we go back through either write_dfd_iter_to_mtree_internal (dfd_iter case) or + * write_directory_to_mtree_internal (dir_enum case) which will do the actual dirmeta + + * dirent iteration. */ static gboolean write_directory_content_to_mtree_internal (OstreeRepo *self, OstreeRepoFile *repo_dir, @@ -2632,6 +2636,8 @@ write_directory_content_to_mtree_internal (OstreeRepo *self, return TRUE; } +/* Handles the dirmeta for the given GFile dir and then calls + * write_directory_content_to_mtree_internal() for each directory entry. */ static gboolean write_directory_to_mtree_internal (OstreeRepo *self, GFile *dir, @@ -2729,6 +2735,8 @@ write_directory_to_mtree_internal (OstreeRepo *self, return TRUE; } +/* Handles the dirmeta for the dir described by src_dfd_iter and then calls + * write_directory_content_to_mtree_internal() for each directory entry. */ static gboolean write_dfd_iter_to_mtree_internal (OstreeRepo *self, GLnxDirFdIterator *src_dfd_iter,