Author: stefan2
Date: Sun Jun 26 21:27:04 2011
New Revision: 1139946
URL: http://svn.apache.org/viewvc?rev=1139946&view=rev
Log:
Documentation improvement only.
* subversion/libsvn_fs_fs/fs.h
(fs_fs_data_t): detailed description of packed_offset_cache
* subversion/libsvn_fs_fs/temp_serializer.h
(svn_fs_fs__serialize_manifest, svn_fs_fs__deserialize_manifest,
svn_fs_fs__get_sharded_offset, svn_fs_fs__extract_dir_entry):
improve docstings
Patch by: julianfoad
Modified:
subversion/trunk/subversion/libsvn_fs_fs/fs.h
subversion/trunk/subversion/libsvn_fs_fs/temp_serializer.h
Modified: subversion/trunk/subversion/libsvn_fs_fs/fs.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/libsvn_fs_fs/fs.h?rev=1139946&r1=1139945&r2=1139946&view=diff
==============================================================================
--- subversion/trunk/subversion/libsvn_fs_fs/fs.h (original)
+++ subversion/trunk/subversion/libsvn_fs_fs/fs.h Sun Jun 26 21:27:04 2011
@@ -238,8 +238,10 @@ typedef struct fs_fs_data_t
rep key to svn_string_t. */
svn_cache__t *fulltext_cache;
- /* Pack manifest cache; maps revision numbers to offsets in their respective
- pack files. */
+ /* Pack manifest cache; a cache mapping (svn_revnum_t) shard number to
+ a manifest; and a manifest is a mapping from (svn_revnum_t) revision
+ number offset within a shard to (apr_off_t) byte-offset in the
+ respective pack file. */
svn_cache__t *packed_offset_cache;
/* Cache for txdelta_window_t objects; the key is (revFilePath, offset) */
Modified: subversion/trunk/subversion/libsvn_fs_fs/temp_serializer.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/libsvn_fs_fs/temp_serializer.h?rev=1139946&r1=1139945&r2=1139946&view=diff
==============================================================================
--- subversion/trunk/subversion/libsvn_fs_fs/temp_serializer.h (original)
+++ subversion/trunk/subversion/libsvn_fs_fs/temp_serializer.h Sun Jun 26
21:27:04 2011
@@ -93,8 +93,8 @@ svn_fs_fs__deserialize_txdelta_window(vo
apr_pool_t *pool);
/**
- * Implements #svn_cache__serialize_func_t for manifests
- * (#apr_array_header_t).
+ * Implements #svn_cache__serialize_func_t for a manifest
+ * (@a in is an #apr_array_header_t of apr_off_t elements).
*/
svn_error_t *
svn_fs_fs__serialize_manifest(char **data,
@@ -103,8 +103,8 @@ svn_fs_fs__serialize_manifest(char **dat
apr_pool_t *pool);
/**
- * Implements #svn_cache__deserialize_func_t for manifests
- * (#apr_array_header_t).
+ * Implements #svn_cache__deserialize_func_t for a manifest
+ * (@a *out is an #apr_array_header_t of apr_off_t elements).
*/
svn_error_t *
svn_fs_fs__deserialize_manifest(void **out,
@@ -167,9 +167,9 @@ svn_fs_fs__deserialize_dir_entries(void
apr_pool_t *pool);
/**
- * Implements #svn_cache__partial_getter_func_t for a single element
- * identified by its offset in @a baton within a serialized manifest array.
- */
+ * Implements #svn_cache__partial_getter_func_t. Set (apr_off_t) @a *out
+ * to the element indexed by (apr_int64_t) @a *baton within the
+ * serialized manifest array @a data and @a data_len. */
svn_error_t *
svn_fs_fs__get_sharded_offset(void **out,
const char *data,
@@ -180,7 +180,7 @@ svn_fs_fs__get_sharded_offset(void **out
/**
* Implements #svn_cache__partial_getter_func_t for a single
* #svn_fs_dirent_t within a serialized directory contents hash,
- * identified by its name in @a baton.
+ * identified by its name (const char @a *baton).
*/
svn_error_t *
svn_fs_fs__extract_dir_entry(void **out,
