Commit 29afb257 by Etienne Samson

docs: fix incorrect codeblock on output

parent bf70fa4b
...@@ -23,61 +23,61 @@ ...@@ -23,61 +23,61 @@
GIT_BEGIN_DECL 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 * The backend must be added to an existing ODB with the highest
* priority. * priority.
* *
* git_mempack_new(&mempacker); * git_mempack_new(&mempacker);
* git_repository_odb(&odb, repository); * git_repository_odb(&odb, repository);
* git_odb_add_backend(odb, mempacker, 999); * git_odb_add_backend(odb, mempacker, 999);
* *
* Once the backend has been loaded, all writes to the ODB will * Once the backend has been loaded, all writes to the ODB will
* instead be queued in memory, and can be finalized with * instead be queued in memory, and can be finalized with
* `git_mempack_dump`. * `git_mempack_dump`.
* *
* Subsequent reads will also be served from the in-memory store * Subsequent reads will also be served from the in-memory store
* to ensure consistency, until the memory store is dumped. * to ensure consistency, until the memory store is dumped.
* *
* @param out Pointer where to store the ODB backend * @param out Pointer where to store the ODB backend
* @return 0 on success; error code otherwise * @return 0 on success; error code otherwise
*/ */
GIT_EXTERN(int) git_mempack_new(git_odb_backend **out); 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. * The contents of the packfile will be stored in the given buffer.
* It is the caller's responsibility to ensure that the generated * It is the caller's responsibility to ensure that the generated
* packfile is available to the repository (e.g. by writing it * packfile is available to the repository (e.g. by writing it
* to disk, or doing something crazy like distributing it across * to disk, or doing something crazy like distributing it across
* several copies of the repository over a network). * several copies of the repository over a network).
* *
* Once the generated packfile is available to the repository, * Once the generated packfile is available to the repository,
* call `git_mempack_reset` to cleanup the memory store. * call `git_mempack_reset` to cleanup the memory store.
* *
* Calling `git_mempack_reset` before the packfile has been * Calling `git_mempack_reset` before the packfile has been
* written to disk will result in an inconsistent repository * written to disk will result in an inconsistent repository
* (the objects in the memory store won't be accessible). * (the objects in the memory store won't be accessible).
* *
* @param pack Buffer where to store the raw packfile * @param pack Buffer where to store the raw packfile
* @param repo The active repository where the backend is loaded * @param repo The active repository where the backend is loaded
* @param backend The mempack backend * @param backend The mempack backend
* @return 0 on success; error code otherwise * @return 0 on success; error code otherwise
*/ */
GIT_EXTERN(int) git_mempack_dump(git_buf *pack, git_repository *repo, git_odb_backend *backend); 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 * This assumes that `git_mempack_dump` has been called before to
* store all the queued objects into a single packfile. * store all the queued objects into a single packfile.
* *
* Alternatively, call `reset` without a previous dump to "undo" * Alternatively, call `reset` without a previous dump to "undo"
* all the recently written objects, giving transaction-like * all the recently written objects, giving transaction-like
* semantics to the Git repository. * 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); GIT_EXTERN(void) git_mempack_reset(git_odb_backend *backend);
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment