Edit
kc3-lang/libgit2/include/git2/mailmap.h
Edward Thomson
- include/git2/mailmap.h
-
/* * 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_git_mailmap_h__ #define INCLUDE_git_mailmap_h__ #include "common.h" #include "types.h" #include "buffer.h" /** * @file git2/mailmap.h * @brief Mailmaps provide alternate email addresses for users * @defgroup git_mailmap Git mailmap routines * @ingroup Git * @{ * * A mailmap can be used to specify alternate email addresses for * repository committers or authors. This allows systems to map * commits made using different email addresses to the same logical * person. */ GIT_BEGIN_DECL /** * Allocate a new mailmap object. * * This object is empty, so you'll have to add a mailmap file before you can do * anything with it. The mailmap must be freed with 'git_mailmap_free'. * * @param[out] out pointer to store the new mailmap * @return 0 on success, or an error code */ GIT_EXTERN(int) git_mailmap_new(git_mailmap **out); /** * Free the mailmap and its associated memory. * * @param mm the mailmap to free */ GIT_EXTERN(void) git_mailmap_free(git_mailmap *mm); /** * Add a single entry to the given mailmap object. If the entry already exists, * it will be replaced with the new entry. * * @param mm mailmap to add the entry to * @param real_name the real name to use, or NULL * @param real_email the real email to use, or NULL * @param replace_name the name to replace, or NULL * @param replace_email the email to replace * @return 0 on success, or an error code */ GIT_EXTERN(int) git_mailmap_add_entry( git_mailmap *mm, const char *real_name, const char *real_email, const char *replace_name, const char *replace_email); /** * Create a new mailmap instance containing a single mailmap file * * @param[out] out pointer to store the new mailmap * @param buf buffer to parse the mailmap from * @param len the length of the input buffer * @return 0 on success, or an error code */ GIT_EXTERN(int) git_mailmap_from_buffer( git_mailmap **out, const char *buf, size_t len); /** * Create a new mailmap instance from a repository, loading mailmap files based * on the repository's configuration. * * Mailmaps are loaded in the following order: * 1. '.mailmap' in the root of the repository's working directory, if present. * 2. The blob object identified by the 'mailmap.blob' config entry, if set. * [NOTE: 'mailmap.blob' defaults to 'HEAD:.mailmap' in bare repositories] * 3. The path in the 'mailmap.file' config entry, if set. * * @param[out] out pointer to store the new mailmap * @param repo repository to load mailmap information from * @return 0 on success, or an error code */ GIT_EXTERN(int) git_mailmap_from_repository( git_mailmap **out, git_repository *repo); /** * Resolve a name and email to the corresponding real name and email. * * The lifetime of the strings are tied to `mm`, `name`, and `email` parameters. * * @param[out] real_name pointer to store the real name * @param[out] real_email pointer to store the real email * @param mm the mailmap to perform a lookup with (may be NULL) * @param name the name to look up * @param email the email to look up * @return 0 on success, or an error code */ GIT_EXTERN(int) git_mailmap_resolve( const char **real_name, const char **real_email, const git_mailmap *mm, const char *name, const char *email); /** * Resolve a signature to use real names and emails with a mailmap. * * Call `git_signature_free()` to free the data. * * @param[out] out new signature * @param mm mailmap to resolve with * @param sig signature to resolve * @return 0 or an error code */ GIT_EXTERN(int) git_mailmap_resolve_signature( git_signature **out, const git_mailmap *mm, const git_signature *sig); /** @} */ GIT_END_DECL #endif