add missing git-obliterate documentation

This commit is contained in:
spacewander 2015-08-01 22:41:24 +08:00
parent 94bf129721
commit d5e10f6701
3 changed files with 235 additions and 0 deletions

64
man/git-obliterate.1 Normal file
View file

@ -0,0 +1,64 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "GIT\-OBLITERATE" "1" "August 2015" "" ""
.
.SH "NAME"
\fBgit\-obliterate\fR \- rewrite past commits to remove some files
.
.SH "SYNOPSIS"
git obliterate <files\.\.\.> [\-\- <rev\-list options\.\.\.>]
.
.SH "DESCRIPTION"
Completely remove some files from the repository, including past commits and tags\. WARNING! This command will rewirte the history similar to \fBgit rebase\fR(though it affects more)\. The rewritten history will have different object names for all the objects and will not converge with the original branch\. So \fBavoid using it on commits that you shared\fR\. And it will mess up stash, so \fBdon\'t have stash when you run \fBgit obliterate\fR\fR\.
.
.SH "OPTIONS"
You can pass rev\-list options to indicate the range of commits affected\. Those options need to be seperated with \'\-\-\' before them\. Run \fBgit help rev\-list\fR to see the acceptable options\.
.
.SH "Examples"
Remove \.secret from the repository:
.
.IP "" 4
.
.nf
$ git obliterate \.secret
.
.fi
.
.IP "" 0
.
.P
Remove \.secret from commits between origin and feature:
.
.IP "" 4
.
.nf
$ git obliterate \.secret \-\- feature ^origin
.
.fi
.
.IP "" 0
.
.P
Remove \.secret from commit abcdefg to commit 1234567
.
.IP "" 4
.
.nf
$ git obliterate \.secret \-\- abcdefg\.\.1234567
.
.fi
.
.IP "" 0
.
.SH "AUTHOR"
Written by <\fIbrianloveswords@gmail\.com\fR>
.
.SH "REPORTING BUG"
<\fIhttps://github\.com/tj/git\-extras/issues\fR>
.
.SH "SEE ALSO"
<\fIhttps://github\.com/tj/git\-extras\fR>

129
man/git-obliterate.1.html Normal file
View file

@ -0,0 +1,129 @@
<!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)'>
<title>git-obliterate(1) - rewrite past commits to remove some files</title>
<style type='text/css' media='all'>
/* style: man */
body#manpage {margin:0}
.mp {max-width:100ex;padding:0 9ex 1ex 4ex}
.mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
.mp h2 {margin:10px 0 0 0}
.mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
.mp h3 {margin:0 0 0 4ex}
.mp dt {margin:0;clear:left}
.mp dt.flush {float:left;width:8ex}
.mp dd {margin:0 0 0 9ex}
.mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
.mp pre {margin-bottom:20px}
.mp pre+h2,.mp pre+h3 {margin-top:22px}
.mp h2+pre,.mp h3+pre {margin-top:5px}
.mp img {display:block;margin:auto}
.mp h1.man-title {display:none}
.mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
.mp h2 {font-size:16px;line-height:1.25}
.mp h1 {font-size:20px;line-height:2}
.mp {text-align:justify;background:#fff}
.mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
.mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
.mp u {text-decoration:underline}
.mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
.mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
.mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
.mp b.man-ref {font-weight:normal;color:#434241}
.mp pre {padding:0 4ex}
.mp pre code {font-weight:normal;color:#434241}
.mp h2+pre,h3+pre {padding-left:0}
ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
ol.man-decor {width:100%}
ol.man-decor li.tl {text-align:left}
ol.man-decor li.tc {text-align:center;letter-spacing:4px}
ol.man-decor li.tr {text-align:right;float:right}
</style>
</head>
<!--
The following styles are deprecated and will be removed at some point:
div#man, div#man ol.man, div#man ol.head, div#man ol.man.
The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
.man-navigation should be used instead.
-->
<body id='manpage'>
<div class='mp' id='man'>
<div class='man-navigation' style='display:none'>
<a href="#NAME">NAME</a>
<a href="#SYNOPSIS">SYNOPSIS</a>
<a href="#DESCRIPTION">DESCRIPTION</a>
<a href="#OPTIONS">OPTIONS</a>
<a href="#Examples">Examples</a>
<a href="#AUTHOR">AUTHOR</a>
<a href="#REPORTING-BUG">REPORTING BUG</a>
<a href="#SEE-ALSO">SEE ALSO</a>
</div>
<ol class='man-decor man-head man head'>
<li class='tl'>git-obliterate(1)</li>
<li class='tc'></li>
<li class='tr'>git-obliterate(1)</li>
</ol>
<h2 id="NAME">NAME</h2>
<p class="man-name">
<code>git-obliterate</code> - <span class="man-whatis">rewrite past commits to remove some files</span>
</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
<p>git obliterate &lt;files...&gt; [-- &lt;rev-list options...&gt;]</p>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
<p>Completely remove some files from the repository, including past commits and tags.
WARNING! This command will rewirte the history similar to <code>git rebase</code>(though it affects more). The rewritten history will have different object names for all the objects and will not converge with the original branch. So <strong>avoid using it on commits that you shared</strong>.
And it will mess up stash, so <strong>don't have stash when you run <code>git obliterate</code></strong>.</p>
<h2 id="OPTIONS">OPTIONS</h2>
<p>You can pass rev-list options to indicate the range of commits affected. Those options need to be seperated with '--' before them. Run <code>git help rev-list</code> to see the acceptable options.</p>
<h2 id="Examples">Examples</h2>
<p> Remove .secret from the repository:</p>
<pre><code>$ git obliterate .secret
</code></pre>
<p> Remove .secret from commits between origin and feature:</p>
<pre><code>$ git obliterate .secret -- feature ^origin
</code></pre>
<p> Remove .secret from commit abcdefg to commit 1234567</p>
<pre><code>$ git obliterate .secret -- abcdefg..1234567
</code></pre>
<h2 id="AUTHOR">AUTHOR</h2>
<p>Written by &lt;<a href="&#109;&#97;&#105;&#108;&#116;&#111;&#x3a;&#98;&#x72;&#x69;&#x61;&#x6e;&#108;&#x6f;&#118;&#x65;&#115;&#x77;&#111;&#x72;&#100;&#115;&#64;&#103;&#x6d;&#97;&#x69;&#x6c;&#x2e;&#x63;&#111;&#x6d;" data-bare-link="true">&#x62;&#x72;&#x69;&#x61;&#x6e;&#108;&#111;&#118;&#101;&#x73;&#x77;&#111;&#114;&#100;&#x73;&#64;&#x67;&#x6d;&#97;&#105;&#x6c;&#46;&#99;&#111;&#109;</a>&gt;</p>
<h2 id="REPORTING-BUG">REPORTING BUG</h2>
<p>&lt;<a href="https://github.com/tj/git-extras/issues" data-bare-link="true">https://github.com/tj/git-extras/issues</a>&gt;</p>
<h2 id="SEE-ALSO">SEE ALSO</h2>
<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'>August 2015</li>
<li class='tr'>git-obliterate(1)</li>
</ol>
</div>
</body>
</html>

42
man/git-obliterate.md Normal file
View file

@ -0,0 +1,42 @@
git-obliterate(1) -- rewrite past commits to remove some files
===============================
## SYNOPSIS
git obliterate &lt;files...&gt; [-- &lt;rev-list options...&gt;]
## DESCRIPTION
Completely remove some files from the repository, including past commits and tags.
WARNING! This command will rewirte the history similar to `git rebase`(though it affects more). The rewritten history will have different object names for all the objects and will not converge with the original branch. So **avoid using it on commits that you shared**.
And it will mess up stash, so **don't have stash when you run `git obliterate`**.
## OPTIONS
You can pass rev-list options to indicate the range of commits affected. Those options need to be seperated with '--' before them. Run `git help rev-list` to see the acceptable options.
## Examples
Remove .secret from the repository:
$ git obliterate .secret
Remove .secret from commits between origin and feature:
$ git obliterate .secret -- feature ^origin
Remove .secret from commit abcdefg to commit 1234567
$ git obliterate .secret -- abcdefg..1234567
## AUTHOR
Written by &lt;<brianloveswords@gmail.com>&gt;
## REPORTING BUG
&lt;<https://github.com/tj/git-extras/issues>&gt;
## SEE ALSO
&lt;<https://github.com/tj/git-extras>&gt;