From 63aff4fed94355889be98ad44371e29942ff70e4 Mon Sep 17 00:00:00 2001 From: Daniel Barkalow Date: Mon, 6 Jun 2005 22:30:39 -0400 Subject: [PATCH] Document git-ssh-pull and git-ssh-push This fixes the documentation for git-ssh-push, as called by users (if you run git-ssh-pull or git-ssh-push on one machine, the other runs on the other machine, and they transfer data in the specified direction). This also adds documentation for the -w option and for using filenames for the commit-id (which does what you'd want: uses the source side's value, not the value already on the target, even if you're running it on the target). It also credits me with the programs and the documentation for git-ssh-push. Someone who knows asciidoc should make sure I didn't mess up the formatting. I'm only sure of the ascii part. Signed-off-by: Daniel Barkalow Signed-off-by: Linus Torvalds --- Documentation/git-ssh-pull.txt | 17 +++++++++++++---- Documentation/git-ssh-push.txt | 39 ++++++++++++++++++++++++++++++++------- 2 files changed, 45 insertions(+), 11 deletions(-) (limited to 'Documentation') diff --git a/Documentation/git-ssh-pull.txt b/Documentation/git-ssh-pull.txt index a0dade00a..3397fba83 100644 --- a/Documentation/git-ssh-pull.txt +++ b/Documentation/git-ssh-pull.txt @@ -10,15 +10,21 @@ git-ssh-pull - Pulls from a remote repository over ssh connection SYNOPSIS -------- -'git-ssh-pull' [-c] [-t] [-a] [-d] [-v] [--recover] commit-id url +'git-ssh-pull' [-c] [-t] [-a] [-d] [-v] [-w filename] [--recover] commit-id url DESCRIPTION ----------- -Pulls from a remote repository over ssh connection, invoking git-ssh-push -on the other end. +Pulls from a remote repository over ssh connection, invoking +git-ssh-push on the other end. It functions identically to +git-ssh-push, aside from which end you run it on. + OPTIONS ------- +commit-id:: + Either the hash or the filename under [URL]/refs/ to + pull. + -c:: Get the commit objects. -t:: @@ -34,11 +40,14 @@ OPTIONS usual, to recover after earlier pull that was interrupted. -v:: Report what is downloaded. +-w:: + Writes the commit-id into the filename under $GIT_DIR/refs/ on + the local end after the transfer is complete. Author ------ -Written by Linus Torvalds +Written by Daniel Barkalow Documentation -------------- diff --git a/Documentation/git-ssh-push.txt b/Documentation/git-ssh-push.txt index 4fe850869..c55ce7dd6 100644 --- a/Documentation/git-ssh-push.txt +++ b/Documentation/git-ssh-push.txt @@ -1,28 +1,53 @@ git-ssh-push(1) =============== -v0.1, May 2005 +v0.1, Jun 2005 NAME ---- -git-ssh-push - Helper "server-side" program used by git-ssh-pull +git-ssh-push - Pushes to a remote repository over ssh connection SYNOPSIS -------- -'git-ssh-push' +'git-ssh-push' [-c] [-t] [-a] [-d] [-v] [-w filename] [--recover] commit-id url DESCRIPTION ----------- -Helper "server-side" program used by git-ssh-pull. - +Pushes from a remote repository over ssh connection, invoking +git-ssh-pull on the other end. It functions identically to +git-ssh-pull, aside from which end you run it on. + +OPTIONS +------- +commit-id:: + Either the hash or the filename under $GIT_DIR/refs/ to push. + +-c:: + Get the commit objects. +-t:: + Get tree associated with the requested commit object. +-a:: + Get all the objects. +-d:: + Do not check for delta base objects (use this option + only when you know the local repository is not + deltified). +--recover:: + Check dependency of deltified object more carefully than + usual, to recover after earlier push that was interrupted. +-v:: + Report what is uploaded. +-w:: + Writes the commit-id into the filename under [URL]/refs/ on + the remote end after the transfer is complete. Author ------ -Written by Linus Torvalds +Written by Daniel Barkalow Documentation -------------- -Documentation by David Greaves, Junio C Hamano and the git-list . +Documentation by Daniel Barkalow GIT --- -- cgit v1.2.1