From 18b4c2d893dd5994f249b2325746f6c9530dfb9c Mon Sep 17 00:00:00 2001 From: Sverre Rabbelier Date: Thu, 31 Jul 2008 06:19:33 +0200 Subject: [PATCH] gitstats: Ran ispell on all gitstats-* files in doc/ With this, all files in doc/ have been spellchecked, the source files are probably too bothersome to spellcheck. --- doc/gitstats-author.txt | 4 ++-- doc/gitstats-branch.txt | 4 ++-- doc/gitstats-bug.txt | 6 +++--- doc/gitstats-commit.txt | 10 +++++----- doc/gitstats-diff.txt | 2 +- doc/gitstats-index.txt | 2 +- doc/gitstats-matcher.txt | 2 +- doc/gitstats-stats.txt | 8 ++++---- 8 files changed, 19 insertions(+), 19 deletions(-) diff --git a/doc/gitstats-author.txt b/doc/gitstats-author.txt index ba017ff..52e093b 100644 --- a/doc/gitstats-author.txt +++ b/doc/gitstats-author.txt @@ -15,7 +15,7 @@ the following: * 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. @@ -26,5 +26,5 @@ the following: 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. diff --git a/doc/gitstats-branch.txt b/doc/gitstats-branch.txt index 62ef971..e3a87e9 100644 --- a/doc/gitstats-branch.txt +++ b/doc/gitstats-branch.txt @@ -20,8 +20,8 @@ the following: 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 index 17032d9..a89fa58 100644 --- a/doc/gitstats-bug.txt +++ b/doc/gitstats-bug.txt @@ -32,10 +32,10 @@ one-liners, and you set it to ignore one difference...) 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. @@ -93,5 +93,5 @@ following: 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. diff --git a/doc/gitstats-commit.txt b/doc/gitstats-commit.txt index 9daecc5..79bd87a 100644 --- a/doc/gitstats-commit.txt +++ b/doc/gitstats-commit.txt @@ -9,8 +9,8 @@ Currently the available metrics in the author module are 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 @@ -25,12 +25,12 @@ the following: 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 index 68cdd5c..fe333b7 100644 --- a/doc/gitstats-diff.txt +++ b/doc/gitstats-diff.txt @@ -14,7 +14,7 @@ following: 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 index 66c79eb..517260f 100644 --- a/doc/gitstats-index.txt +++ b/doc/gitstats-index.txt @@ -11,7 +11,7 @@ following: 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 diff --git a/doc/gitstats-matcher.txt b/doc/gitstats-matcher.txt index 682ffbb..6ab9d53 100644 --- a/doc/gitstats-matcher.txt +++ b/doc/gitstats-matcher.txt @@ -10,7 +10,7 @@ following: 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 index 675226a..e32289a 100644 --- a/doc/gitstats-stats.txt +++ b/doc/gitstats-stats.txt @@ -1,9 +1,9 @@ -syntax: stats.py +syntax: stats.py 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 @@ -16,14 +16,14 @@ arguments are passed, it automatically runs the command 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 -- 2.11.4.GIT