Merge branch 'jk/fetch-pack' into maint
[git.git] / Documentation / git-request-pull.txt
blob283577b0b6ca1ef7a35758686edf548025e6db76
1 git-request-pull(1)
2 ===================
4 NAME
5 ----
6 git-request-pull - Generates a summary of pending changes
8 SYNOPSIS
9 --------
10 [verse]
11 'git request-pull' [-p] <start> <url> [<end>]
13 DESCRIPTION
14 -----------
16 Generate a request asking your upstream project to pull changes into
17 their tree.  The request, printed to the standard output, summarizes
18 the changes and indicates from where they can be pulled.
20 The upstream project is expected to have the commit named by
21 `<start>` and the output asks it to integrate the changes you made
22 since that commit, up to the commit named by `<end>`, by visiting
23 the repository named by `<url>`.
26 OPTIONS
27 -------
28 -p::
29         Include patch text in the output.
31 <start>::
32         Commit to start at.  This names a commit that is already in
33         the upstream history.
35 <url>::
36         The repository URL to be pulled from.
38 <end>::
39         Commit to end at (defaults to HEAD).  This names the commit
40         at the tip of the history you are asking to be pulled.
42 When the repository named by `<url>` has the commit at a tip of a
43 ref that is different from the ref you have locally, you can use the
44 `<local>:<remote>` syntax, to have its local name, a colon `:`, and
45 its remote name.
48 EXAMPLE
49 -------
51 Imagine that you built your work on your `master` branch on top of
52 the `v1.0` release, and want it to be integrated to the project.
53 First you push that change to your public repository for others to
54 see:
56         git push https://git.ko.xz/project master
58 Then, you run this command:
60         git request-pull v1.0 https://git.ko.xz/project master
62 which will produce a request to the upstream, summarizing the
63 changes between the `v1.0` release and your `master`, to pull it
64 from your public repository.
66 If you pushed your change to a branch whose name is different from
67 the one you have locally, e.g.
69         git push https://git.ko.xz/project master:for-linus
71 then you can ask that to be pulled with
73         git request-pull v1.0 https://git.ko.xz/project master:for-linus
76 GIT
77 ---
78 Part of the linkgit:git[1] suite