man1/git-request-pull.1

   1 '\" t
   2 .\"     Title: git-request-pull
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 02/17/2022
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.35.1.225.ge2ac9141e6
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-REQUEST\-PULL" "1" "02/17/2022" "Git 2\&.35\&.1\&.225\&.ge2ac91" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-request-pull \- Generates a summary of pending changes
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit request\-pull\fR [\-p] <start> <URL> [<end>]
  36 .fi
  37 .sp
  38 .SH "DESCRIPTION"
  39 .sp
  40 Generate a request asking your upstream project to pull changes into their tree\&. The request, printed to the standard output, begins with the branch description, summarizes the changes and indicates from where they can be pulled\&.
  41 .sp
  42 The upstream project is expected to have the commit named by \fB<start>\fR and the output asks it to integrate the changes you made since that commit, up to the commit named by \fB<end>\fR, by visiting the repository named by \fB<URL>\fR\&.
  43 .SH "OPTIONS"
  44 .PP
  45 \-p
  46 .RS 4
  47 Include patch text in the output\&.
  48 .RE
  49 .PP
  50 <start>
  51 .RS 4
  52 Commit to start at\&. This names a commit that is already in the upstream history\&.
  53 .RE
  54 .PP
  55 <URL>
  56 .RS 4
  57 The repository URL to be pulled from\&.
  58 .RE
  59 .PP
  60 <end>
  61 .RS 4
  62 Commit to end at (defaults to HEAD)\&. This names the commit at the tip of the history you are asking to be pulled\&.
  63 .sp
  64 When the repository named by
  65 \fB<URL>\fR
  66 has the commit at a tip of a ref that is different from the ref you have locally, you can use the
  67 \fB<local>:<remote>\fR
  68 syntax, to have its local name, a colon
  69 \fB:\fR, and its remote name\&.
  70 .RE
  71 .SH "EXAMPLES"
  72 .sp
  73 Imagine that you built your work on your \fBmaster\fR branch on top of the \fBv1\&.0\fR release, and want it to be integrated to the project\&. First you push that change to your public repository for others to see:
  74 .sp
  75 .if n \{\
  76 .RS 4
  77 .\}
  78 .nf
  79 git push https://git\&.ko\&.xz/project master
  80 .fi
  81 .if n \{\
  82 .RE
  83 .\}
  84 .sp
  85 Then, you run this command:
  86 .sp
  87 .if n \{\
  88 .RS 4
  89 .\}
  90 .nf
  91 git request\-pull v1\&.0 https://git\&.ko\&.xz/project master
  92 .fi
  93 .if n \{\
  94 .RE
  95 .\}
  96 .sp
  97 which will produce a request to the upstream, summarizing the changes between the \fBv1\&.0\fR release and your \fBmaster\fR, to pull it from your public repository\&.
  98 .sp
  99 If you pushed your change to a branch whose name is different from the one you have locally, e\&.g\&.
 100 .sp
 101 .if n \{\
 102 .RS 4
 103 .\}
 104 .nf
 105 git push https://git\&.ko\&.xz/project master:for\-linus
 106 .fi
 107 .if n \{\
 108 .RE
 109 .\}
 110 .sp
 111 then you can ask that to be pulled with
 112 .sp
 113 .if n \{\
 114 .RS 4
 115 .\}
 116 .nf
 117 git request\-pull v1\&.0 https://git\&.ko\&.xz/project master:for\-linus
 118 .fi
 119 .if n \{\
 120 .RE
 121 .\}
 122 .SH "GIT"
 123 .sp
 124 Part of the \fBgit\fR(1) suite