From: Junio C Hamano <junkio@cox.net>
To: Linus Torvalds <torvalds@osdl.org>
Cc: git@vger.kernel.org
Subject: [PATCH 9/9] Add a bit of developer documentation to pull.h
Date: Sat, 25 Jun 2005 02:26:29 -0700 [thread overview]
Message-ID: <7v4qbm3hyy.fsf_-_@assigned-by-dhcp.cox.net> (raw)
In-Reply-To: <7vmzpe4x08.fsf_-_@assigned-by-dhcp.cox.net> (Junio C. Hamano's message of "Sat, 25 Jun 2005 02:16:23 -0700")
Describe what to implement in fetch() and fetch_ref() for
pull backend writers a bit better.
Signed-off-by: Junio C Hamano <junkio@cox.net>
---
pull.h | 21 +++++++++++++++------
1 files changed, 15 insertions(+), 6 deletions(-)
190061e326b73dcf76d301d8b17ce96c783d7251
diff --git a/pull.h b/pull.h
--- a/pull.h
+++ b/pull.h
@@ -1,24 +1,33 @@
#ifndef PULL_H
#define PULL_H
-/** To be provided by the particular implementation. **/
+/*
+ * Fetch object given SHA1 from the remote, and store it locally under
+ * GIT_OBJECT_DIRECTORY. Return 0 on success, -1 on failure. To be
+ * provided by the particular implementation.
+ */
extern int fetch(unsigned char *sha1);
+/*
+ * Fetch ref (relative to $GIT_DIR/refs) from the remote, and store
+ * the 20-byte SHA1 in sha1. Return 0 on success, -1 on failure. To
+ * be provided by the particular implementation.
+ */
extern int fetch_ref(char *ref, unsigned char *sha1);
-/** If set, the ref filename to write the target value to. **/
+/* If set, the ref filename to write the target value to. */
extern const char *write_ref;
-/** If set, the hash that the current value of write_ref must be. **/
+/* If set, the hash that the current value of write_ref must be. */
extern const unsigned char *current_ref;
-/** Set to fetch the target tree. */
+/* Set to fetch the target tree. */
extern int get_tree;
-/** Set to fetch the commit history. */
+/* Set to fetch the commit history. */
extern int get_history;
-/** Set to fetch the trees in the commit history. **/
+/* Set to fetch the trees in the commit history. */
extern int get_all;
/* Set to zero to skip the check for delta object base;
------------
next prev parent reply other threads:[~2005-06-25 9:21 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2005-06-23 23:20 [PATCH 0/2] D/F conflicts fixes Junio C Hamano
2005-06-23 23:25 ` [PATCH 1/2] Add more tests for read-tree --emu23 Junio C Hamano
2005-06-24 23:40 ` [PATCH 2/2] Fix oversimplified optimization for add_cache_entry() Junio C Hamano
2005-06-25 0:57 ` Linus Torvalds
2005-06-25 2:40 ` Junio C Hamano
2005-06-25 9:16 ` [PATCH 0/9] " Junio C Hamano
2005-06-25 9:21 ` [PATCH 1/9] fix date parsing for GIT raw commit timestamp format Junio C Hamano
2005-06-25 9:22 ` [PATCH 2/9] git-commit-script: get commit message from an existing one Junio C Hamano
2005-06-25 9:22 ` [PATCH 3/9] git-cherry: find commits not merged upstream Junio C Hamano
2005-06-25 9:23 ` [PATCH 4/9] git-rebase-script: rebase local commits to new upstream head Junio C Hamano
2005-06-25 9:24 ` [PATCH 5/9] Add more tests for read-tree --emu23 Junio C Hamano
2005-06-25 9:24 ` [PATCH 6/9] git-merge-one-file-script: do not misinterpret rm failure Junio C Hamano
2005-06-25 9:25 ` [PATCH 7/9] Fix oversimplified optimization for add_cache_entry() Junio C Hamano
2005-06-25 9:25 ` [PATCH 8/9] http-pull: documentation updates Junio C Hamano
2005-06-25 9:26 ` Junio C Hamano [this message]
2005-06-26 1:02 ` [RFD] consider "git" wrapper semi-Porcelain Junio C Hamano
2005-06-26 1:21 ` Linus Torvalds
2005-06-26 12:02 ` Junio C Hamano
2005-06-26 12:36 ` Martijn Kuipers
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=7v4qbm3hyy.fsf_-_@assigned-by-dhcp.cox.net \
--to=junkio@cox.net \
--cc=git@vger.kernel.org \
--cc=torvalds@osdl.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).