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
tj.git-extras/man
History
Nicolai Skogheim 86e1a7014c effort: More robust argument parsing 
Why:

* The old way of handling arguments could make it
difficult to make non-breaking changes because
to be able to handle more arguments than the
'--above' argument, the logic would need to be heavily
refactored and demand restrictions on argument order.

This change addresses the need by:

* Parse arguments in a cleaner way
* Make the command more future proof with respect to arguments

Notable change is the synopsis. Please the see man page.
2015-09-13 23:55:28 +02:00
..
git-alias.1 change 'search-term' to 'search-pattern' 2015-08-09 19:33:13 +08:00
git-alias.1.html change 'search-term' to 'search-pattern' 2015-08-09 19:33:13 +08:00
git-alias.html alias: docs 2015-08-04 02:32:58 +02:00
git-alias.md change 'search-term' to 'search-pattern' 2015-08-09 19:33:13 +08:00
git-archive-file.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-archive-file.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-archive-file.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-authors.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-authors.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-authors.md Add git-authors 2015-02-07 17:24:21 +01:00
git-back.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-back.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-back.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-bug.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-bug.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-bug.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-changelog.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-changelog.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-changelog.md Complete rewrite to support commit ranges for pretty and list output. 2015-03-11 11:43:35 -07:00
git-chore.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-chore.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-chore.md adding git-chore 2015-02-04 11:52:23 -05:00
git-commits-since.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-commits-since.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-commits-since.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-contrib.1 contrib: update docs 2015-08-04 19:19:46 +02:00
git-contrib.html contrib: update docs 2015-08-04 19:19:46 +02:00
git-contrib.md contrib: update docs 2015-08-04 19:19:46 +02:00
git-count.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-count.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-count.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-create-branch.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-create-branch.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-create-branch.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-delete-branch.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-delete-branch.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-delete-branch.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-delete-merged-branches.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-delete-merged-branches.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-delete-merged-branches.md add show-merged-branches and show-unmerged-branches 2015-03-18 09:33:02 -04:00
git-delete-submodule.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-delete-submodule.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-delete-submodule.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-delete-tag.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-delete-tag.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-delete-tag.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-delta.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-delta.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-delta.md git-delta 2015-02-09 21:09:11 -05:00
git-effort.1 effort: More robust argument parsing 2015-09-13 23:55:28 +02:00
git-effort.html effort: More robust argument parsing 2015-09-13 23:55:28 +02:00
git-effort.md effort: More robust argument parsing 2015-09-13 23:55:28 +02:00
git-extras.1 cd man && ./manning-up.sh && git diff --stat | grep ' 2 ' | awk '{print }' | xargs git checkout -- 2015-06-27 17:13:43 +08:00
git-extras.html cd man && ./manning-up.sh && git diff --stat | grep ' 2 ' | awk '{print }' | xargs git checkout -- 2015-06-27 17:13:43 +08:00
git-extras.md cd man && ./manning-up.sh && git diff --stat | grep ' 2 ' | awk '{print }' | xargs git checkout -- 2015-06-27 17:13:43 +08:00
git-feature.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-feature.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-feature.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-fork.1 fork docs: change SSH to HTTPS in example 2015-08-08 05:06:31 +02:00
git-fork.html fork docs: change SSH to HTTPS in example 2015-08-08 05:06:31 +02:00
git-fork.md fork docs: change SSH to HTTPS in example 2015-08-08 05:06:31 +02:00
git-fresh-branch.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-fresh-branch.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-fresh-branch.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-gh-pages.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-gh-pages.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-gh-pages.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-graft.1 graft: Require destination branch. Fix #23 2015-07-25 04:16:09 +02:00
git-graft.html graft: Require destination branch. Fix #23 2015-07-25 04:16:09 +02:00
git-graft.md graft: Require destination branch. Fix #23 2015-07-25 04:16:09 +02:00
git-guilt.1 guilt: remove --help option 2015-08-07 08:35:32 +02:00
git-guilt.html guilt: remove --help option 2015-08-07 08:35:32 +02:00
git-guilt.md guilt: remove --help option 2015-08-07 08:35:32 +02:00
git-ignore.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-ignore.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-ignore.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-info.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-info.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-info.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-line-summary.1 Document for git-line-summary 2015-05-14 22:13:37 +08:00
git-line-summary.html cd man && ./manning-up.sh && git diff --stat | grep ' 2 ' | awk '{print }' | xargs git checkout -- 2015-06-27 17:13:43 +08:00
git-line-summary.md Document for git-line-summary 2015-05-14 22:13:37 +08:00
git-local-commits.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-local-commits.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-local-commits.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-lock.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-lock.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-lock.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-locked.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-locked.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-locked.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-merge-into.1 merge-into: change --ff option to --ff-only. fix #421 2015-08-14 13:03:39 +02:00
git-merge-into.html merge-into: change --ff option to --ff-only. fix #421 2015-08-14 13:03:39 +02:00
git-merge-into.md merge-into: change --ff option to --ff-only. fix #421 2015-08-14 13:03:39 +02:00
git-merge-repo.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-merge-repo.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-merge-repo.md git-merge-repo 2015-04-19 12:23:02 -04:00
git-missing.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-missing.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-missing.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-pr.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-pr.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-pr.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-psykorebase.1 Improve man page presentation. 2015-08-11 11:30:36 +02:00
git-psykorebase.html Improve man page presentation. 2015-08-11 11:30:36 +02:00
git-psykorebase.md Improve man page presentation. 2015-08-11 11:30:36 +02:00
git-rebase-patch.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-rebase-patch.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-rebase-patch.md correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-refactor.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-refactor.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-refactor.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-release.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-release.html cd man && ./manning-up.sh && git diff --stat | grep ' 2 ' | awk '{print }' | xargs git checkout -- 2015-06-27 17:13:43 +08:00
git-release.md + custom commit message options supports 2015-02-12 17:55:31 +08:00
git-rename-tag.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-rename-tag.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-rename-tag.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-repl.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-repl.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-repl.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-reset-file.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-reset-file.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-reset-file.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-root.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-root.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-root.md add new command 'git root' to show the path to root of repo 2014-11-13 16:12:50 +08:00
git-scp.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-scp.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-scp.md path argument can not be optional in rscp; add more docs 2014-12-29 00:14:44 +11:00
git-setup.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-setup.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-setup.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-show-merged-branches.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-show-merged-branches.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-show-merged-branches.md add show-merged-branches and show-unmerged-branches 2015-03-18 09:33:02 -04:00
git-show-tree.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-show-tree.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-show-tree.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-show-unmerged-branches.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-show-unmerged-branches.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-show-unmerged-branches.md add show-merged-branches and show-unmerged-branches 2015-03-18 09:33:02 -04:00
git-squash.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-squash.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-squash.md updated documentation because git-squash does no longer delete source-branch 2014-12-27 20:45:28 +01:00
git-summary.1 summary docs: Remove --line example 2015-08-07 08:36:55 +02:00
git-summary.html summary docs: Remove --line example 2015-08-07 08:36:55 +02:00
git-summary.md summary docs: Remove --line example 2015-08-07 08:36:55 +02:00
git-touch.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-touch.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-touch.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-undo.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-undo.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-undo.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-unlock.1 run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-unlock.html run pre-release ./manning-up.sh 2015-04-27 15:24:13 +08:00
git-unlock.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
index.txt cd man && ./manning-up.sh && git diff --stat | grep ' 2 ' | awk '{print }' | xargs git checkout -- 2015-06-27 17:13:43 +08:00
man-template.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
manning-up.sh correct the '-m' argument for grep. Then regenralize git-extra 2014-11-06 21:33:14 +08:00
Readme.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00

Readme.md

How to generate documentation:

DESCRIPTION

To generate documentation:

  1. Start by filling out the 'man-template.md'

  2. Then use a program ronn. Get ronn from github.

  3. Run ronn:

$ ronn <filename>.md
  1. Remember, we use the following naming convention for files:
git-<command>.html
git-<command>.1
git-<command>.md

You'll need to rename the html file, as ronn probably inserted a 1 into the filename.

EXAMPLE

$ ronn git-effort.md

roff: ./git-effort.1
html: ./git-effort.1.html                +man

$ mv git-effort.1.html git-effort.html

SHELL SCRIPT

Alternatively you can run the manning-up.sh automated shell script included in the man folder. The script will recreate the git-extras index based on the list of .md files available before it runs ronn against each one to generate the documents as well as renaming the generated .html files to their desired form.

$ ./manning-up.sh

To only (re)generate a specific .md manual template and have .1.html renamed to .html yau may also use manning-up.sh.

$ ./manning-up.sh git-info.md

AUTHOR

Written by Leila Muhtasib <muhtasib@gmail.com> Shell Script by Nick Lombard <github@jigsoft.co.za>

REPORTING BUGS

<https://github.com/tj/git-extras/issues>

SEE ALSO

<https://github.com/tj/git-extras>