A few formatting changes for rocco I'm not too happy about manually inserting < and > but those get output as html tags otherwise.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
diff --git a/examples/cat-file.c b/examples/cat-file.c
index 1e5b5ea..2b54b53 100644
--- a/examples/cat-file.c
+++ b/examples/cat-file.c
@@ -31,12 +31,14 @@ static void print_signature(const char *header, const git_signature *sig)
sign, hours, minutes);
}
+/** Printint out a blob is simple, get the contents and print */
static void show_blob(const git_blob *blob)
{
/* ? Does this need crlf filtering? */
fwrite(git_blob_rawcontent(blob), git_blob_rawsize(blob), 1, stdout);
}
+/** Show each entry with its type, id and attributes */
static void show_tree(const git_tree *tree)
{
size_t i, max_i = (int)git_tree_entrycount(tree);
@@ -55,6 +57,9 @@ static void show_tree(const git_tree *tree)
}
}
+/**
+ * Commits and tags have a few interesting fields in their header.
+ */
static void show_commit(const git_commit *commit)
{
unsigned int i, max_i;
@@ -107,6 +112,7 @@ struct opts {
static void parse_opts(struct opts *o, int argc, char *argv[]);
+/** Entry point for this command */
int main(int argc, char *argv[])
{
git_repository *repo;
@@ -182,6 +188,7 @@ int main(int argc, char *argv[])
return 0;
}
+/** Print out usage information */
static void usage(const char *message, const char *arg)
{
if (message && arg)
@@ -194,6 +201,7 @@ static void usage(const char *message, const char *arg)
exit(1);
}
+/** Parse the command-line options taken from git */
static void parse_opts(struct opts *o, int argc, char *argv[])
{
struct args_info args = ARGS_INFO_INIT;
diff --git a/examples/diff.c b/examples/diff.c
index 3813258..b141564 100644
--- a/examples/diff.c
+++ b/examples/diff.c
@@ -38,6 +38,7 @@ struct opts {
const char *dir;
};
+/** These functions are implemented at the end */
static void parse_opts(struct opts *o, int argc, char *argv[]);
static int color_printer(
const git_diff_delta*, const git_diff_hunk*, const git_diff_line*, void*);
@@ -62,13 +63,13 @@ int main(int argc, char *argv[])
/**
* Possible argument patterns:
*
- * * <sha1> <sha2>
- * * <sha1> --cached
- * * <sha1>
+ * * <sha1> <sha2>
+ * * <sha1> --cached
+ * * <sha1>
* * --cached
* * nothing
*
- * Currently ranged arguments like <sha1>..<sha2> and <sha1>...<sha2>
+ * Currently ranged arguments like <sha1>..<sha2> and <sha1>...<sha2>
* are not supported in this example
*/
@@ -174,11 +175,11 @@ static int color_printer(
return diff_output(delta, hunk, line, stdout);
}
+/** Parse arguments as copied from git-diff. */
static void parse_opts(struct opts *o, int argc, char *argv[])
{
struct args_info args = ARGS_INFO_INIT;
- /* Parse arguments as copied from git-diff. */
for (args.pos = 1; args.pos < argc; ++args.pos) {
const char *a = argv[args.pos];
diff --git a/examples/network/fetch.c b/examples/network/fetch.c
index 4167ef3..77327d7 100644
--- a/examples/network/fetch.c
+++ b/examples/network/fetch.c
@@ -47,6 +47,11 @@ exit:
return &data->ret;
}
+/**
+ * This function gets called for each remote-trackinb branch that gets
+ * updated. The message we output depends on whether it's a new one or
+ * an update.
+ */
static int update_cb(const char *refname, const git_oid *a, const git_oid *b, void *data)
{
char a_str[GIT_OID_HEXSZ+1], b_str[GIT_OID_HEXSZ+1];
@@ -66,6 +71,7 @@ static int update_cb(const char *refname, const git_oid *a, const git_oid *b, vo
return 0;
}
+/** Entry point for this command */
int fetch(git_repository *repo, int argc, char **argv)
{
git_remote *remote = NULL;
@@ -130,6 +136,11 @@ int fetch(git_repository *repo, int argc, char **argv)
pthread_join(worker, NULL);
#endif
+ /**
+ * If there are local objects (we got a thin pack), then tell
+ * the use how many objets we saved from having to cross the
+ * network.
+ */
if (stats->local_objects > 0) {
printf("\rReceived %d/%d objects in %zu bytes (used %d local objects)\n",
stats->indexed_objects, stats->total_objects, stats->received_bytes, stats->local_objects);
diff --git a/examples/network/ls-remote.c b/examples/network/ls-remote.c
index b65759e..18cd023 100644
--- a/examples/network/ls-remote.c
+++ b/examples/network/ls-remote.c
@@ -4,6 +4,7 @@
#include <string.h>
#include "common.h"
+/** Callback to show each item */
static int show_ref__cb(git_remote_head *head, void *payload)
{
char oid[GIT_OID_HEXSZ + 1] = {0};
@@ -28,6 +29,10 @@ static int use_remote(git_repository *repo, char *name)
goto cleanup;
}
+ /**
+ * Connect to the remote and call the printing function for
+ * each of the remote references.
+ */
callbacks.credentials = cred_acquire_cb;
git_remote_set_callbacks(remote, &callbacks);
@@ -42,9 +47,7 @@ cleanup:
return error;
}
-// This gets called to do the work. The remote can be given either as
-// the name of a configured remote or an URL.
-
+/** Entry point for this command */
int ls_remote(git_repository *repo, int argc, char **argv)
{
int error;