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 v1.79.2 <http://docbook.sf.net/>
   5 .\"      Date: 2024-08-14
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.46.0.164.g477ce5ccd6
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-REQUEST\-PULL" "1" "2024-08-14" "Git 2\&.46\&.0\&.164\&.g477ce5" "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 .SH "DESCRIPTION"
  38 .sp
  39 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\&.
  40 .sp
  41 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\&.
  42 .SH "OPTIONS"
  43 .PP
  44 \-p
  45 .RS 4
  46 Include patch text in the output\&.
  47 .RE
  48 .PP
  49 <start>
  50 .RS 4
  51 Commit to start at\&. This names a commit that is already in the upstream history\&.
  52 .RE
  53 .PP
  54 <URL>
  55 .RS 4
  56 The repository URL to be pulled from\&.
  57 .RE
  58 .PP
  59 <end>
  60 .RS 4
  61 Commit to end at (defaults to HEAD)\&. This names the commit at the tip of the history you are asking to be pulled\&.
  62 .sp
  63 When the repository named by
  64 \fB<URL>\fR
  65 has the commit at a tip of a ref that is different from the ref you have locally, you can use the
  66 \fB<local>:<remote>\fR
  67 syntax, to have its local name, a colon
  68 \fB:\fR, and its remote name\&.
  69 .RE
  70 .SH "EXAMPLES"
  71 .sp
  72 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 into the project\&. First you push that change to your public repository for others to see:
  73 .sp
  74 .if n \{\
  75 .RS 4
  76 .\}
  77 .nf
  78 git push https://git\&.ko\&.xz/project master
  79 .fi
  80 .if n \{\
  81 .RE
  82 .\}
  83 .sp
  84 Then, you run this command:
  85 .sp
  86 .if n \{\
  87 .RS 4
  88 .\}
  89 .nf
  90 git request\-pull v1\&.0 https://git\&.ko\&.xz/project master
  91 .fi
  92 .if n \{\
  93 .RE
  94 .\}
  95 .sp
  96 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\&.
  97 .sp
  98 If you pushed your change to a branch whose name is different from the one you have locally, e\&.g\&.
  99 .sp
 100 .if n \{\
 101 .RS 4
 102 .\}
 103 .nf
 104 git push https://git\&.ko\&.xz/project master:for\-linus
 105 .fi
 106 .if n \{\
 107 .RE
 108 .\}
 109 .sp
 110 then you can ask that to be pulled with
 111 .sp
 112 .if n \{\
 113 .RS 4
 114 .\}
 115 .nf
 116 git request\-pull v1\&.0 https://git\&.ko\&.xz/project master:for\-linus
 117 .fi
 118 .if n \{\
 119 .RE
 120 .\}
 121 .SH "GIT"
 122 .sp
 123 Part of the \fBgit\fR(1) suite