Documentation/git-request-pull.txt

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