doc: update git-extras index

This commit is contained in:
spacewander 2018-02-15 22:57:56 +08:00
parent 9ee318e8d4
commit f5d99bcac9
8 changed files with 101 additions and 32 deletions

View file

@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "GIT\-EXTRAS" "1" "December 2016" "" "Git Extras"
.TH "GIT\-EXTRAS" "1" "February 2018" "" ""
.
.SH "NAME"
\fBgit\-extras\fR \- Awesome GIT utilities
@ -45,6 +45,9 @@ Self update\.
\fBgit\-bug(1)\fR Create bug branch
.
.IP "\(bu" 4
\fBgit\-bulk(1)\fR Run git commands on multiple repositories
.
.IP "\(bu" 4
\fBgit\-changelog(1)\fR Generate a changelog report
.
.IP "\(bu" 4
@ -54,6 +57,9 @@ Self update\.
\fBgit\-clear(1)\fR Rigorously clean up a repository
.
.IP "\(bu" 4
\fBgit\-clear\-soft(1)\fR Soft clean up a repository
.
.IP "\(bu" 4
\fBgit\-commits\-since(1)\fR Show commit logs since some date
.
.IP "\(bu" 4
@ -87,6 +93,9 @@ Self update\.
\fBgit\-feature(1)\fR Create/Merge feature branch
.
.IP "\(bu" 4
\fBgit\-force\-clone(1)\fR overwrite local repositories with clone
.
.IP "\(bu" 4
\fBgit\-fork(1)\fR Fork a repo on github
.
.IP "\(bu" 4
@ -117,10 +126,10 @@ Self update\.
\fBgit\-local\-commits(1)\fR List local commits
.
.IP "\(bu" 4
\fBgit\-lock(1)\fR Lock a file excluded from version control
\fBgit\-locked(1)\fR ls files that have been locked
.
.IP "\(bu" 4
\fBgit\-locked(1)\fR ls files that have been locked
\fBgit\-lock(1)\fR Lock a file excluded from version control
.
.IP "\(bu" 4
\fBgit\-merge\-into(1)\fR Merge one branch into another
@ -132,7 +141,10 @@ Self update\.
\fBgit\-missing(1)\fR Show commits missing from another branch
.
.IP "\(bu" 4
\fB# git\-mr(1)\fR Checks out a merge request locally
\fBgit\-mr(1)\fR Checks out a merge request locally
.
.IP "\(bu" 4
\fBgit\-obliterate(1)\fR rewrite past commits to remove some files
.
.IP "\(bu" 4
\fBgit\-pr(1)\fR Checks out a pull request locally
@ -141,6 +153,9 @@ Self update\.
\fBgit\-psykorebase(1)\fR Rebase a branch with a merge commit
.
.IP "\(bu" 4
\fBgit\-pull\-request(1)\fR Create pull request for GitHub project
.
.IP "\(bu" 4
\fBgit\-reauthor(1)\fR Rewrite history to change author\'s identity
.
.IP "\(bu" 4
@ -153,6 +168,9 @@ Self update\.
\fBgit\-release(1)\fR Commit, tag and push changes to the repository
.
.IP "\(bu" 4
\fBgit\-rename\-branch(1)\fR rename local branch and push to remote
.
.IP "\(bu" 4
\fBgit\-rename\-tag(1)\fR Rename a tag
.
.IP "\(bu" 4
@ -186,9 +204,18 @@ Self update\.
\fBgit\-squash(1)\fR Import changes from a branch
.
.IP "\(bu" 4
\fBgit\-stamp(1)\fR Stamp the last commit message
.
.IP "\(bu" 4
\fBgit\-standup(1)\fR Recall the commit history
.
.IP "\(bu" 4
\fBgit\-summary(1)\fR Show repository summary
.
.IP "\(bu" 4
\fBgit\-sync(1)\fR Sync local branch with remote branch
.
.IP "\(bu" 4
\fBgit\-touch(1)\fR Touch and add file to the index
.
.IP "\(bu" 4

View file

@ -64,7 +64,7 @@
<ol class='man-decor man-head man head'>
<li class='tl'>git-extras(1)</li>
<li class='tc'>Git Extras</li>
<li class='tc'></li>
<li class='tr'>git-extras(1)</li>
</ol>
@ -99,9 +99,11 @@
<li> <strong><a class="man-ref" href="git-authors.html">git-authors<span class="s">(1)</span></a></strong> Generate authors report</li>
<li> <strong><a class="man-ref" href="git-back.html">git-back<span class="s">(1)</span></a></strong> Undo and Stage latest commits</li>
<li> <strong><a class="man-ref" href="git-bug.html">git-bug<span class="s">(1)</span></a></strong> Create bug branch</li>
<li> <strong><a class="man-ref" href="git-bulk.html">git-bulk<span class="s">(1)</span></a></strong> Run git commands on multiple repositories</li>
<li> <strong><a class="man-ref" href="git-changelog.html">git-changelog<span class="s">(1)</span></a></strong> Generate a changelog report</li>
<li> <strong><a class="man-ref" href="git-chore.html">git-chore<span class="s">(1)</span></a></strong> Create chore branch</li>
<li> <strong><a class="man-ref" href="git-clear.html">git-clear<span class="s">(1)</span></a></strong> Rigorously clean up a repository</li>
<li> <strong><a class="man-ref" href="git-clear-soft.html">git-clear-soft<span class="s">(1)</span></a></strong> Soft clean up a repository</li>
<li> <strong><a class="man-ref" href="git-commits-since.html">git-commits-since<span class="s">(1)</span></a></strong> Show commit logs since some date</li>
<li> <strong><a class="man-ref" href="git-contrib.html">git-contrib<span class="s">(1)</span></a></strong> Show user's contributions</li>
<li> <strong><a class="man-ref" href="git-count.html">git-count<span class="s">(1)</span></a></strong> Show commit count</li>
@ -113,6 +115,7 @@
<li> <strong><a class="man-ref" href="git-delta.html">git-delta<span class="s">(1)</span></a></strong> Lists changed files</li>
<li> <strong><a class="man-ref" href="git-effort.html">git-effort<span class="s">(1)</span></a></strong> Show effort statistics on file(s)</li>
<li> <strong><a class="man-ref" href="git-feature.html">git-feature<span class="s">(1)</span></a></strong> Create/Merge feature branch</li>
<li> <strong><a class="man-ref" href="git-force-clone.html">git-force-clone<span class="s">(1)</span></a></strong> overwrite local repositories with clone</li>
<li> <strong><a class="man-ref" href="git-fork.html">git-fork<span class="s">(1)</span></a></strong> Fork a repo on github</li>
<li> <strong><a class="man-ref" href="git-fresh-branch.html">git-fresh-branch<span class="s">(1)</span></a></strong> Create fresh branches</li>
<li> <strong><a class="man-ref" href="git-gh-pages.html">git-gh-pages<span class="s">(1)</span></a></strong> Create the GitHub Pages branch</li>
@ -123,18 +126,21 @@
<li> <strong><a class="man-ref" href="git-info.html">git-info<span class="s">(1)</span></a></strong> Returns information on current repository</li>
<li> <strong><a class="man-ref" href="git-line-summary.html">git-line-summary<span class="s">(1)</span></a></strong> Show repository summary by line</li>
<li> <strong><a class="man-ref" href="git-local-commits.html">git-local-commits<span class="s">(1)</span></a></strong> List local commits</li>
<li> <strong><a class="man-ref" href="git-lock.html">git-lock<span class="s">(1)</span></a></strong> Lock a file excluded from version control</li>
<li> <strong><a class="man-ref" href="git-locked.html">git-locked<span class="s">(1)</span></a></strong> ls files that have been locked</li>
<li> <strong><a class="man-ref" href="git-lock.html">git-lock<span class="s">(1)</span></a></strong> Lock a file excluded from version control</li>
<li> <strong><a class="man-ref" href="git-merge-into.html">git-merge-into<span class="s">(1)</span></a></strong> Merge one branch into another</li>
<li> <strong><a class="man-ref" href="git-merge-repo.html">git-merge-repo<span class="s">(1)</span></a></strong> Merge two repo histories</li>
<li> <strong><a class="man-ref" href="git-missing.html">git-missing<span class="s">(1)</span></a></strong> Show commits missing from another branch</li>
<li> <strong><a class="man-ref" href="git-mr.html">git-mr<span class="s">(1)</span></a></strong> Checks out a merge request locally</li>
<li> <strong><a class="man-ref" href="git-obliterate.html">git-obliterate<span class="s">(1)</span></a></strong> rewrite past commits to remove some files</li>
<li> <strong><a class="man-ref" href="git-pr.html">git-pr<span class="s">(1)</span></a></strong> Checks out a pull request locally</li>
<li> <strong><a class="man-ref" href="git-psykorebase.html">git-psykorebase<span class="s">(1)</span></a></strong> Rebase a branch with a merge commit</li>
<li> <strong><a class="man-ref" href="git-pull-request.html">git-pull-request<span class="s">(1)</span></a></strong> Create pull request for GitHub project</li>
<li> <strong><a class="man-ref" href="git-reauthor.html">git-reauthor<span class="s">(1)</span></a></strong> Rewrite history to change author's identity</li>
<li> <strong><a class="man-ref" href="git-rebase-patch.html">git-rebase-patch<span class="s">(1)</span></a></strong> Rebases a patch</li>
<li> <strong><a class="man-ref" href="git-refactor.html">git-refactor<span class="s">(1)</span></a></strong> Create refactor branch</li>
<li> <strong><a class="man-ref" href="git-release.html">git-release<span class="s">(1)</span></a></strong> Commit, tag and push changes to the repository</li>
<li> <strong><a class="man-ref" href="git-rename-branch.html">git-rename-branch<span class="s">(1)</span></a></strong> rename local branch and push to remote</li>
<li> <strong><a class="man-ref" href="git-rename-tag.html">git-rename-tag<span class="s">(1)</span></a></strong> Rename a tag</li>
<li> <strong><a class="man-ref" href="git-repl.html">git-repl<span class="s">(1)</span></a></strong> git read-eval-print-loop</li>
<li> <strong><a class="man-ref" href="git-reset-file.html">git-reset-file<span class="s">(1)</span></a></strong> Reset one file</li>
@ -146,7 +152,10 @@
<li> <strong><a class="man-ref" href="git-show-tree.html">git-show-tree<span class="s">(1)</span></a></strong> show branch tree of commit history</li>
<li> <strong><a class="man-ref" href="git-show-unmerged-branches.html">git-show-unmerged-branches<span class="s">(1)</span></a></strong> Show unmerged branches</li>
<li> <strong><a class="man-ref" href="git-squash.html">git-squash<span class="s">(1)</span></a></strong> Import changes from a branch</li>
<li> <strong><a class="man-ref" href="git-stamp.html">git-stamp<span class="s">(1)</span></a></strong> Stamp the last commit message</li>
<li> <strong><a class="man-ref" href="git-standup.html">git-standup<span class="s">(1)</span></a></strong> Recall the commit history</li>
<li> <strong><a class="man-ref" href="git-summary.html">git-summary<span class="s">(1)</span></a></strong> Show repository summary</li>
<li> <strong><a class="man-ref" href="git-sync.html">git-sync<span class="s">(1)</span></a></strong> Sync local branch with remote branch</li>
<li> <strong><a class="man-ref" href="git-touch.html">git-touch<span class="s">(1)</span></a></strong> Touch and add file to the index</li>
<li> <strong><a class="man-ref" href="git-undo.html">git-undo<span class="s">(1)</span></a></strong> Remove latest commits</li>
<li> <strong><a class="man-ref" href="git-unlock.html">git-unlock<span class="s">(1)</span></a></strong> Unlock a file excluded from version control</li>
@ -155,7 +164,7 @@
<h2 id="AUTHOR">AUTHOR</h2>
<p>Written by Tj Holowaychuk &lt;<a href="&#109;&#x61;&#x69;&#x6c;&#116;&#x6f;&#58;&#116;&#106;&#64;&#x76;&#105;&#x73;&#105;&#x6f;&#x6e;&#45;&#109;&#101;&#x64;&#x69;&#x61;&#x2e;&#99;&#x61;" data-bare-link="true">&#x74;&#x6a;&#64;&#118;&#105;&#115;&#105;&#x6f;&#x6e;&#45;&#x6d;&#101;&#100;&#x69;&#x61;&#x2e;&#99;&#x61;</a>&gt;</p>
<p>Written by Tj Holowaychuk &lt;<a href="&#x6d;&#97;&#x69;&#x6c;&#x74;&#111;&#58;&#x74;&#106;&#64;&#118;&#x69;&#x73;&#105;&#111;&#x6e;&#x2d;&#x6d;&#x65;&#x64;&#x69;&#97;&#46;&#99;&#97;" data-bare-link="true">&#116;&#106;&#x40;&#118;&#x69;&#x73;&#x69;&#111;&#110;&#45;&#x6d;&#101;&#x64;&#x69;&#97;&#x2e;&#x63;&#97;</a>&gt;</p>
<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
@ -168,7 +177,7 @@
<ol class='man-decor man-foot man foot'>
<li class='tl'></li>
<li class='tc'>December 2016</li>
<li class='tc'>February 2018</li>
<li class='tr'>git-extras(1)</li>
</ol>

View file

@ -26,9 +26,11 @@ git-extras(1) -- Awesome GIT utilities
- **git-authors(1)** Generate authors report
- **git-back(1)** Undo and Stage latest commits
- **git-bug(1)** Create bug branch
- **git-bulk(1)** Run git commands on multiple repositories
- **git-changelog(1)** Generate a changelog report
- **git-chore(1)** Create chore branch
- **git-clear(1)** Rigorously clean up a repository
- **git-clear-soft(1)** Soft clean up a repository
- **git-commits-since(1)** Show commit logs since some date
- **git-contrib(1)** Show user's contributions
- **git-count(1)** Show commit count
@ -40,6 +42,7 @@ git-extras(1) -- Awesome GIT utilities
- **git-delta(1)** Lists changed files
- **git-effort(1)** Show effort statistics on file(s)
- **git-feature(1)** Create/Merge feature branch
- **git-force-clone(1)** overwrite local repositories with clone
- **git-fork(1)** Fork a repo on github
- **git-fresh-branch(1)** Create fresh branches
- **git-gh-pages(1)** Create the GitHub Pages branch
@ -50,18 +53,21 @@ git-extras(1) -- Awesome GIT utilities
- **git-info(1)** Returns information on current repository
- **git-line-summary(1)** Show repository summary by line
- **git-local-commits(1)** List local commits
- **git-lock(1)** Lock a file excluded from version control
- **git-locked(1)** ls files that have been locked
- **git-lock(1)** Lock a file excluded from version control
- **git-merge-into(1)** Merge one branch into another
- **git-merge-repo(1)** Merge two repo histories
- **git-missing(1)** Show commits missing from another branch
- **git-mr(1)** Checks out a merge request locally
- **git-obliterate(1)** rewrite past commits to remove some files
- **git-pr(1)** Checks out a pull request locally
- **git-psykorebase(1)** Rebase a branch with a merge commit
- **git-pull-request(1)** Create pull request for GitHub project
- **git-reauthor(1)** Rewrite history to change author's identity
- **git-rebase-patch(1)** Rebases a patch
- **git-refactor(1)** Create refactor branch
- **git-release(1)** Commit, tag and push changes to the repository
- **git-rename-branch(1)** rename local branch and push to remote
- **git-rename-tag(1)** Rename a tag
- **git-repl(1)** git read-eval-print-loop
- **git-reset-file(1)** Reset one file
@ -73,7 +79,10 @@ git-extras(1) -- Awesome GIT utilities
- **git-show-tree(1)** show branch tree of commit history
- **git-show-unmerged-branches(1)** Show unmerged branches
- **git-squash(1)** Import changes from a branch
- **git-stamp(1)** Stamp the last commit message
- **git-standup(1)** Recall the commit history
- **git-summary(1)** Show repository summary
- **git-sync(1)** Sync local branch with remote branch
- **git-touch(1)** Touch and add file to the index
- **git-undo(1)** Remove latest commits
- **git-unlock(1)** Unlock a file excluded from version control

View file

@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "GIT\-MR" "1" "June 2017" "" ""
.TH "GIT\-MR" "1" "February 2018" "" ""
.
.SH "NAME"
\fBgit\-mr\fR \- Checks out a merge request locally

View file

@ -108,7 +108,7 @@ Switched to branch 'mr/51'
<h2 id="AUTHOR">AUTHOR</h2>
<p>Written by Étienne BERSAC <a href="&#x6d;&#x61;&#x69;&#x6c;&#x74;&#x6f;&#x3a;&#x62;&#x65;&#114;&#x73;&#x61;&#x63;&#101;&#x30;&#x33;&#64;&#x67;&#109;&#x61;&#x69;&#108;&#x2e;&#x63;&#111;&#109;" data-bare-link="true">&#x62;&#x65;&#x72;&#x73;&#x61;&#99;&#101;&#x30;&#x33;&#64;&#103;&#x6d;&#x61;&#x69;&#x6c;&#x2e;&#99;&#111;&#x6d;</a> from <a class="man-ref" href="git-pr.html">git-pr<span class="s">(1)</span></a>.</p>
<p>Written by Étienne BERSAC <a href="&#109;&#x61;&#x69;&#x6c;&#116;&#x6f;&#58;&#x62;&#101;&#x72;&#115;&#97;&#x63;&#101;&#48;&#x33;&#64;&#103;&#x6d;&#x61;&#x69;&#108;&#x2e;&#99;&#x6f;&#109;" data-bare-link="true">&#x62;&#101;&#114;&#115;&#x61;&#x63;&#101;&#48;&#51;&#64;&#x67;&#109;&#97;&#x69;&#x6c;&#46;&#x63;&#111;&#109;</a> from <a class="man-ref" href="git-pr.html">git-pr<span class="s">(1)</span></a>.</p>
<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
@ -121,7 +121,7 @@ Switched to branch 'mr/51'
<ol class='man-decor man-foot man foot'>
<li class='tl'></li>
<li class='tc'>June 2017</li>
<li class='tc'>February 2018</li>
<li class='tr'>git-mr(1)</li>
</ol>

View file

@ -1,4 +1,5 @@
# git-mr(1) -- Checks out a merge request locally
git-mr(1) -- Checks out a merge request locally
========================================
## SYNOPSIS

View file

@ -4,9 +4,11 @@ git-archive-file(1) git-archive-file
git-authors(1) git-authors
git-back(1) git-back
git-bug(1) git-bug
git-bulk(1) git-bulk
git-changelog(1) git-changelog
git-chore(1) git-chore
git-clear(1) git-clear
git-clear-soft(1) git-clear-soft
git-commits-since(1) git-commits-since
git-contrib(1) git-contrib
git-count(1) git-count
@ -19,6 +21,7 @@ git-delta(1) git-delta
git-effort(1) git-effort
git-extras(1) git-extras
git-feature(1) git-feature
git-force-clone(1) git-force-clone
git-fork(1) git-fork
git-fresh-branch(1) git-fresh-branch
git-gh-pages(1) git-gh-pages
@ -29,8 +32,8 @@ git-ignore(1) git-ignore
git-info(1) git-info
git-line-summary(1) git-line-summary
git-local-commits(1) git-local-commits
git-lock(1) git-lock
git-locked(1) git-locked
git-lock(1) git-lock
git-merge-into(1) git-merge-into
git-merge-repo(1) git-merge-repo
git-missing(1) git-missing
@ -38,10 +41,12 @@ git-mr(1) git-mr
git-obliterate(1) git-obliterate
git-pr(1) git-pr
git-psykorebase(1) git-psykorebase
git-pull-request(1) git-pull-request
git-reauthor(1) git-reauthor
git-rebase-patch(1) git-rebase-patch
git-refactor(1) git-refactor
git-release(1) git-release
git-rename-branch(1) git-rename-branch
git-rename-tag(1) git-rename-tag
git-repl(1) git-repl
git-reset-file(1) git-reset-file
@ -54,7 +59,9 @@ git-show-tree(1) git-show-tree
git-show-unmerged-branches(1) git-show-unmerged-branches
git-squash(1) git-squash
git-stamp(1) git-stamp
git-standup(1) git-standup
git-summary(1) git-summary
git-sync(1) git-sync
git-touch(1) git-touch
git-undo(1) git-undo
git-unlock(1) git-unlock

View file

@ -1,21 +1,37 @@
#!/bin/bash
#!/usr/bin/env bash
set -e
test "$1" && ronn $1 && mv -f ${1/.md/}.1.html ${1/.md/}.html && exit 0
update_git_extras_index() {
echo '# manuals' > index.txt.tmp
ln=$(awk '/## COMMANDS/{print NR};' ./git-extras.md)
awk "NR <= $ln+1" git-extras.md > git-extras.md.tmp
for file in $(ls git*.md); do
extra=${file/.md/}
spaced=" "
echo "$extra(1)${spaced:${#extra}}$extra" >> index.txt.tmp;
title=$(grep -m 1 $extra"(1) -- " $file)
test "$extra" != "git-extras" && echo " - **"${title/" --"/"**"} >> git-extras.md.tmp
done
ln=$(awk '/## AUTHOR/{print NR};' ./git-extras.md)
awk "NR >= $ln-1" git-extras.md >> git-extras.md.tmp
mv -f index.txt.tmp index.txt
mv -f git-extras.md.tmp git-extras.md
}
echo '# manuals' > index.txt.tmp
ln=$(awk '/## COMMANDS/{print NR};' ./git-extras.md)
awk "NR <= $ln+1" git-extras.md > git-extras.md.tmp
for file in $(ls git*.md); do
extra=${file/.md/}
spaced=" "
echo "$extra(1)${spaced:${#extra}}$extra" >> index.txt.tmp;
title=$(grep -m 1 $extra"(1) -- " $file)
test "$extra" != "git-extras" && echo " - **"${title/" --"/"**"} >> git-extras.md.tmp
done
ln=$(awk '/## AUTHOR/{print NR};' ./git-extras.md)
awk "NR >= $ln-1" git-extras.md >> git-extras.md.tmp && mv -f index.txt.tmp index.txt && mv -f git-extras.md.tmp git-extras.md
if [ -n "$1" ]
then
if [[ "$1" == git-extras.md ]]
then
update_git_extras_index
fi
for file in $(ls git*.md); do
extra=${file/.md/}
ronn $file && mv -f $extra.1.html $extra.html
done
ronn $1
mv -f ${1/.md/}.1.html ${1/.md/}.html
else
update_git_extras_index
for file in $(ls git*.md); do
extra=${file/.md/}
ronn $file && mv -f $extra.1.html $extra.html
done
fi