summaryloggraphiclog1graphiclog2commitcommitdifftreerefseditfork
rawpatchinlineside by side (parent: 663fec0)
rawpatchinlineside by side (parent: 663fec0)
| author | Sverre Rabbelier <[email protected]> | |
| Thu, 31 Jul 2008 04:19:33 +0000 (31 06:19 +0200) | ||
| committer | Sverre Rabbelier <[email protected]> | |
| Thu, 31 Jul 2008 04:23:09 +0000 (31 06:23 +0200) |
With this, all files in doc/ have been spellchecked, the
source files are probably too bothersome to spellcheck.
source files are probably too bothersome to spellcheck.
--- a/doc/gitstats-author.txt
+++ b/doc/gitstats-author.txt
* Determine how many commits an author made that affected
a specific file. This metric is less granular, but a lot
- faster. To retreive the more granular result, one could
+ faster. To retrieve the more granular result, one could
simply iterate over the result of the above metric for
each author, and take only the data for the file one is
interested in.
how an existing metric can be modified to do something
seemingly unrelated.
-This module does not define any auxillery functions.
+This module does not define any auxiliary functions.
--- a/doc/gitstats-branch.txt
+++ b/doc/gitstats-branch.txt
all branches branches that 'branched off' after the
target commit will also have dilution 0.
-It also defines the following auxillery functions:
-* Retreive the name of a commit if it is a the head of a
+It also defines the following auxiliary functions:
+* Retrieve the name of a commit if it is a the head of a
branch. This can be seen as the reverse of 'rev-parse'
for branch heads. This is used internally to provide the
user with a sensible name when telling them which branch
diff --git a/doc/gitstats-bug.txt b/doc/gitstats-bug.txt
--- a/doc/gitstats-bug.txt
+++ b/doc/gitstats-bug.txt
You have to configure a few things to get useful results.
Configuration is trivially done with:
'git config GitStats.key value'. It is also possible to
-override most options on the commandline when running the
+override most options on the command-line when running the
metric.
-The following optiosn are available:
+The following options are available:
* 'GitStats.branch_filter', this defines the regexp that,
when matched, indicates that a branch is a maintenance
branch. When not set, the branch check will be skipped.
after which there is a 'per commit' cost, which is
relatively low.)
-This module does not define any auxillery functions.
+This module does not define any auxiliary functions.
--- a/doc/gitstats-commit.txt
+++ b/doc/gitstats-commit.txt
the following:
* Find all the commits that touched the same paths as the
specified commit. This is implemented by passing the
- result of the 'paths touched' auxillary function to the
- 'commits that touched' auxillary function. See below.
+ result of the 'paths touched' auxiliary function to the
+ 'commits that touched' auxiliary function. See below.
* Retrieve the diff of a commit, either with or without
context, and optionally ignoring whitespace changes. This
Note: the regexps for the 'commit message' and the
'commit diff' may be different.
-It also defines the following auxillary functions:
+It also defines the following auxiliary functions:
* Print a commit in a 'readable' way, this is by default
'git log -1 --name-only'. By the way of an environmental
variable ('GIT_STATS_PRETTY_PRINT'), it can be made to
- instead use 'git log -1 --prety=oneline' by setting the
- variable to 'online'.
+ instead use 'git log -1 --pretty=oneline' by setting the
+ variable to 'oneline'.
* Retrieve all the paths that a specific commit touches,
this is used internally to limit the commits that have
diff --git a/doc/gitstats-diff.txt b/doc/gitstats-diff.txt
--- a/doc/gitstats-diff.txt
+++ b/doc/gitstats-diff.txt
commit by first retrieving the touched files, and then
examining all the commits that that touch the same files.
-It also defines the following auxillery functions:
+It also defines the following auxiliary functions:
* Parse a raw commit diff and store it on a hunk-by-hunk
basis so that later on it can be examined more carefully
by other tools. Line numbers are optionally included so
diff --git a/doc/gitstats-index.txt b/doc/gitstats-index.txt
--- a/doc/gitstats-index.txt
+++ b/doc/gitstats-index.txt
output of this method to one that looks at which lines
were touched for example).
-It also defines the following auxillery functions:
+It also defines the following auxiliary functions:
* Get all the staged changes (optionally ignoring newly
added files). This is used internally to find all the
commits that touched the same files as those that are
--- a/doc/gitstats-matcher.txt
+++ b/doc/gitstats-matcher.txt
that code moves can be detected. This makes use of the
'diff size calculation' described below.
-It also defines the following auxillery functions:
+It also defines the following auxiliary functions:
* Calculate the size of a diff, only counting the amount
of lines added, and the amount of lines deleted. This can
be used to determine a best 'interdiff' (the shortest one
diff --git a/doc/gitstats-stats.txt b/doc/gitstats-stats.txt
--- a/doc/gitstats-stats.txt
+++ b/doc/gitstats-stats.txt
-syntax: stats.py <subcommand> <arguments>
+syntax: stats.py <sub-command> <arguments>
Available commands:
author Activity for one author, file, or project
branch In how far a commit belongs to a branch
- bug Determine whether a commitis a bugfix
+ bug Determine whether a commits a bugfix
commit Basic functionality already present in git
diff Compare two diffs and find reverts
index Find which commits touched the staged files
with '--help' so that a usage message is shown for that
command.
-Each of the modules it uses as subcommands defines a
+Each of the modules it uses as sub-commands defines a
'dispatch' function that is called with the users arguments
(with the exception of the first, which is the name of the
command executed). If anything should be returned to the
system, the dispatch method should return this value.
To run properly it requires the git_stats package to be
-a subdirectory of the directory it resides in. That is,
+a sub-directory of the directory it resides in. That is,
your directory tree should be something like this:
.
|-- git_stats