|
23 | 23 | GIT_BEGIN_DECL |
24 | 24 |
|
25 | 25 | /** |
26 | | - * Instantiate a new mempack backend. |
| 26 | + * Instantiate a new mempack backend. |
27 | 27 | * |
28 | | - * The backend must be added to an existing ODB with the highest |
29 | | - * priority. |
| 28 | + * The backend must be added to an existing ODB with the highest |
| 29 | + * priority. |
30 | 30 | * |
31 | | - * git_mempack_new(&mempacker); |
32 | | - * git_repository_odb(&odb, repository); |
33 | | - * git_odb_add_backend(odb, mempacker, 999); |
| 31 | + * git_mempack_new(&mempacker); |
| 32 | + * git_repository_odb(&odb, repository); |
| 33 | + * git_odb_add_backend(odb, mempacker, 999); |
34 | 34 | * |
35 | | - * Once the backend has been loaded, all writes to the ODB will |
36 | | - * instead be queued in memory, and can be finalized with |
37 | | - * `git_mempack_dump`. |
| 35 | + * Once the backend has been loaded, all writes to the ODB will |
| 36 | + * instead be queued in memory, and can be finalized with |
| 37 | + * `git_mempack_dump`. |
38 | 38 | * |
39 | | - * Subsequent reads will also be served from the in-memory store |
40 | | - * to ensure consistency, until the memory store is dumped. |
| 39 | + * Subsequent reads will also be served from the in-memory store |
| 40 | + * to ensure consistency, until the memory store is dumped. |
41 | 41 | * |
42 | | - * @param out Pointer where to store the ODB backend |
43 | | - * @return 0 on success; error code otherwise |
| 42 | + * @param out Pointer where to store the ODB backend |
| 43 | + * @return 0 on success; error code otherwise |
44 | 44 | */ |
45 | 45 | GIT_EXTERN(int) git_mempack_new(git_odb_backend **out); |
46 | 46 |
|
47 | 47 | /** |
48 | | - * Dump all the queued in-memory writes to a packfile. |
| 48 | + * Dump all the queued in-memory writes to a packfile. |
49 | 49 | * |
50 | | - * The contents of the packfile will be stored in the given buffer. |
51 | | - * It is the caller's responsibility to ensure that the generated |
52 | | - * packfile is available to the repository (e.g. by writing it |
53 | | - * to disk, or doing something crazy like distributing it across |
54 | | - * several copies of the repository over a network). |
| 50 | + * The contents of the packfile will be stored in the given buffer. |
| 51 | + * It is the caller's responsibility to ensure that the generated |
| 52 | + * packfile is available to the repository (e.g. by writing it |
| 53 | + * to disk, or doing something crazy like distributing it across |
| 54 | + * several copies of the repository over a network). |
55 | 55 | * |
56 | | - * Once the generated packfile is available to the repository, |
57 | | - * call `git_mempack_reset` to cleanup the memory store. |
| 56 | + * Once the generated packfile is available to the repository, |
| 57 | + * call `git_mempack_reset` to cleanup the memory store. |
58 | 58 | * |
59 | | - * Calling `git_mempack_reset` before the packfile has been |
60 | | - * written to disk will result in an inconsistent repository |
61 | | - * (the objects in the memory store won't be accessible). |
| 59 | + * Calling `git_mempack_reset` before the packfile has been |
| 60 | + * written to disk will result in an inconsistent repository |
| 61 | + * (the objects in the memory store won't be accessible). |
62 | 62 | * |
63 | | - * @param pack Buffer where to store the raw packfile |
64 | | - * @param repo The active repository where the backend is loaded |
65 | | - * @param backend The mempack backend |
66 | | - * @return 0 on success; error code otherwise |
| 63 | + * @param pack Buffer where to store the raw packfile |
| 64 | + * @param repo The active repository where the backend is loaded |
| 65 | + * @param backend The mempack backend |
| 66 | + * @return 0 on success; error code otherwise |
67 | 67 | */ |
68 | 68 | GIT_EXTERN(int) git_mempack_dump(git_buf *pack, git_repository *repo, git_odb_backend *backend); |
69 | 69 |
|
70 | 70 | /** |
71 | | - * Reset the memory packer by clearing all the queued objects. |
| 71 | + * Reset the memory packer by clearing all the queued objects. |
72 | 72 | * |
73 | | - * This assumes that `git_mempack_dump` has been called before to |
74 | | - * store all the queued objects into a single packfile. |
| 73 | + * This assumes that `git_mempack_dump` has been called before to |
| 74 | + * store all the queued objects into a single packfile. |
75 | 75 | * |
76 | | - * Alternatively, call `reset` without a previous dump to "undo" |
77 | | - * all the recently written objects, giving transaction-like |
78 | | - * semantics to the Git repository. |
| 76 | + * Alternatively, call `reset` without a previous dump to "undo" |
| 77 | + * all the recently written objects, giving transaction-like |
| 78 | + * semantics to the Git repository. |
79 | 79 | * |
80 | | - * @param backend The mempack backend |
| 80 | + * @param backend The mempack backend |
81 | 81 | */ |
82 | 82 | GIT_EXTERN(void) git_mempack_reset(git_odb_backend *backend); |
83 | 83 |
|
|
0 commit comments