From b93023b9a3257ca6c4a0bfa37f73bec0a2513699 Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Tue, 11 Jul 2017 19:33:31 +0200 Subject: [PATCH] aft.c: Improve documentation of get_afhi_of_row(). It is not obvious that the function initializes the afh_info structure so that its members point to memory-mapped data. This comment adds some clarifying comments. --- aft.c | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/aft.c b/aft.c index 063e5068..0c4c9328 100644 --- a/aft.c +++ b/aft.c @@ -374,6 +374,7 @@ static void save_afhi(struct afh_info *afhi, char *buf) sprintf(p, "%s", afhi->tags.comment); } +/* does not load the chunk table */ static void load_afhi(const char *buf, struct afh_info *afhi) { afhi->seconds_total = read_u32(buf + AFHI_SECONDS_TOTAL_OFFSET); @@ -590,6 +591,10 @@ static int get_hash_of_row(const struct osl_row *row, unsigned char **hash) * * \return The return value of the underlying call to osl_get_object(). * + * After the call the members of the afhi structure point to mapped memory + * which is owned by the osl table, Hence the caller must not attempt to free + * this memory by calling \ref clear_afhi(). + * * \sa get_chunk_table_of_row(). */ int get_afhi_of_row(const struct osl_row *row, struct afh_info *afhi) -- 2.39.2