Skip to content

G
git2
Commit dcd759b8 by Patrick Steinhardt Committed by GitHub
Options

Merge pull request #3897 from pks-t/pks/squelch-example-warnings 

Squelch example warnings, enable CI
parents 610cff13 ec3f5a9c
Showing with 555 additions and 343 deletions
examples/add.c
...@@ -75,15 +75,14 @@ int print_matched_cb(const char *path, const char *matched_pathspec, void *paylo ...@@ -75,15 +75,14 @@ int print_matched_cb(const char *path, const char *matched_pathspec, void *paylo
{ {
struct print_payload p = *(struct print_payload*)(payload); struct print_payload p = *(struct print_payload*)(payload);
int ret; int ret;
git_status_t status; unsigned status;
(void)matched_pathspec; (void)matched_pathspec;
if (git_status_file((unsigned int*)(&status), p.repo, path)) { if (git_status_file(&status, p.repo, path)) {
return -1; //abort return -1;
} }
if (status & GIT_STATUS_WT_MODIFIED || if (status & GIT_STATUS_WT_MODIFIED || status & GIT_STATUS_WT_NEW) {
status & GIT_STATUS_WT_NEW) {
printf("add '%s'\n", path); printf("add '%s'\n", path);
ret = 0; ret = 0;
} else { } else {
......
examples/common.c
...@@ -146,6 +146,25 @@ int match_uint16_arg( ...@@ -146,6 +146,25 @@ int match_uint16_arg(
return 1; return 1;
} }
int match_uint32_arg(
uint32_t *out, struct args_info *args, const char *opt)
{
const char *found = match_numeric_arg(args, opt);
uint16_t val;
char *endptr = NULL;
if (!found)
return 0;
val = (uint32_t)strtoul(found, &endptr, 0);
if (!endptr || *endptr != '\0')
fatal("expected number after argument", opt);
if (out)
*out = val;
return 1;
}
static int match_int_internal( static int match_int_internal(
int *out, const char *str, int allow_negative, const char *opt) int *out, const char *str, int allow_negative, const char *opt)
{ {
......
examples/common.h
...@@ -73,6 +73,15 @@ extern int match_uint16_arg( ...@@ -73,6 +73,15 @@ extern int match_uint16_arg(
uint16_t *out, struct args_info *args, const char *opt); uint16_t *out, struct args_info *args, const char *opt);
/** /**
* Check current `args` entry against `opt` string parsing as uint32. If
* `opt` matches exactly, take the next arg as a uint16_t value; if `opt`
* is a prefix (equal sign optional), take the remainder of the arg as a
* uint32_t value; otherwise return 0.
*/
extern int match_uint32_arg(
uint32_t *out, struct args_info *args, const char *opt);
/**
* Check current `args` entry against `opt` string parsing as int. If * Check current `args` entry against `opt` string parsing as int. If
* `opt` matches exactly, take the next arg as an int value; if it matches * `opt` matches exactly, take the next arg as an int value; if it matches
* as a prefix (equal sign optional), take the remainder of the arg as a * as a prefix (equal sign optional), take the remainder of the arg as a
......
examples/diff.c
...@@ -293,11 +293,11 @@ static void parse_opts(struct opts *o, int argc, char *argv[]) ...@@ -293,11 +293,11 @@ static void parse_opts(struct opts *o, int argc, char *argv[])
else if (is_prefixed(a, "-B") || is_prefixed(a, "--break-rewrites")) else if (is_prefixed(a, "-B") || is_prefixed(a, "--break-rewrites"))
/* TODO: parse thresholds */ /* TODO: parse thresholds */
o->findopts.flags |= GIT_DIFF_FIND_REWRITES; o->findopts.flags |= GIT_DIFF_FIND_REWRITES;
else if (!match_uint16_arg( else if (!match_uint32_arg(
&o->diffopts.context_lines, &args, "-U") && &o->diffopts.context_lines, &args, "-U") &&
!match_uint16_arg( !match_uint32_arg(
&o->diffopts.context_lines, &args, "--unified") && &o->diffopts.context_lines, &args, "--unified") &&
!match_uint16_arg( !match_uint32_arg(
&o->diffopts.interhunk_lines, &args, "--inter-hunk-context") && &o->diffopts.interhunk_lines, &args, "--inter-hunk-context") &&
!match_uint16_arg( !match_uint16_arg(
&o->diffopts.id_abbrev, &args, "--abbrev") && &o->diffopts.id_abbrev, &args, "--abbrev") &&
......
examples/general.c
...@@ -12,39 +12,58 @@ ...@@ -12,39 +12,58 @@
* <http://creativecommons.org/publicdomain/zero/1.0/>. * <http://creativecommons.org/publicdomain/zero/1.0/>.
*/ */
// [**libgit2**][lg] is a portable, pure C implementation of the Git core /**
// methods provided as a re-entrant linkable library with a solid API, * [**libgit2**][lg] is a portable, pure C implementation of the Git core
// allowing you to write native speed custom Git applications in any * methods provided as a re-entrant linkable library with a solid API,
// language which supports C bindings. * allowing you to write native speed custom Git applications in any
// * language which supports C bindings.
// This file is an example of using that API in a real, compilable C file. *
// As the API is updated, this file will be updated to demonstrate the new * This file is an example of using that API in a real, compilable C file.
// functionality. * As the API is updated, this file will be updated to demonstrate the new
// * functionality.
// If you're trying to write something in C using [libgit2][lg], you should *
// also check out the generated [API documentation][ap]. We try to link to * If you're trying to write something in C using [libgit2][lg], you should
// the relevant sections of the API docs in each section in this file. * also check out the generated [API documentation][ap]. We try to link to
// * the relevant sections of the API docs in each section in this file.
// **libgit2** (for the most part) only implements the core plumbing *
// functions, not really the higher level porcelain stuff. For a primer on * **libgit2** (for the most part) only implements the core plumbing
// Git Internals that you will need to know to work with Git at this level, * functions, not really the higher level porcelain stuff. For a primer on
// check out [Chapter 10][pg] of the Pro Git book. * Git Internals that you will need to know to work with Git at this level,
// * check out [Chapter 10][pg] of the Pro Git book.
// [lg]: http://libgit2.github.com *
// [ap]: http://libgit2.github.com/libgit2 * [lg]: http://libgit2.github.com
// [pg]: https://git-scm.com/book/en/v2/Git-Internals-Plumbing-and-Porcelain * [ap]: http://libgit2.github.com/libgit2
* [pg]: https://git-scm.com/book/en/v2/Git-Internals-Plumbing-and-Porcelain
// ### Includes */
// Including the `git2.h` header will include all the other libgit2 headers /**
// that you need. It should be the only thing you need to include in order * ### Includes
// to compile properly and get all the libgit2 API. *
* Including the `git2.h` header will include all the other libgit2 headers
* that you need. It should be the only thing you need to include in order
* to compile properly and get all the libgit2 API.
*/
#include <git2.h> #include <git2.h>
#include <stdio.h> #include <stdio.h>
#include <string.h>
// Almost all libgit2 functions return 0 on success or negative on error.
// This is not production quality error checking, but should be sufficient static void oid_parsing(git_oid *out);
// as an example. static void object_database(git_repository *repo, git_oid *oid);
static void commit_writing(git_repository *repo);
static void commit_parsing(git_repository *repo);
static void tag_parsing(git_repository *repo);
static void tree_parsing(git_repository *repo);
static void blob_parsing(git_repository *repo);
static void revwalking(git_repository *repo);
static void index_walking(git_repository *repo);
static void reference_listing(git_repository *repo);
static void config_files(const char *repo_path);
/**
* Almost all libgit2 functions return 0 on success or negative on error.
* This is not production quality error checking, but should be sufficient
* as an example.
*/
static void check_error(int error_code, const char *action) static void check_error(int error_code, const char *action)
{ {
const git_error *error = giterr_last(); const git_error *error = giterr_last();
...@@ -59,38 +78,72 @@ static void check_error(int error_code, const char *action) ...@@ -59,38 +78,72 @@ static void check_error(int error_code, const char *action)
int main (int argc, char** argv) int main (int argc, char** argv)
{ {
// Initialize the library, this will set up any global state which libgit2 needs
// including threading and crypto
git_libgit2_init();
// ### Opening the Repository
// There are a couple of methods for opening a repository, this being the
// simplest. There are also [methods][me] for specifying the index file
// and work tree locations, here we assume they are in the normal places.
//
// (Try running this program against tests/resources/testrepo.git.)
//
// [me]: http://libgit2.github.com/libgit2/#HEAD/group/repository
int error; int error;
const char *repo_path = (argc > 1) ? argv[1] : "/opt/libgit2-test/.git"; git_oid oid;
char *repo_path;
git_repository *repo; git_repository *repo;
/**
* Initialize the library, this will set up any global state which libgit2 needs
* including threading and crypto
*/
git_libgit2_init();
/**
* ### Opening the Repository
*
* There are a couple of methods for opening a repository, this being the
* simplest. There are also [methods][me] for specifying the index file
* and work tree locations, here we assume they are in the normal places.
*
* (Try running this program against tests/resources/testrepo.git.)
*
* [me]: http://libgit2.github.com/libgit2/#HEAD/group/repository
*/
repo_path = (argc > 1) ? argv[1] : "/opt/libgit2-test/.git";
error = git_repository_open(&repo, repo_path); error = git_repository_open(&repo, repo_path);
check_error(error, "opening repository"); check_error(error, "opening repository");
// ### SHA-1 Value Conversions oid_parsing(&oid);
object_database(repo, &oid);
commit_writing(repo);
commit_parsing(repo);
tag_parsing(repo);
tree_parsing(repo);
blob_parsing(repo);
revwalking(repo);
index_walking(repo);
reference_listing(repo);
config_files(repo_path);
/**
* Finally, when you're done with the repository, you can free it as well.
*/
git_repository_free(repo);
// For our first example, we will convert a 40 character hex value to the return 0;
// 20 byte raw SHA1 value. }
printf("*Hex to Raw*\n");
/**
* ### SHA-1 Value Conversions
*/
static void oid_parsing(git_oid *oid)
{
char out[GIT_OID_HEXSZ+1];
char hex[] = "4a202b346bb0fb0db7eff3cffeb3c70babbd2045"; char hex[] = "4a202b346bb0fb0db7eff3cffeb3c70babbd2045";
// The `git_oid` is the structure that keeps the SHA value. We will use printf("*Hex to Raw*\n");
// this throughout the example for storing the value of the current SHA
// key we're working with. /**
git_oid oid; * For our first example, we will convert a 40 character hex value to the
git_oid_fromstr(&oid, hex); * 20 byte raw SHA1 value.
*
* The `git_oid` is the structure that keeps the SHA value. We will use
* this throughout the example for storing the value of the current SHA
* key we're working with.
*/
git_oid_fromstr(oid, hex);
// Once we've converted the string into the oid value, we can get the raw // Once we've converted the string into the oid value, we can get the raw
// value of the SHA by accessing `oid.id` // value of the SHA by accessing `oid.id`
...@@ -98,166 +151,151 @@ int main (int argc, char** argv) ...@@ -98,166 +151,151 @@ int main (int argc, char** argv)
// Next we will convert the 20 byte raw SHA1 value to a human readable 40 // Next we will convert the 20 byte raw SHA1 value to a human readable 40
// char hex value. // char hex value.
printf("\n*Raw to Hex*\n"); printf("\n*Raw to Hex*\n");
char out[GIT_OID_HEXSZ+1];
out[GIT_OID_HEXSZ] = '\0'; out[GIT_OID_HEXSZ] = '\0';
// If you have a oid, you can easily get the hex value of the SHA as well. /**
git_oid_fmt(out, &oid); * If you have a oid, you can easily get the hex value of the SHA as well.
printf("SHA hex string: %s\n", out); */
git_oid_fmt(out, oid);
// ### Working with the Object Database /**
* If you have a oid, you can easily get the hex value of the SHA as well.
*/
git_oid_fmt(out, oid);
printf("SHA hex string: %s\n", out);
}
// **libgit2** provides [direct access][odb] to the object database. The /**
// object database is where the actual objects are stored in Git. For * ### Working with the Object Database
// working with raw objects, we'll need to get this structure from the *
// repository. * **libgit2** provides [direct access][odb] to the object database. The
// * object database is where the actual objects are stored in Git. For
// [odb]: http://libgit2.github.com/libgit2/#HEAD/group/odb * working with raw objects, we'll need to get this structure from the
* repository.
*
* [odb]: http://libgit2.github.com/libgit2/#HEAD/group/odb
*/
static void object_database(git_repository *repo, git_oid *oid)
{
char oid_hex[GIT_OID_HEXSZ+1] = { 0 };
const unsigned char *data;
const char *str_type;
int error;
git_odb_object *obj;
git_odb *odb; git_odb *odb;
git_otype otype;
git_repository_odb(&odb, repo); git_repository_odb(&odb, repo);
// #### Raw Object Reading /**
* #### Raw Object Reading
*/
printf("\n*Raw Object Read*\n"); printf("\n*Raw Object Read*\n");
git_odb_object *obj;
git_otype otype;
const unsigned char *data;
const char *str_type;
// We can read raw objects directly from the object database if we have /**
// the oid (SHA) of the object. This allows us to access objects without * We can read raw objects directly from the object database if we have
// knowing their type and inspect the raw bytes unparsed. * the oid (SHA) of the object. This allows us to access objects without
error = git_odb_read(&obj, odb, &oid); * knowing their type and inspect the raw bytes unparsed.
*/
error = git_odb_read(&obj, odb, oid);
check_error(error, "finding object in repository"); check_error(error, "finding object in repository");
// A raw object only has three properties - the type (commit, blob, tree /**
// or tag), the size of the raw data and the raw, unparsed data itself. * A raw object only has three properties - the type (commit, blob, tree
// For a commit or tag, that raw data is human readable plain ASCII * or tag), the size of the raw data and the raw, unparsed data itself.
// text. For a blob it is just file contents, so it could be text or * For a commit or tag, that raw data is human readable plain ASCII
// binary data. For a tree it is a special binary format, so it's unlikely * text. For a blob it is just file contents, so it could be text or
// to be hugely helpful as a raw object. * binary data. For a tree it is a special binary format, so it's unlikely
* to be hugely helpful as a raw object.
*/
data = (const unsigned char *)git_odb_object_data(obj); data = (const unsigned char *)git_odb_object_data(obj);
otype = git_odb_object_type(obj); otype = git_odb_object_type(obj);
// We provide methods to convert from the object type which is an enum, to /**
// a string representation of that value (and vice-versa). * We provide methods to convert from the object type which is an enum, to
* a string representation of that value (and vice-versa).
*/
str_type = git_object_type2string(otype); str_type = git_object_type2string(otype);
printf("object length and type: %d, %s\n", printf("object length and type: %d, %s\nobject data: %s\n",
(int)git_odb_object_size(obj), (int)git_odb_object_size(obj),
str_type); str_type, data);
// For proper memory management, close the object when you are done with /**
// it or it will leak memory. * For proper memory management, close the object when you are done with
* it or it will leak memory.
*/
git_odb_object_free(obj); git_odb_object_free(obj);
// #### Raw Object Writing /**
* #### Raw Object Writing
*/
printf("\n*Raw Object Write*\n"); printf("\n*Raw Object Write*\n");
// You can also write raw object data to Git. This is pretty cool because /**
// it gives you direct access to the key/value properties of Git. Here * You can also write raw object data to Git. This is pretty cool because
// we'll write a new blob object that just contains a simple string. * it gives you direct access to the key/value properties of Git. Here
// Notice that we have to specify the object type as the `git_otype` enum. * we'll write a new blob object that just contains a simple string.
git_odb_write(&oid, odb, "test data", sizeof("test data") - 1, GIT_OBJ_BLOB); * Notice that we have to specify the object type as the `git_otype` enum.
*/
// Now that we've written the object, we can check out what SHA1 was git_odb_write(oid, odb, "test data", sizeof("test data") - 1, GIT_OBJ_BLOB);
// generated when the object was written to our database.
git_oid_fmt(out, &oid);
printf("Written Object: %s\n", out);
// ### Object Parsing
// libgit2 has methods to parse every object type in Git so you don't have
// to work directly with the raw data. This is much faster and simpler
// than trying to deal with the raw data yourself.
// #### Commit Parsing
// [Parsing commit objects][pco] is simple and gives you access to all the
// data in the commit - the author (name, email, datetime), committer
// (same), tree, message, encoding and parent(s).
//
// [pco]: http://libgit2.github.com/libgit2/#HEAD/group/commit
printf("\n*Commit Parsing*\n");
git_commit *commit;
git_oid_fromstr(&oid, "8496071c1b46c854b31185ea97743be6a8774479");
error = git_commit_lookup(&commit, repo, &oid);
check_error(error, "looking up commit");
const git_signature *author, *cmtter;
const char *message;
time_t ctime;
unsigned int parents, p;
// Each of the properties of the commit object are accessible via methods,
// including commonly needed variations, such as `git_commit_time` which
// returns the author time and `git_commit_message` which gives you the
// commit message (as a NUL-terminated string).
message = git_commit_message(commit);
author = git_commit_author(commit);
cmtter = git_commit_committer(commit);
ctime = git_commit_time(commit);
// The author and committer methods return [git_signature] structures,
// which give you name, email and `when`, which is a `git_time` structure,
// giving you a timestamp and timezone offset.
printf("Author: %s (%s)\n", author->name, author->email);
// Commits can have zero or more parents. The first (root) commit will
// have no parents, most commits will have one (i.e. the commit it was
// based on) and merge commits will have two or more. Commits can
// technically have any number, though it's rare to have more than two.
parents = git_commit_parentcount(commit);
for (p = 0;p < parents;p++) {
git_commit *parent;
git_commit_parent(&parent, commit, p);
git_oid_fmt(out, git_commit_id(parent));
printf("Parent: %s\n", out);
git_commit_free(parent);
}
// Don't forget to close the object to prevent memory leaks. You will have
// to do this for all the objects you open and parse.
git_commit_free(commit);
// #### Writing Commits
// libgit2 provides a couple of methods to create commit objects easily as /**
// well. There are four different create signatures, we'll just show one * Now that we've written the object, we can check out what SHA1 was
// of them here. You can read about the other ones in the [commit API * generated when the object was written to our database.
// docs][cd]. */
// git_oid_fmt(oid_hex, oid);
// [cd]: http://libgit2.github.com/libgit2/#HEAD/group/commit printf("Written Object: %s\n", oid_hex);
}
printf("\n*Commit Writing*\n"); /**
* #### Writing Commits
*
* libgit2 provides a couple of methods to create commit objects easily as
* well. There are four different create signatures, we'll just show one
* of them here. You can read about the other ones in the [commit API
* docs][cd].
*
* [cd]: http://libgit2.github.com/libgit2/#HEAD/group/commit
*/
static void commit_writing(git_repository *repo)
{
git_oid tree_id, parent_id, commit_id; git_oid tree_id, parent_id, commit_id;
git_tree *tree; git_tree *tree;
git_commit *parent; git_commit *parent;
const git_signature *author, *cmtter;
char oid_hex[GIT_OID_HEXSZ+1] = { 0 };
printf("\n*Commit Writing*\n");
// Creating signatures for an authoring identity and time is simple. You /**
// will need to do this to specify who created a commit and when. Default * Creating signatures for an authoring identity and time is simple. You
// values for the name and email should be found in the `user.name` and * will need to do this to specify who created a commit and when. Default
// `user.email` configuration options. See the `config` section of this * values for the name and email should be found in the `user.name` and
// example file to see how to access config values. * `user.email` configuration options. See the `config` section of this
* example file to see how to access config values.
*/
git_signature_new((git_signature **)&author, git_signature_new((git_signature **)&author,
"Scott Chacon", "schacon@gmail.com", 123456789, 60); "Scott Chacon", "schacon@gmail.com", 123456789, 60);
git_signature_new((git_signature **)&cmtter, git_signature_new((git_signature **)&cmtter,
"Scott A Chacon", "scott@github.com", 987654321, 90); "Scott A Chacon", "scott@github.com", 987654321, 90);
// Commit objects need a tree to point to and optionally one or more /**
// parents. Here we're creating oid objects to create the commit with, * Commit objects need a tree to point to and optionally one or more
// but you can also use * parents. Here we're creating oid objects to create the commit with,
* but you can also use
*/
git_oid_fromstr(&tree_id, "f60079018b664e4e79329a7ef9559c8d9e0378d1"); git_oid_fromstr(&tree_id, "f60079018b664e4e79329a7ef9559c8d9e0378d1");
git_tree_lookup(&tree, repo, &tree_id); git_tree_lookup(&tree, repo, &tree_id);
git_oid_fromstr(&parent_id, "5b5b025afb0b4c913b4c338a42934a3863bf3644"); git_oid_fromstr(&parent_id, "5b5b025afb0b4c913b4c338a42934a3863bf3644");
git_commit_lookup(&parent, repo, &parent_id); git_commit_lookup(&parent, repo, &parent_id);
// Here we actually create the commit object with a single call with all /**
// the values we need to create the commit. The SHA key is written to the * Here we actually create the commit object with a single call with all
// `commit_id` variable here. * the values we need to create the commit. The SHA key is written to the
* `commit_id` variable here.
*/
git_commit_create_v( git_commit_create_v(
&commit_id, /* out id */ &commit_id, /* out id */
repo, repo,
...@@ -269,142 +307,269 @@ int main (int argc, char** argv) ...@@ -269,142 +307,269 @@ int main (int argc, char** argv)
tree, tree,
1, parent); 1, parent);
// Now we can take a look at the commit SHA we've generated. /**
git_oid_fmt(out, &commit_id); * Now we can take a look at the commit SHA we've generated.
printf("New Commit: %s\n", out); */
git_oid_fmt(oid_hex, &commit_id);
printf("New Commit: %s\n", oid_hex);
}
// #### Tag Parsing /**
* ### Object Parsing
*
* libgit2 has methods to parse every object type in Git so you don't have
* to work directly with the raw data. This is much faster and simpler
* than trying to deal with the raw data yourself.
*/
// You can parse and create tags with the [tag management API][tm], which /**
// functions very similarly to the commit lookup, parsing and creation * #### Commit Parsing
// methods, since the objects themselves are very similar. *
// * [Parsing commit objects][pco] is simple and gives you access to all the
// [tm]: http://libgit2.github.com/libgit2/#HEAD/group/tag * data in the commit - the author (name, email, datetime), committer
printf("\n*Tag Parsing*\n"); * (same), tree, message, encoding and parent(s).
*
* [pco]: http://libgit2.github.com/libgit2/#HEAD/group/commit
*/
static void commit_parsing(git_repository *repo)
{
const git_signature *author, *cmtter;
git_commit *commit, *parent;
git_oid oid;
char oid_hex[GIT_OID_HEXSZ+1];
const char *message;
unsigned int parents, p;
int error;
time_t time;
printf("\n*Commit Parsing*\n");
git_oid_fromstr(&oid, "8496071c1b46c854b31185ea97743be6a8774479");
error = git_commit_lookup(&commit, repo, &oid);
check_error(error, "looking up commit");
/**
* Each of the properties of the commit object are accessible via methods,
* including commonly needed variations, such as `git_commit_time` which
* returns the author time and `git_commit_message` which gives you the
* commit message (as a NUL-terminated string).
*/
message = git_commit_message(commit);
author = git_commit_author(commit);
cmtter = git_commit_committer(commit);
time = git_commit_time(commit);
/**
* The author and committer methods return [git_signature] structures,
* which give you name, email and `when`, which is a `git_time` structure,
* giving you a timestamp and timezone offset.
*/
printf("Author: %s (%s)\nCommitter: %s (%s)\nDate: %s\nMessage: %s\n",
author->name, author->email,
cmtter->name, cmtter->email,
ctime(&time), message);
/**
* Commits can have zero or more parents. The first (root) commit will
* have no parents, most commits will have one (i.e. the commit it was
* based on) and merge commits will have two or more. Commits can
* technically have any number, though it's rare to have more than two.
*/
parents = git_commit_parentcount(commit);
for (p = 0;p < parents;p++) {
memset(oid_hex, 0, sizeof(oid_hex));
git_commit_parent(&parent, commit, p);
git_oid_fmt(oid_hex, git_commit_id(parent));
printf("Parent: %s\n", oid_hex);
git_commit_free(parent);
}
git_commit_free(commit);
}
/**
* #### Tag Parsing
*
* You can parse and create tags with the [tag management API][tm], which
* functions very similarly to the commit lookup, parsing and creation
* methods, since the objects themselves are very similar.
*
* [tm]: http://libgit2.github.com/libgit2/#HEAD/group/tag
*/
static void tag_parsing(git_repository *repo)
{
git_commit *commit;
git_otype type;
git_tag *tag; git_tag *tag;
const char *tmessage, *tname; git_oid oid;
git_otype ttype; const char *name, *message;
int error;
printf("\n*Tag Parsing*\n");
// We create an oid for the tag object if we know the SHA and look it up /**
// the same way that we would a commit (or any other object). * We create an oid for the tag object if we know the SHA and look it up
* the same way that we would a commit (or any other object).
*/
git_oid_fromstr(&oid, "b25fa35b38051e4ae45d4222e795f9df2e43f1d1"); git_oid_fromstr(&oid, "b25fa35b38051e4ae45d4222e795f9df2e43f1d1");
error = git_tag_lookup(&tag, repo, &oid); error = git_tag_lookup(&tag, repo, &oid);
check_error(error, "looking up tag"); check_error(error, "looking up tag");
// Now that we have the tag object, we can extract the information it /**
// generally contains: the target (usually a commit object), the type of * Now that we have the tag object, we can extract the information it
// the target object (usually 'commit'), the name ('v1.0'), the tagger (a * generally contains: the target (usually a commit object), the type of
// git_signature - name, email, timestamp), and the tag message. * the target object (usually 'commit'), the name ('v1.0'), the tagger (a
* git_signature - name, email, timestamp), and the tag message.
*/
git_tag_target((git_object **)&commit, tag); git_tag_target((git_object **)&commit, tag);
tname = git_tag_name(tag); // "test" name = git_tag_name(tag); /* "test" */
ttype = git_tag_target_type(tag); // GIT_OBJ_COMMIT (otype enum) type = git_tag_target_type(tag); /* GIT_OBJ_COMMIT (otype enum) */
tmessage = git_tag_message(tag); // "tag message\n" message = git_tag_message(tag); /* "tag message\n" */
printf("Tag Message: %s\n", tmessage); printf("Tag Name: %s\nTag Type: %s\nTag Message: %s\n",
name, git_object_type2string(type), message);
git_commit_free(commit); git_commit_free(commit);
}
// #### Tree Parsing /**
* #### Tree Parsing
*
* [Tree parsing][tp] is a bit different than the other objects, in that
* we have a subtype which is the tree entry. This is not an actual
* object type in Git, but a useful structure for parsing and traversing
* tree entries.
*
* [tp]: http://libgit2.github.com/libgit2/#HEAD/group/tree
*/
static void tree_parsing(git_repository *repo)
{
const git_tree_entry *entry;
size_t cnt;
git_object *obj;
git_tree *tree;
git_oid oid;
// [Tree parsing][tp] is a bit different than the other objects, in that
// we have a subtype which is the tree entry. This is not an actual
// object type in Git, but a useful structure for parsing and traversing
// tree entries.
//
// [tp]: http://libgit2.github.com/libgit2/#HEAD/group/tree
printf("\n*Tree Parsing*\n"); printf("\n*Tree Parsing*\n");
const git_tree_entry *entry; /**
git_object *objt; * Create the oid and lookup the tree object just like the other objects.
*/
// Create the oid and lookup the tree object just like the other objects. git_oid_fromstr(&oid, "f60079018b664e4e79329a7ef9559c8d9e0378d1");
git_oid_fromstr(&oid, "2a741c18ac5ff082a7caaec6e74db3075a1906b5");
git_tree_lookup(&tree, repo, &oid); git_tree_lookup(&tree, repo, &oid);
// Getting the count of entries in the tree so you can iterate over them /**
// if you want to. * Getting the count of entries in the tree so you can iterate over them
size_t cnt = git_tree_entrycount(tree); // 3 * if you want to.
printf("tree entries: %d\n", (int)cnt); */
cnt = git_tree_entrycount(tree); /* 2 */
printf("tree entries: %d\n", (int) cnt);
entry = git_tree_entry_byindex(tree, 0); entry = git_tree_entry_byindex(tree, 0);
printf("Entry name: %s\n", git_tree_entry_name(entry)); // "hello.c" printf("Entry name: %s\n", git_tree_entry_name(entry)); /* "README" */
// You can also access tree entries by name if you know the name of the /**
// entry you're looking for. * You can also access tree entries by name if you know the name of the
* entry you're looking for.
*/
entry = git_tree_entry_byname(tree, "README"); entry = git_tree_entry_byname(tree, "README");
git_tree_entry_name(entry); // "hello.c" git_tree_entry_name(entry); /* "README" */
// Once you have the entry object, you can access the content or subtree /**
// (or commit, in the case of submodules) that it points to. You can also * Once you have the entry object, you can access the content or subtree
// get the mode if you want. * (or commit, in the case of submodules) that it points to. You can also
git_tree_entry_to_object(&objt, repo, entry); // blob * get the mode if you want.
*/
// Remember to close the looked-up object once you are done using it git_tree_entry_to_object(&obj, repo, entry); /* blob */
git_object_free(objt);
// #### Blob Parsing /**
* Remember to close the looked-up object once you are done using it
*/
git_object_free(obj);
}
// The last object type is the simplest and requires the least parsing /**
// help. Blobs are just file contents and can contain anything, there is * #### Blob Parsing
// no structure to it. The main advantage to using the [simple blob *
// api][ba] is that when you're creating blobs you don't have to calculate * The last object type is the simplest and requires the least parsing
// the size of the content. There is also a helper for reading a file * help. Blobs are just file contents and can contain anything, there is
// from disk and writing it to the db and getting the oid back so you * no structure to it. The main advantage to using the [simple blob
// don't have to do all those steps yourself. * api][ba] is that when you're creating blobs you don't have to calculate
// * the size of the content. There is also a helper for reading a file
// [ba]: http://libgit2.github.com/libgit2/#HEAD/group/blob * from disk and writing it to the db and getting the oid back so you
* don't have to do all those steps yourself.
*
* [ba]: http://libgit2.github.com/libgit2/#HEAD/group/blob
*/
static void blob_parsing(git_repository *repo)
{
git_blob *blob;
git_oid oid;
printf("\n*Blob Parsing*\n"); printf("\n*Blob Parsing*\n");
git_blob *blob;
git_oid_fromstr(&oid, "1385f264afb75a56a5bec74243be9b367ba4ca08"); git_oid_fromstr(&oid, "1385f264afb75a56a5bec74243be9b367ba4ca08");
git_blob_lookup(&blob, repo, &oid); git_blob_lookup(&blob, repo, &oid);
// You can access a buffer with the raw contents of the blob directly. /**
// Note that this buffer may not be contain ASCII data for certain blobs * You can access a buffer with the raw contents of the blob directly.
// (e.g. binary files): do not consider the buffer a NULL-terminated * Note that this buffer may not be contain ASCII data for certain blobs
// string, and use the `git_blob_rawsize` attribute to find out its exact * (e.g. binary files): do not consider the buffer a NULL-terminated
// size in bytes * string, and use the `git_blob_rawsize` attribute to find out its exact
printf("Blob Size: %ld\n", (long)git_blob_rawsize(blob)); // 8 * size in bytes
git_blob_rawcontent(blob); // "content" * */
printf("Blob Size: %ld\n", (long)git_blob_rawsize(blob)); /* 8 */
// ### Revwalking git_blob_rawcontent(blob); /* "content" */
}
// The libgit2 [revision walking api][rw] provides methods to traverse the
// directed graph created by the parent pointers of the commit objects.
// Since all commits point back to the commit that came directly before
// them, you can walk this parentage as a graph and find all the commits
// that were ancestors of (reachable from) a given starting point. This
// can allow you to create `git log` type functionality.
//
// [rw]: http://libgit2.github.com/libgit2/#HEAD/group/revwalk
printf("\n*Revwalking*\n"); /**
* ### Revwalking
*
* The libgit2 [revision walking api][rw] provides methods to traverse the
* directed graph created by the parent pointers of the commit objects.
* Since all commits point back to the commit that came directly before
* them, you can walk this parentage as a graph and find all the commits
* that were ancestors of (reachable from) a given starting point. This
* can allow you to create `git log` type functionality.
*
* [rw]: http://libgit2.github.com/libgit2/#HEAD/group/revwalk
*/
static void revwalking(git_repository *repo)
{
const git_signature *cauth;
const char *cmsg;
int error;
git_revwalk *walk; git_revwalk *walk;
git_commit *wcommit; git_commit *wcommit;
git_oid oid;
printf("\n*Revwalking*\n");
git_oid_fromstr(&oid, "5b5b025afb0b4c913b4c338a42934a3863bf3644"); git_oid_fromstr(&oid, "5b5b025afb0b4c913b4c338a42934a3863bf3644");
// To use the revwalker, create a new walker, tell it how you want to sort /**
// the output and then push one or more starting points onto the walker. * To use the revwalker, create a new walker, tell it how you want to sort
// If you want to emulate the output of `git log` you would push the SHA * the output and then push one or more starting points onto the walker.
// of the commit that HEAD points to into the walker and then start * If you want to emulate the output of `git log` you would push the SHA
// traversing them. You can also 'hide' commits that you want to stop at * of the commit that HEAD points to into the walker and then start
// or not see any of their ancestors. So if you want to emulate `git log * traversing them. You can also 'hide' commits that you want to stop at
// branch1..branch2`, you would push the oid of `branch2` and hide the oid * or not see any of their ancestors. So if you want to emulate `git log
// of `branch1`. * branch1..branch2`, you would push the oid of `branch2` and hide the oid
* of `branch1`.
*/
git_revwalk_new(&walk, repo); git_revwalk_new(&walk, repo);
git_revwalk_sorting(walk, GIT_SORT_TOPOLOGICAL | GIT_SORT_REVERSE); git_revwalk_sorting(walk, GIT_SORT_TOPOLOGICAL | GIT_SORT_REVERSE);
git_revwalk_push(walk, &oid); git_revwalk_push(walk, &oid);
const git_signature *cauth; /**
const char *cmsg; * Now that we have the starting point pushed onto the walker, we start
* asking for ancestors. It will return them in the sorting order we asked
// Now that we have the starting point pushed onto the walker, we start * for as commit oids. We can then lookup and parse the committed pointed
// asking for ancestors. It will return them in the sorting order we asked * at by the returned OID; note that this operation is specially fast
// for as commit oids. We can then lookup and parse the committed pointed * since the raw contents of the commit object will be cached in memory
// at by the returned OID; note that this operation is specially fast */
// since the raw contents of the commit object will be cached in memory
while ((git_revwalk_next(&oid, walk)) == 0) { while ((git_revwalk_next(&oid, walk)) == 0) {
error = git_commit_lookup(&wcommit, repo, &oid); error = git_commit_lookup(&wcommit, repo, &oid);
check_error(error, "looking up commit during revwalk"); check_error(error, "looking up commit during revwalk");
...@@ -416,36 +581,45 @@ int main (int argc, char** argv) ...@@ -416,36 +581,45 @@ int main (int argc, char** argv)
git_commit_free(wcommit); git_commit_free(wcommit);
} }
// Like the other objects, be sure to free the revwalker when you're done /**
// to prevent memory leaks. Also, make sure that the repository being * Like the other objects, be sure to free the revwalker when you're done
// walked it not deallocated while the walk is in progress, or it will * to prevent memory leaks. Also, make sure that the repository being
// result in undefined behavior * walked it not deallocated while the walk is in progress, or it will
* result in undefined behavior
*/
git_revwalk_free(walk); git_revwalk_free(walk);
}
// ### Index File Manipulation /**
* ### Index File Manipulation *
// The [index file API][gi] allows you to read, traverse, update and write * The [index file API][gi] allows you to read, traverse, update and write
// the Git index file (sometimes thought of as the staging area). * the Git index file (sometimes thought of as the staging area).
// *
// [gi]: http://libgit2.github.com/libgit2/#HEAD/group/index * [gi]: http://libgit2.github.com/libgit2/#HEAD/group/index
*/
printf("\n*Index Walking*\n"); static void index_walking(git_repository *repo)
{
git_index *index; git_index *index;
unsigned int i, ecount; unsigned int i, ecount;
// You can either open the index from the standard location in an open printf("\n*Index Walking*\n");
// repository, as we're doing here, or you can open and manipulate any
// index file with `git_index_open_bare()`. The index for the repository /**
// will be located and loaded from disk. * You can either open the index from the standard location in an open
* repository, as we're doing here, or you can open and manipulate any
* index file with `git_index_open_bare()`. The index for the repository
* will be located and loaded from disk.
*/
git_repository_index(&index, repo); git_repository_index(&index, repo);
// For each entry in the index, you can get a bunch of information /**
// including the SHA (oid), path and mode which map to the tree objects * For each entry in the index, you can get a bunch of information
// that are written out. It also has filesystem properties to help * including the SHA (oid), path and mode which map to the tree objects
// determine what to inspect for changes (ctime, mtime, dev, ino, uid, * that are written out. It also has filesystem properties to help
// gid, file_size and flags) All these properties are exported publicly in * determine what to inspect for changes (ctime, mtime, dev, ino, uid,
// the `git_index_entry` struct * gid, file_size and flags) All these properties are exported publicly in
* the `git_index_entry` struct
*/
ecount = git_index_entrycount(index); ecount = git_index_entrycount(index);
for (i = 0; i < ecount; ++i) { for (i = 0; i < ecount; ++i) {
const git_index_entry *e = git_index_get_byindex(index, i); const git_index_entry *e = git_index_get_byindex(index, i);
...@@ -456,35 +630,46 @@ int main (int argc, char** argv) ...@@ -456,35 +630,46 @@ int main (int argc, char** argv)
} }
git_index_free(index); git_index_free(index);
}
// ### References /**
* ### References
// The [reference API][ref] allows you to list, resolve, create and update *
// references such as branches, tags and remote references (everything in * The [reference API][ref] allows you to list, resolve, create and update
// the .git/refs directory). * references such as branches, tags and remote references (everything in
// * the .git/refs directory).
// [ref]: http://libgit2.github.com/libgit2/#HEAD/group/reference *
* [ref]: http://libgit2.github.com/libgit2/#HEAD/group/reference
*/
static void reference_listing(git_repository *repo)
{
git_strarray ref_list;
const char *refname;
git_reference *ref;
unsigned i;
char oid_hex[GIT_OID_HEXSZ+1];
printf("\n*Reference Listing*\n"); printf("\n*Reference Listing*\n");
// Here we will implement something like `git for-each-ref` simply listing /**
// out all available references and the object SHA they resolve to. * Here we will implement something like `git for-each-ref` simply listing
git_strarray ref_list; * out all available references and the object SHA they resolve to.
git_reference_list(&ref_list, repo); *
* Now that we have the list of reference names, we can lookup each ref
* one at a time and resolve them to the SHA, then print both values out.
*/
const char *refname; git_reference_list(&ref_list, repo);
git_reference *ref;
// Now that we have the list of reference names, we can lookup each ref
// one at a time and resolve them to the SHA, then print both values out.
for (i = 0; i < ref_list.count; ++i) { for (i = 0; i < ref_list.count; ++i) {
memset(oid_hex, 0, sizeof(oid_hex));
refname = ref_list.strings[i]; refname = ref_list.strings[i];
git_reference_lookup(&ref, repo, refname); git_reference_lookup(&ref, repo, refname);
switch (git_reference_type(ref)) { switch (git_reference_type(ref)) {
case GIT_REF_OID: case GIT_REF_OID:
git_oid_fmt(out, git_reference_target(ref)); git_oid_fmt(oid_hex, git_reference_target(ref));
printf("%s [%s]\n", refname, out); printf("%s [%s]\n", refname, oid_hex);
break; break;
case GIT_REF_SYMBOLIC: case GIT_REF_SYMBOLIC:
...@@ -497,23 +682,28 @@ int main (int argc, char** argv) ...@@ -497,23 +682,28 @@ int main (int argc, char** argv)
} }
git_strarray_free(&ref_list); git_strarray_free(&ref_list);
}
// ### Config Files /**
* ### Config Files
// The [config API][config] allows you to list and updatee config values *
// in any of the accessible config file locations (system, global, local). * The [config API][config] allows you to list and updatee config values
// * in any of the accessible config file locations (system, global, local).
// [config]: http://libgit2.github.com/libgit2/#HEAD/group/config *
* [config]: http://libgit2.github.com/libgit2/#HEAD/group/config
printf("\n*Config Listing*\n"); */
static void config_files(const char *repo_path)
{
const char *email; const char *email;
char config_path[256];
int32_t j; int32_t j;
git_config *cfg; git_config *cfg;
// Open a config object so we can read global values from it. printf("\n*Config Listing*\n");
char config_path[256];
/**
* Open a config object so we can read global values from it.
*/
sprintf(config_path, "%s/config", repo_path); sprintf(config_path, "%s/config", repo_path);
check_error(git_config_open_ondisk(&cfg, config_path), "opening config"); check_error(git_config_open_ondisk(&cfg, config_path), "opening config");
...@@ -522,9 +712,4 @@ int main (int argc, char** argv) ...@@ -522,9 +712,4 @@ int main (int argc, char** argv)
git_config_get_string(&email, cfg, "user.email"); git_config_get_string(&email, cfg, "user.email");
printf("Email: %s\n", email); printf("Email: %s\n", email);
// Finally, when you're done with the repository, you can free it as well.
git_repository_free(repo);
return 0;
} }
examples/network/fetch.c
...@@ -55,6 +55,8 @@ static int update_cb(const char *refname, const git_oid *a, const git_oid *b, vo ...@@ -55,6 +55,8 @@ static int update_cb(const char *refname, const git_oid *a, const git_oid *b, vo
*/ */
static int transfer_progress_cb(const git_transfer_progress *stats, void *payload) static int transfer_progress_cb(const git_transfer_progress *stats, void *payload)
{ {
(void)payload;
if (stats->received_objects == stats->total_objects) { if (stats->received_objects == stats->total_objects) {
printf("Resolving deltas %d/%d\r", printf("Resolving deltas %d/%d\r",
stats->indexed_deltas, stats->total_deltas); stats->indexed_deltas, stats->total_deltas);
...@@ -71,7 +73,6 @@ int fetch(git_repository *repo, int argc, char **argv) ...@@ -71,7 +73,6 @@ int fetch(git_repository *repo, int argc, char **argv)
{ {
git_remote *remote = NULL; git_remote *remote = NULL;
const git_transfer_progress *stats; const git_transfer_progress *stats;
struct dl_data data;
git_fetch_options fetch_opts = GIT_FETCH_OPTIONS_INIT; git_fetch_options fetch_opts = GIT_FETCH_OPTIONS_INIT;
if (argc < 2) { if (argc < 2) {
...@@ -79,14 +80,13 @@ int fetch(git_repository *repo, int argc, char **argv) ...@@ -79,14 +80,13 @@ int fetch(git_repository *repo, int argc, char **argv)
return EXIT_FAILURE; return EXIT_FAILURE;
} }
// Figure out whether it's a named remote or a URL /* Figure out whether it's a named remote or a URL */
printf("Fetching %s for repo %p\n", argv[1], repo); printf("Fetching %s for repo %p\n", argv[1], repo);
if (git_remote_lookup(&remote, repo, argv[1]) < 0) { if (git_remote_lookup(&remote, repo, argv[1]) < 0)
if (git_remote_create_anonymous(&remote, repo, argv[1]) < 0) if (git_remote_create_anonymous(&remote, repo, argv[1]) < 0)
return -1; goto on_error;
}
// Set up the callbacks (only update_tips for now) /* Set up the callbacks (only update_tips for now) */
fetch_opts.callbacks.update_tips = &update_cb; fetch_opts.callbacks.update_tips = &update_cb;
fetch_opts.callbacks.sideband_progress = &progress_cb; fetch_opts.callbacks.sideband_progress = &progress_cb;
fetch_opts.callbacks.transfer_progress = transfer_progress_cb; fetch_opts.callbacks.transfer_progress = transfer_progress_cb;
...@@ -98,7 +98,7 @@ int fetch(git_repository *repo, int argc, char **argv) ...@@ -98,7 +98,7 @@ int fetch(git_repository *repo, int argc, char **argv)
* "fetch". * "fetch".
*/ */
if (git_remote_fetch(remote, NULL, &fetch_opts, "fetch") < 0) if (git_remote_fetch(remote, NULL, &fetch_opts, "fetch") < 0)
return -1; goto on_error;
/** /**
* If there are local objects (we got a thin pack), then tell * If there are local objects (we got a thin pack), then tell
......
script/cibuild.sh
...@@ -20,7 +20,7 @@ java -jar poxyproxy.jar -d --port 8080 --credentials foo:bar & ...@@ -20,7 +20,7 @@ java -jar poxyproxy.jar -d --port 8080 --credentials foo:bar &
mkdir _build mkdir _build
cd _build cd _build
# shellcheck disable=SC2086 # shellcheck disable=SC2086
cmake .. -DCMAKE_INSTALL_PREFIX=../_install $OPTIONS || exit $? cmake .. -DBUILD_EXAMPLES=ON -DCMAKE_INSTALL_PREFIX=../_install $OPTIONS || exit $?
make -j2 install || exit $? make -j2 install || exit $?
# If this platform doesn't support test execution, bail out now # If this platform doesn't support test execution, bail out now
......
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