From 755f07f5e4437eea91e38e718d694e6c50093cf4 Mon Sep 17 00:00:00 2001 From: Leila Muhtasib Date: Tue, 12 Jun 2012 16:45:34 -0400 Subject: [PATCH 1/2] Added missing documenation for git-effort command --- man/git-effort.1 | 68 ++++++++++++++++++++++ man/git-effort.html | 139 ++++++++++++++++++++++++++++++++++++++++++++ man/git-effort.md | 55 ++++++++++++++++++ 3 files changed, 262 insertions(+) create mode 100644 man/git-effort.1 create mode 100644 man/git-effort.html create mode 100644 man/git-effort.md diff --git a/man/git-effort.1 b/man/git-effort.1 new file mode 100644 index 0000000..62e49c7 --- /dev/null +++ b/man/git-effort.1 @@ -0,0 +1,68 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "GIT\-EFFORT" "1" "June 2012" "" "" +. +.SH "NAME" +\fBgit\-effort\fR \- Show effort statistics on file(s) +. +.SH "SYNOPSIS" +\fBgit\-effort\fR [\-\-above ] [] +. +.SH "DESCRIPTION" +Shows effort statistics about files in the repository\. +. +.P +Display includes: +. +.br +\- Commits: number of commits per file \- highlighting files with most activity\. +. +.br +\- Active days: total number of days which contributed modifications to this file\. +. +.SH "OPTIONS" +\-\-above +. +.P +Ignore files with commits <= a value\. +. +.P + +. +.P +Only display effort statistics for a specific filename\. +. +.SH "EXAMPLES" +Displays "effort" statistics: +. +.IP "" 4 +. +.nf + +$ git effort \-\-above 5 + + file commits active days + + git\-extras 26 18 + git\-release 13 13 + git\-effort 13 2 + git\-ignore 11 7 + git\-changelog 11 8 + git\-graft 9 6 + git\-summary 8 6 + git\-delete\-branch 8 6 + git\-repl 7 5 +. +.fi +. +.IP "" 0 +. +.SH "AUTHOR" +Written by Leila Muhtasib <\fImuhtasib@gmail\.com\fR> +. +.SH "REPORTING BUGS" +<\fIhttp://github\.com/visionmedia/git\-extras/issues\fR> +. +.SH "SEE ALSO" +<\fIhttp://github\.com/visionmedia/git\-extras\fR> diff --git a/man/git-effort.html b/man/git-effort.html new file mode 100644 index 0000000..d348304 --- /dev/null +++ b/man/git-effort.html @@ -0,0 +1,139 @@ + + + + + + git-effort(1) - Show effort statistics on file(s) + + + + +
+ + + +
    +
  1. git-effort(1)
    2. +
  2. +
  3. git-effort(1)
    4. +
+ +

NAME

+

+ git-effort - Show effort statistics on file(s) +

+ +

SYNOPSIS

+ +

git-effort [--above <value>] [<filename>]

+ +

DESCRIPTION

+ +

Shows effort statistics about files in the repository.

+ +

Display includes:
+ - Commits: number of commits per file - highlighting files with most activity.
+ - Active days: total number of days which contributed modifications to this file.

+ +

OPTIONS

+ +

--above <value>

+ +

Ignore files with commits <= a value.

+ +

<filename>

+ +

Only display effort statistics for a specific filename.

+ +

EXAMPLES

+ +

Displays "effort" statistics:

+ +
$ git effort --above 5
+
+  file                                          commits    active days
+
+  git-extras                                    26         18
+  git-release                                   13         13
+  git-effort                                    13         2
+  git-ignore                                    11         7
+  git-changelog                                 11         8
+  git-graft                                     9          6
+  git-summary                                   8          6
+  git-delete-branch                             8          6
+  git-repl                                      7          5
+
+ +

AUTHOR

+ +

Written by Leila Muhtasib <muhtasib@gmail.com>

+ +

REPORTING BUGS

+ +

<http://github.com/visionmedia/git-extras/issues>

+ +

SEE ALSO

+ +

<http://github.com/visionmedia/git-extras>

+ + +
    +
  1. +
  2. June 2012
    3. +
  3. git-effort(1)
    4. +
+ +
+ + diff --git a/man/git-effort.md b/man/git-effort.md new file mode 100644 index 0000000..c0c32a2 --- /dev/null +++ b/man/git-effort.md @@ -0,0 +1,55 @@ +git-effort(1) -- Show effort statistics on file(s) +================================= + +## SYNOPSIS + +`git-effort` [--above <value>] [<filename>] + +## DESCRIPTION + + Shows effort statistics about files in the repository. + + Display includes: + - Commits: number of commits per file - highlighting files with most activity. + - Active days: total number of days which contributed modifications to this file. + +## OPTIONS + + --above <value> + + Ignore files with commits <= a value. + + <filename> + + Only display effort statistics for a specific filename. + +## EXAMPLES + + Displays "effort" statistics: + + $ git effort --above 5 + + file commits active days + + git-extras 26 18 + git-release 13 13 + git-effort 13 2 + git-ignore 11 7 + git-changelog 11 8 + git-graft 9 6 + git-summary 8 6 + git-delete-branch 8 6 + git-repl 7 5 + + +## AUTHOR + +Written by Leila Muhtasib <> + +## REPORTING BUGS + +<> + +## SEE ALSO + +<> \ No newline at end of file From 313d128887d9bf1681ad64482f6055bfb54a3d96 Mon Sep 17 00:00:00 2001 From: Leila Muhtasib Date: Tue, 12 Jun 2012 17:13:32 -0400 Subject: [PATCH 2/2] Updated git-extras to include git-effort. Regenerated git-extras to reflect git-effort being added, and git-pull-request being removed. Created Readme.md file on how to generate documenation. --- man/Readme.md | 42 ++++++++++++++++++++++++++++++++++++++++++ man/git-extras.1 | 8 ++++---- man/git-extras.html | 14 +++++++------- man/git-extras.md | 1 + 4 files changed, 54 insertions(+), 11 deletions(-) create mode 100644 man/Readme.md diff --git a/man/Readme.md b/man/Readme.md new file mode 100644 index 0000000..e53749a --- /dev/null +++ b/man/Readme.md @@ -0,0 +1,42 @@ +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 + +4) 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 + +## AUTHOR + +Written by Leila Muhtasib <> + +## REPORTING BUGS + +<> + +## SEE ALSO + +<> diff --git a/man/git-extras.1 b/man/git-extras.1 index 242fe6b..ab8d4a2 100644 --- a/man/git-extras.1 +++ b/man/git-extras.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "GIT\-EXTRAS" "1" "March 2011" "" "Git Extras" +.TH "GIT\-EXTRAS" "1" "June 2012" "" "" . .SH "NAME" \fBgit\-extras\fR \- Awesome GIT utilities @@ -24,6 +24,9 @@ \fBgit\-count\fR show commit count . .IP "\(bu" 4 +\fBgit\-effort\fR show effort statistics on file(s) +. +.IP "\(bu" 4 \fBgit\-fresh\-branch\fR create fresh branches . .IP "\(bu" 4 @@ -50,9 +53,6 @@ .IP "\(bu" 4 \fBgit\-undo\fR undo one or more of the latest commits . -.IP "\(bu" 4 -\fBgit\-pull\-request\fR pulls the given request from github -. .IP "" 0 . .SH "AUTHOR" diff --git a/man/git-extras.html b/man/git-extras.html index 38a837c..d985d5e 100644 --- a/man/git-extras.html +++ b/man/git-extras.html @@ -59,11 +59,11 @@ AUTHOR REPORTING BUGS SEE ALSO - +
  1. git-extras(1)
    2. -
  2. Git Extras
    3. +
  4. git-extras(1)
@@ -83,6 +83,7 @@
  • git-commits-since show commit logs since some date
  • git-contrib show a user's contribution
  • git-count show commit count
    • +
  • git-effort show effort statistics on file(s)
  • git-fresh-branch create fresh branches
  • git-graft merge and destroy a given branch
  • git-ignore add .gitignore patterns
    • @@ -92,26 +93,25 @@
  • git-summary repository summary & contrib
  • git-touch touch and add file to the index
  • git-undo undo one or more of the latest commits
    • -
  • git-pull-request pulls the given request from github

    • AUTHOR

    -

    Written by Tj Holowaychuk <tj@vision-media.ca>

    +

    Written by Tj Holowaychuk <tj@vision-media.ca>

    REPORTING BUGS

    -

    <http://github.com/visionmedia/git-extras/issues>

    +

    <http://github.com/visionmedia/git-extras/issues>

    SEE ALSO

    -

    <http://github.com/visionmedia/git-extras>

    +

    <http://github.com/visionmedia/git-extras>

    1. -
    2. March 2011
      3. +
    3. June 2012
    4. git-extras(1)
    diff --git a/man/git-extras.md b/man/git-extras.md index 636a274..fd2aa8e 100644 --- a/man/git-extras.md +++ b/man/git-extras.md @@ -11,6 +11,7 @@ git-extras(1) -- Awesome GIT utilities - `git-commits-since` show commit logs since some date - `git-contrib` show a user's contribution - `git-count` show commit count + - `git-effort` show effort statistics on file(s) - `git-fresh-branch` create fresh branches - `git-graft` merge and destroy a given branch - `git-ignore` add .gitignore patterns