* [PATCH 1/3] Docs: split up pull-fetch-param.txt
@ 2006-02-07 3:22 J. Bruce Fields
2006-02-07 3:22 ` [PATCH 2/3] Docs: move git url and remotes text to separate sections J. Bruce Fields
0 siblings, 1 reply; 3+ messages in thread
From: J. Bruce Fields @ 2006-02-07 3:22 UTC (permalink / raw)
To: Junio C Hamano; +Cc: git
The push and pull man pages include a bunch of shared text from
pull-fetch-param.txt. This simplifies maintenance somewhat, but
there's actually quite a bit of text that applies only to one or the
other.
So, separate out the push- and pull/fetch-specific text into
pull-fetch-param.txt and git-push.txt, then include the largest chunk
of common stuff (the description of protocols and url's) from
urls.txt. That cuts some irrelevant stuff from the man pages without
making us duplicate too much.
Signed-off-by: J. Bruce Fields <bfields@citi•umich.edu>
---
Documentation/git-push.txt | 27 +++++++++++
Documentation/pull-fetch-param.txt | 86 +++---------------------------------
Documentation/urls.txt | 62 ++++++++++++++++++++++++++
3 files changed, 94 insertions(+), 81 deletions(-)
create mode 100644 Documentation/urls.txt
be7ed0ba1dc97ad215f0785095930902597ca886
diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt
index a0ef61d..7e9452e 100644
--- a/Documentation/git-push.txt
+++ b/Documentation/git-push.txt
@@ -23,7 +23,32 @@ documentation for gitlink:git-receive-pa
OPTIONS
-------
-include::pull-fetch-param.txt[]
+<repository>::
+ The "remote" repository that is destination of a push operation.
+include::urls.txt[]
+
+<refspec>::
+ The canonical format of a <refspec> parameter is
+ `+?<src>:<dst>`; that is, an optional plus `+`, followed
+ by the source ref, followed by a colon `:`, followed by
+ the destination ref.
++
+The <src> side can be an
+arbitrary "SHA1 expression" that can be used as an
+argument to `git-cat-file -t`. E.g. `master~4` (push
+four parents before the current master head).
++
+The local ref that matches <src> is used
+to fast forward the remote ref that matches <dst>. If
+the optional plus `+` is used, the remote ref is updated
+even if it does not result in a fast forward update.
++
+Some short-cut notations are also supported.
++
+* `tag <tag>` means the same as `refs/tags/<tag>:refs/tags/<tag>`.
+* A parameter <ref> without a colon is equivalent to
+ <ref>`:`<ref>, hence updates <ref> in the destination from <ref>
+ in the source.
\--all::
Instead of naming each ref to push, specifies all refs
diff --git a/Documentation/pull-fetch-param.txt b/Documentation/pull-fetch-param.txt
index 4524fee..9011ffb 100644
--- a/Documentation/pull-fetch-param.txt
+++ b/Documentation/pull-fetch-param.txt
@@ -1,68 +1,7 @@
<repository>::
The "remote" repository that is the source of a fetch
- or pull operation, or the destination of a push operation.
- One of the following notations can be used
- to name the remote repository:
-+
-===============================================================
-- rsync://host.xz/path/to/repo.git/
-- http://host.xz/path/to/repo.git/
-- https://host.xz/path/to/repo.git/
-- git://host.xz/path/to/repo.git/
-- git://host.xz/~user/path/to/repo.git/
-- ssh://host.xz/path/to/repo.git/
-- ssh://host.xz/~user/path/to/repo.git/
-- ssh://host.xz/~/path/to/repo.git
-===============================================================
-+
-SSH Is the default transport protocol and also supports an
-scp-like syntax. Both syntaxes support username expansion,
-as does the native git protocol. The following three are
-identical to the last three above, respectively:
-+
-===============================================================
-- host.xz:/path/to/repo.git/
-- host.xz:~user/path/to/repo.git/
-- host.xz:path/to/repo.git
-===============================================================
-+
-To sync with a local directory, use:
-+
-===============================================================
-- /path/to/repo.git/
-===============================================================
-+
-In addition to the above, as a short-hand, the name of a
-file in `$GIT_DIR/remotes` directory can be given; the
-named file should be in the following format:
-+
- URL: one of the above URL format
- Push: <refspec>
- Pull: <refspec>
-+
-When such a short-hand is specified in place of
-<repository> without <refspec> parameters on the command
-line, <refspec> specified on `Push:` lines or `Pull:`
-lines are used for `git-push` and `git-fetch`/`git-pull`,
-respectively. Multiple `Push:` and and `Pull:` lines may
-be specified for additional branch mappings.
-+
-The name of a file in `$GIT_DIR/branches` directory can be
-specified as an older notation short-hand; the named
-file should contain a single line, a URL in one of the
-above formats, optionally followed by a hash `#` and the
-name of remote head (URL fragment notation).
-`$GIT_DIR/branches/<remote>` file that stores a <url>
-without the fragment is equivalent to have this in the
-corresponding file in the `$GIT_DIR/remotes/` directory.
-+
- URL: <url>
- Pull: refs/heads/master:<remote>
-+
-while having `<url>#<head>` is equivalent to
-+
- URL: <url>
- Pull: refs/heads/<head>:<remote>
+ or pull operation.
+include::urls.txt[]
<refspec>::
The canonical format of a <refspec> parameter is
@@ -70,17 +9,7 @@ while having `<url>#<head>` is equivalen
by the source ref, followed by a colon `:`, followed by
the destination ref.
+
-When used in `git-push`, the <src> side can be an
-arbitrary "SHA1 expression" that can be used as an
-argument to `git-cat-file -t`. E.g. `master~4` (push
-four parents before the current master head).
-+
-For `git-push`, the local ref that matches <src> is used
-to fast forward the remote ref that matches <dst>. If
-the optional plus `+` is used, the remote ref is updated
-even if it does not result in a fast forward update.
-+
-For `git-fetch` and `git-pull`, the remote ref that matches <src>
+The remote ref that matches <src>
is fetched, and if <dst> is not empty string, the local
ref that matches it is fast forwarded using <src>.
Again, if the optional plus `+` is used, the local ref
@@ -135,10 +64,7 @@ is often useful.
Some short-cut notations are also supported.
+
* `tag <tag>` means the same as `refs/tags/<tag>:refs/tags/<tag>`;
- used with pull or fetch, it requests fetching everything up to
- the given tag.
+ it requests fetching everything up to the given tag.
* A parameter <ref> without a colon is equivalent to
- <ref>: when pulling/fetching, and <ref>`:`<ref> when
- pushing. That is, do not store it locally if
- fetching, and update the same name if pushing.
-
+ <ref>: when pulling/fetching, so it merges <ref> into the current
+ branch without storing the remote branch anywhere locally
diff --git a/Documentation/urls.txt b/Documentation/urls.txt
new file mode 100644
index 0000000..e027c71
--- /dev/null
+++ b/Documentation/urls.txt
@@ -0,0 +1,62 @@
+One of the following notations can be used
+to name the remote repository:
++
+===============================================================
+- rsync://host.xz/path/to/repo.git/
+- http://host.xz/path/to/repo.git/
+- https://host.xz/path/to/repo.git/
+- git://host.xz/path/to/repo.git/
+- git://host.xz/~user/path/to/repo.git/
+- ssh://host.xz/path/to/repo.git/
+- ssh://host.xz/~user/path/to/repo.git/
+- ssh://host.xz/~/path/to/repo.git
+===============================================================
++
+SSH Is the default transport protocol and also supports an
+scp-like syntax. Both syntaxes support username expansion,
+as does the native git protocol. The following three are
+identical to the last three above, respectively:
++
+===============================================================
+- host.xz:/path/to/repo.git/
+- host.xz:~user/path/to/repo.git/
+- host.xz:path/to/repo.git
+===============================================================
++
+To sync with a local directory, use:
++
+===============================================================
+- /path/to/repo.git/
+===============================================================
++
+In addition to the above, as a short-hand, the name of a
+file in `$GIT_DIR/remotes` directory can be given; the
+named file should be in the following format:
++
+ URL: one of the above URL format
+ Push: <refspec>
+ Pull: <refspec>
++
+When such a short-hand is specified in place of
+<repository> without <refspec> parameters on the command
+line, <refspec> specified on `Push:` lines or `Pull:`
+lines are used for `git-push` and `git-fetch`/`git-pull`,
+respectively. Multiple `Push:` and and `Pull:` lines may
+be specified for additional branch mappings.
++
+The name of a file in `$GIT_DIR/branches` directory can be
+specified as an older notation short-hand; the named
+file should contain a single line, a URL in one of the
+above formats, optionally followed by a hash `#` and the
+name of remote head (URL fragment notation).
+`$GIT_DIR/branches/<remote>` file that stores a <url>
+without the fragment is equivalent to have this in the
+corresponding file in the `$GIT_DIR/remotes/` directory.
++
+ URL: <url>
+ Pull: refs/heads/master:<remote>
++
+while having `<url>#<head>` is equivalent to
++
+ URL: <url>
+ Pull: refs/heads/<head>:<remote>
--
0.99.8b.g3480-dirty
^ permalink raw reply related [flat|nested] 3+ messages in thread
* [PATCH 2/3] Docs: move git url and remotes text to separate sections
2006-02-07 3:22 [PATCH 1/3] Docs: split up pull-fetch-param.txt J. Bruce Fields
@ 2006-02-07 3:22 ` J. Bruce Fields
2006-02-07 3:22 ` [PATCH 3/3] Docs: minor git-push copyediting J. Bruce Fields
0 siblings, 1 reply; 3+ messages in thread
From: J. Bruce Fields @ 2006-02-07 3:22 UTC (permalink / raw)
To: Junio C Hamano; +Cc: git
The sections on git urls and remotes files in the git-fetch,
git-pull, and git-push manpages seem long enough to be worth a
manpage section of their own.
Signed-off-by: J. Bruce Fields <bfields@citi•umich.edu>
---
Documentation/git-fetch.txt | 2 +-
Documentation/git-pull.txt | 3 ++-
Documentation/git-push.txt | 5 +++--
Documentation/pull-fetch-param.txt | 3 +--
Documentation/urls.txt | 32 +++++++++++++++++++-------------
5 files changed, 26 insertions(+), 19 deletions(-)
6f35b7d338781d0ad18980045cdc6ff4fe0a7b98
diff --git a/Documentation/git-fetch.txt b/Documentation/git-fetch.txt
index d1b45f9..a67dc34 100644
--- a/Documentation/git-fetch.txt
+++ b/Documentation/git-fetch.txt
@@ -27,7 +27,7 @@ include::fetch-options.txt[]
include::pull-fetch-param.txt[]
-
+include::urls.txt[]
SEE ALSO
--------
diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt
index 3a7d385..20175f4 100644
--- a/Documentation/git-pull.txt
+++ b/Documentation/git-pull.txt
@@ -29,8 +29,9 @@ include::fetch-options.txt[]
include::pull-fetch-param.txt[]
-include::merge-strategies.txt[]
+include::urls.txt[]
+include::merge-strategies.txt[]
EXAMPLES
--------
diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt
index 7e9452e..ce909f5 100644
--- a/Documentation/git-push.txt
+++ b/Documentation/git-push.txt
@@ -24,8 +24,8 @@ documentation for gitlink:git-receive-pa
OPTIONS
-------
<repository>::
- The "remote" repository that is destination of a push operation.
-include::urls.txt[]
+ The "remote" repository that is destination of a push
+ operation. See the section <<URLS,GIT URLS>> below.
<refspec>::
The canonical format of a <refspec> parameter is
@@ -65,6 +65,7 @@ Some short-cut notations are also suppor
This flag disables the check. This can cause the
remote repository to lose commits; use it with care.
+include::urls.txt[]
Author
------
diff --git a/Documentation/pull-fetch-param.txt b/Documentation/pull-fetch-param.txt
index 9011ffb..e852f41 100644
--- a/Documentation/pull-fetch-param.txt
+++ b/Documentation/pull-fetch-param.txt
@@ -1,7 +1,6 @@
<repository>::
The "remote" repository that is the source of a fetch
- or pull operation.
-include::urls.txt[]
+ or pull operation. See the section <<URLS,GIT URLS>> below.
<refspec>::
The canonical format of a <refspec> parameter is
diff --git a/Documentation/urls.txt b/Documentation/urls.txt
index e027c71..7477413 100644
--- a/Documentation/urls.txt
+++ b/Documentation/urls.txt
@@ -1,6 +1,9 @@
+GIT URLS[[URLS]]
+----------------
+
One of the following notations can be used
to name the remote repository:
-+
+
===============================================================
- rsync://host.xz/path/to/repo.git/
- http://host.xz/path/to/repo.git/
@@ -11,39 +14,42 @@ to name the remote repository:
- ssh://host.xz/~user/path/to/repo.git/
- ssh://host.xz/~/path/to/repo.git
===============================================================
-+
+
SSH Is the default transport protocol and also supports an
scp-like syntax. Both syntaxes support username expansion,
as does the native git protocol. The following three are
identical to the last three above, respectively:
-+
+
===============================================================
- host.xz:/path/to/repo.git/
- host.xz:~user/path/to/repo.git/
- host.xz:path/to/repo.git
===============================================================
-+
+
To sync with a local directory, use:
-+
+
===============================================================
- /path/to/repo.git/
===============================================================
-+
+
+REMOTES
+-------
+
In addition to the above, as a short-hand, the name of a
file in `$GIT_DIR/remotes` directory can be given; the
named file should be in the following format:
-+
+
URL: one of the above URL format
Push: <refspec>
Pull: <refspec>
-+
-When such a short-hand is specified in place of
+
+Then such a short-hand is specified in place of
<repository> without <refspec> parameters on the command
line, <refspec> specified on `Push:` lines or `Pull:`
lines are used for `git-push` and `git-fetch`/`git-pull`,
respectively. Multiple `Push:` and and `Pull:` lines may
be specified for additional branch mappings.
-+
+
The name of a file in `$GIT_DIR/branches` directory can be
specified as an older notation short-hand; the named
file should contain a single line, a URL in one of the
@@ -52,11 +58,11 @@ name of remote head (URL fragment notati
`$GIT_DIR/branches/<remote>` file that stores a <url>
without the fragment is equivalent to have this in the
corresponding file in the `$GIT_DIR/remotes/` directory.
-+
+
URL: <url>
Pull: refs/heads/master:<remote>
-+
+
while having `<url>#<head>` is equivalent to
-+
+
URL: <url>
Pull: refs/heads/<head>:<remote>
--
0.99.8b.g3480-dirty
^ permalink raw reply related [flat|nested] 3+ messages in thread
* [PATCH 3/3] Docs: minor git-push copyediting
2006-02-07 3:22 ` [PATCH 2/3] Docs: move git url and remotes text to separate sections J. Bruce Fields
@ 2006-02-07 3:22 ` J. Bruce Fields
0 siblings, 0 replies; 3+ messages in thread
From: J. Bruce Fields @ 2006-02-07 3:22 UTC (permalink / raw)
To: Junio C Hamano; +Cc: git
Minor git-push copyediting
Signed-off-by: J. Bruce Fields <bfields@citi•umich.edu>
---
Documentation/git-push.txt | 6 +++---
1 files changed, 3 insertions(+), 3 deletions(-)
a9a95125f25c8f70fe52ab0e30fe5ff6473d7679
diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt
index ce909f5..5b89110 100644
--- a/Documentation/git-push.txt
+++ b/Documentation/git-push.txt
@@ -16,7 +16,7 @@ DESCRIPTION
Updates remote refs using local refs, while sending objects
necessary to complete the given refs.
-You can make "interesting" things to happen on the repository
+You can make interesting things happen to a repository
every time you push into it, by setting up 'hooks' there. See
documentation for gitlink:git-receive-pack[1].
@@ -51,8 +51,8 @@ Some short-cut notations are also suppor
in the source.
\--all::
- Instead of naming each ref to push, specifies all refs
- to be pushed.
+ Instead of naming each ref to push, specifies that all
+ refs be pushed.
\--tags::
All refs under `$GIT_DIR/refs/tags` are pushed, in
--
0.99.8b.g3480-dirty
^ permalink raw reply related [flat|nested] 3+ messages in thread
end of thread, other threads:[~2006-02-07 3:22 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2006-02-07 3:22 [PATCH 1/3] Docs: split up pull-fetch-param.txt J. Bruce Fields
2006-02-07 3:22 ` [PATCH 2/3] Docs: move git url and remotes text to separate sections J. Bruce Fields
2006-02-07 3:22 ` [PATCH 3/3] Docs: minor git-push copyediting J. Bruce Fields
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox