79 lines
1.8 KiB
C
79 lines
1.8 KiB
C
/*
|
|
* Copyright (C) the libgit2 contributors. All rights reserved.
|
|
*
|
|
* This file is part of libgit2, distributed under the GNU GPL v2 with
|
|
* a Linking Exception. For full terms see the included COPYING file.
|
|
*/
|
|
#ifndef INCLUDE_sys_git_midx_h__
|
|
#define INCLUDE_sys_git_midx_h__
|
|
|
|
#include "git2/common.h"
|
|
#include "git2/types.h"
|
|
|
|
/**
|
|
* @file git2/midx.h
|
|
* @brief Git multi-pack-index routines
|
|
* @defgroup git_midx Git multi-pack-index routines
|
|
* @ingroup Git
|
|
* @{
|
|
*/
|
|
GIT_BEGIN_DECL
|
|
|
|
/**
|
|
* Create a new writer for `multi-pack-index` files.
|
|
*
|
|
* @param out location to store the writer pointer.
|
|
* @param pack_dir the directory where the `.pack` and `.idx` files are. The
|
|
* `multi-pack-index` file will be written in this directory, too.
|
|
* @return 0 or an error code
|
|
*/
|
|
GIT_EXTERN(int) git_midx_writer_new(
|
|
git_midx_writer **out,
|
|
const char *pack_dir
|
|
#ifdef GIT_EXPERIMENTAL_SHA256
|
|
, git_oid_t oid_type
|
|
#endif
|
|
);
|
|
|
|
/**
|
|
* Free the multi-pack-index writer and its resources.
|
|
*
|
|
* @param w the writer to free. If NULL no action is taken.
|
|
*/
|
|
GIT_EXTERN(void) git_midx_writer_free(git_midx_writer *w);
|
|
|
|
/**
|
|
* Add an `.idx` file to the writer.
|
|
*
|
|
* @param w the writer
|
|
* @param idx_path the path of an `.idx` file.
|
|
* @return 0 or an error code
|
|
*/
|
|
GIT_EXTERN(int) git_midx_writer_add(
|
|
git_midx_writer *w,
|
|
const char *idx_path);
|
|
|
|
/**
|
|
* Write a `multi-pack-index` file to a file.
|
|
*
|
|
* @param w the writer
|
|
* @return 0 or an error code
|
|
*/
|
|
GIT_EXTERN(int) git_midx_writer_commit(
|
|
git_midx_writer *w);
|
|
|
|
/**
|
|
* Dump the contents of the `multi-pack-index` to an in-memory buffer.
|
|
*
|
|
* @param midx Buffer where to store the contents of the `multi-pack-index`.
|
|
* @param w the writer
|
|
* @return 0 or an error code
|
|
*/
|
|
GIT_EXTERN(int) git_midx_writer_dump(
|
|
git_buf *midx,
|
|
git_midx_writer *w);
|
|
|
|
/** @} */
|
|
GIT_END_DECL
|
|
#endif
|