summaryrefslogtreecommitdiff
path: root/include/git2/sys/mempack.h
diff options
context:
space:
mode:
authorPatrick Steinhardt <ps@pks.im>2018-06-01 13:17:28 +0200
committerGitHub <noreply@github.com>2018-06-01 13:17:28 +0200
commitbae6ed62010508c2e2b0559f9eee41e62e52eb7a (patch)
treefeec56cfeb1a259319743317ddce61e4fa787329 /include/git2/sys/mempack.h
parent771dfd1dd1c27a4693dfdfea521c07e72f456b29 (diff)
parent04c48afc3c2f3413883afee70ea748374e0a2293 (diff)
downloadlibgit2-bae6ed62010508c2e2b0559f9eee41e62e52eb7a.tar.gz
Merge pull request #4530 from tiennou/fix/docurium-missing-includes
Fix docurium missing includes
Diffstat (limited to 'include/git2/sys/mempack.h')
-rw-r--r--include/git2/sys/mempack.h70
1 files changed, 35 insertions, 35 deletions
diff --git a/include/git2/sys/mempack.h b/include/git2/sys/mempack.h
index 490636b44..63fb38dc8 100644
--- a/include/git2/sys/mempack.h
+++ b/include/git2/sys/mempack.h
@@ -23,61 +23,61 @@
GIT_BEGIN_DECL
/**
- * Instantiate a new mempack backend.
+ * Instantiate a new mempack backend.
*
- * The backend must be added to an existing ODB with the highest
- * priority.
+ * The backend must be added to an existing ODB with the highest
+ * priority.
*
- * git_mempack_new(&mempacker);
- * git_repository_odb(&odb, repository);
- * git_odb_add_backend(odb, mempacker, 999);
+ * git_mempack_new(&mempacker);
+ * git_repository_odb(&odb, repository);
+ * git_odb_add_backend(odb, mempacker, 999);
*
- * Once the backend has been loaded, all writes to the ODB will
- * instead be queued in memory, and can be finalized with
- * `git_mempack_dump`.
+ * Once the backend has been loaded, all writes to the ODB will
+ * instead be queued in memory, and can be finalized with
+ * `git_mempack_dump`.
*
- * Subsequent reads will also be served from the in-memory store
- * to ensure consistency, until the memory store is dumped.
+ * Subsequent reads will also be served from the in-memory store
+ * to ensure consistency, until the memory store is dumped.
*
- * @param out Pointer where to store the ODB backend
- * @return 0 on success; error code otherwise
+ * @param out Pointer where to store the ODB backend
+ * @return 0 on success; error code otherwise
*/
GIT_EXTERN(int) git_mempack_new(git_odb_backend **out);
/**
- * Dump all the queued in-memory writes to a packfile.
+ * Dump all the queued in-memory writes to a packfile.
*
- * The contents of the packfile will be stored in the given buffer.
- * It is the caller's responsibility to ensure that the generated
- * packfile is available to the repository (e.g. by writing it
- * to disk, or doing something crazy like distributing it across
- * several copies of the repository over a network).
+ * The contents of the packfile will be stored in the given buffer.
+ * It is the caller's responsibility to ensure that the generated
+ * packfile is available to the repository (e.g. by writing it
+ * to disk, or doing something crazy like distributing it across
+ * several copies of the repository over a network).
*
- * Once the generated packfile is available to the repository,
- * call `git_mempack_reset` to cleanup the memory store.
+ * Once the generated packfile is available to the repository,
+ * call `git_mempack_reset` to cleanup the memory store.
*
- * Calling `git_mempack_reset` before the packfile has been
- * written to disk will result in an inconsistent repository
- * (the objects in the memory store won't be accessible).
+ * Calling `git_mempack_reset` before the packfile has been
+ * written to disk will result in an inconsistent repository
+ * (the objects in the memory store won't be accessible).
*
- * @param pack Buffer where to store the raw packfile
- * @param repo The active repository where the backend is loaded
- * @param backend The mempack backend
- * @return 0 on success; error code otherwise
+ * @param pack Buffer where to store the raw packfile
+ * @param repo The active repository where the backend is loaded
+ * @param backend The mempack backend
+ * @return 0 on success; error code otherwise
*/
GIT_EXTERN(int) git_mempack_dump(git_buf *pack, git_repository *repo, git_odb_backend *backend);
/**
- * Reset the memory packer by clearing all the queued objects.
+ * Reset the memory packer by clearing all the queued objects.
*
- * This assumes that `git_mempack_dump` has been called before to
- * store all the queued objects into a single packfile.
+ * This assumes that `git_mempack_dump` has been called before to
+ * store all the queued objects into a single packfile.
*
- * Alternatively, call `reset` without a previous dump to "undo"
- * all the recently written objects, giving transaction-like
- * semantics to the Git repository.
+ * Alternatively, call `reset` without a previous dump to "undo"
+ * all the recently written objects, giving transaction-like
+ * semantics to the Git repository.
*
- * @param backend The mempack backend
+ * @param backend The mempack backend
*/
GIT_EXTERN(void) git_mempack_reset(git_odb_backend *backend);