utils-code/tj.git-extras
1
0
Fork 0
mirror of https://github.com/tj/git-extras.git synced 2026-09-10 07:26:17 -04:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Update doc

Browse source
This commit is contained in:
vyas 2020-08-05 16:53:36 +05:30
parent a0d7039482
commit 85e1c4ff0a
3 changed files with 38 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
man/git-pull-request.1
View file

@ -1,30 +1,28 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "GIT\-PULL\-REQUEST" "1" "November 2017" "" "Git Extras"
.
.\" generated with Ronn-NG/v0.8.0
.\" http://github.com/apjanke/ronn-ng/tree/0.8.0
.TH "GIT\-PULL\-REQUEST" "1" "August 2020" "" "Git Extras"
.SH "NAME"
\fBgit\-pull\-request\fR \- Create pull request for GitHub project
.
.SH "SYNOPSIS"
\fBgit\-pull\-request\fR [<target branch>]
.
.SH "DESCRIPTION"
Create pull request for a project on GitHub via command line\.
.
.P
Uses the email from \fBgit config user\.email\fR to open the pull request\.
.
.P
Personal access token is required for making API call to open the pull request\.
.P
Makre sure the personal access token has the right \fBOAuth\fR scopes for the repo(s)
.P
use \fBgit config \-\-global \-\-add git\-extras\.personal\-access\-token <your\-personal\-access\-token>\fR
.P
if using mutiple accounts, override the global value in the specific repo using \fBgit config git\-extras\.personal\-access\-token <other\-acc\-personal\-access\-token>\fR
.SH "OPTIONS"
<target branch>
.
.P
The target branch you want to send pull request to\.
.
.SH "EXAMPLES"
.
.nf
$ git pull\-request master
Everything up\-to\-date
@ -35,16 +33,11 @@ Everything up\-to\-date
base [master]:
GitHub two\-factor authentication code (leave blank if not set up):
Enter host password for user \'spacewanderlzx@gmail\.com\':
\.\.\.
.
\|\.\|\.\|\.
.fi
.
.SH "AUTHOR"
Written by Tj Holowaychuk <\fItj@vision\-media\.ca\fR>
.
Written by Tj Holowaychuk <\fI\%mailto:tj@vision\-media\.ca\fR>
.SH "REPORTING BUGS"
<\fIhttps://github\.com/tj/git\-extras/issues\fR>
.
<\fI\%https://github\.com/tj/git\-extras/issues\fR>
.SH "SEE ALSO"
<\fIhttps://github\.com/tj/git\-extras\fR>
<\fI\%https://github\.com/tj/git\-extras\fR>

23
man/git-pull-request.html
View file

@ -1,8 +1,8 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv='content-type' value='text/html;charset=utf8'>
<meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
<meta http-equiv='content-type' content='text/html;charset=utf8'>
<meta name='generator' content='Ronn-NG/v0.8.0 (http://github.com/apjanke/ronn-ng/tree/0.8.0)'>
<title>git-pull-request(1) - Create pull request for GitHub project</title>
<style type='text/css' media='all'>
/* style: man */
@ -69,11 +69,12 @@
<li class='tr'>git-pull-request(1)</li>
</ol>
<h2 id="NAME">NAME</h2>
<h2 id="NAME">NAME</h2>
<p class="man-name">
<code>git-pull-request</code> - <span class="man-whatis">Create pull request for GitHub project</span>
</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
<p><code>git-pull-request</code> [&lt;target branch&gt;]</p>
@ -84,6 +85,14 @@
<p>Uses the email from <code>git config user.email</code> to open the pull request.</p>
<p>Personal access token is required for making API call to open the pull request.</p>
<p>Makre sure the personal access token has the right <code>OAuth</code> scopes for the repo(s)</p>
<p>use <code>git config --global --add git-extras.personal-access-token &lt;your-personal-access-token&gt;</code></p>
<p>if using mutiple accounts, override the global value in the specific repo using <code>git config git-extras.personal-access-token &lt;other-acc-personal-access-token&gt;</code></p>
<h2 id="OPTIONS">OPTIONS</h2>
<p>&lt;target branch&gt;</p>
@ -102,13 +111,12 @@ Everything up-to-date
base [master]:
GitHub two-factor authentication code (leave blank if not set up):
Enter host password for user 'spacewanderlzx@gmail.com':
...
</code></pre>
<h2 id="AUTHOR">AUTHOR</h2>
<p>Written by Tj Holowaychuk &lt;<a href="&#109;&#x61;&#105;&#x6c;&#x74;&#111;&#58;&#x74;&#x6a;&#x40;&#118;&#105;&#115;&#105;&#111;&#110;&#x2d;&#x6d;&#x65;&#x64;&#x69;&#x61;&#46;&#99;&#x61;" data-bare-link="true">&#116;&#106;&#64;&#x76;&#105;&#x73;&#x69;&#x6f;&#110;&#x2d;&#109;&#101;&#x64;&#x69;&#97;&#46;&#99;&#97;</a>&gt;</p>
<p>Written by Tj Holowaychuk &lt;<a href="mailto:tj@vision-media.ca" data-bare-link="true">tj@vision-media.ca</a>&gt;</p>
<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
@ -118,10 +126,9 @@ Enter host password for user 'spacewanderlzx@gmail.com':
<p>&lt;<a href="https://github.com/tj/git-extras" data-bare-link="true">https://github.com/tj/git-extras</a>&gt;</p>
<ol class='man-decor man-foot man foot'>
<li class='tl'></li>
<li class='tc'>November 2017</li>
<li class='tc'>August 2020</li>
<li class='tr'>git-pull-request(1)</li>
</ol>

9
man/git-pull-request.md
View file

@ -11,6 +11,14 @@ Create pull request for a project on GitHub via command line.
Uses the email from `git config user.email` to open the pull request.
Personal access token is required for making API call to open the pull request.
Makre sure the personal access token has the right `OAuth` scopes for the repo(s)
use `git config --global --add git-extras.personal-access-token <your-personal-access-token>`
if using mutiple accounts, override the global value in the specific repo using `git config git-extras.personal-access-token <other-acc-personal-access-token>`
## OPTIONS
&lt;target branch&gt;
@ -30,7 +38,6 @@ Everything up-to-date
base [master]:
GitHub two-factor authentication code (leave blank if not set up):
Enter host password for user 'spacewanderlzx@gmail.com':
...
```