* Browse changes in a git repository. Additionally, tig(1) can also act
* as a pager for output of various git commands.
*
- * When browsing repositories, tig(1) uses the underlaying git commands
+ * When browsing repositories, tig(1) uses the underlying git commands
* to present the user with various views, such as summarized commit log
* and showing the commit with the log message, diffstat, and the diff.
*
**/
#ifndef VERSION
-#define VERSION "tig-0.1"
+#define VERSION "tig-0.3"
#endif
#ifndef DEBUG
/**
* \--::
- * End of tig(1) options. Useful when specifying commands
- * for the main view. Example:
+ * End of tig(1) options. Useful when specifying command
+ * options for the main view. Example:
*
* $ tig -- --since=1.month
**/
}
/**
- * log [options]::
+ * log [git log options]::
* Open log view using the given git log options.
*
- * diff [options]::
+ * diff [git diff options]::
* Open diff view using the given git diff options.
*
- * show [options]::
+ * show [git show options]::
* Open diff view using the given git show options.
**/
if (!strcmp(opt, "log") ||
break;
}
- /* Make stuff like:
+ /**
+ * [git log options]::
+ * tig(1) will stop the option parsing when the first
+ * command line parameter not starting with "-" is
+ * encountered. All options including this one will be
+ * passed to git log when loading the main view.
+ * This makes it possible to say:
*
* $ tig tag-1.0..HEAD
- *
- * work. */
+ **/
if (opt[0] && opt[0] != '-')
break;
*
* $ tig log --pretty=fuller
*
- * See the "Specifying revisions" section below for an introduction
- * to revision options supported by the git commands. For
- * details on specific git command options, refer to the man
- * page of the command in question.
+ * See the <<refspec, "Specifying revisions">> section below
+ * for an introduction to revision options supported by the git
+ * commands. For details on specific git command options, refer
+ * to the man page of the command in question.
**/
if (opt_request == REQ_VIEW_MAIN)
**/
#define TIG_LS_REMOTE \
- "git ls-remote ."
+ "git ls-remote . 2>/dev/null"
/**
+ * [[view-commands]]
* View commands
* ~~~~~~~~~~~~~
* It is possible to alter which commands are used for the different views.
#define TIG_MAIN_CMD \
"git log --topo-order --stat --pretty=raw %s"
-/* We silently ignore that the following are also exported. */
+/* ... silently ignore that the following are also exported. */
#define TIG_HELP_CMD \
- "man tig 2> /dev/null"
+ "man tig 2>/dev/null"
#define TIG_PAGER_CMD \
""
static struct view_ops pager_ops;
static struct view_ops main_ops;
-char ref_head[SIZEOF_REF] = "HEAD";
-char ref_commit[SIZEOF_REF] = "HEAD";
+static char ref_head[SIZEOF_REF] = "HEAD";
+static char ref_commit[SIZEOF_REF] = "HEAD";
#define VIEW_STR(name, cmd, env, ref, objsize, ops) \
{ name, cmd, #env, ref, objsize, ops }
int request;
};
-struct keymap keymap[] = {
+static struct keymap keymap[] = {
/**
* View switching
* ~~~~~~~~~~~~~~
* h::
* Show man page.
* Return::
- * If on a commit line show the commit diff. Addiionally, if in
+ * If on a commit line show the commit diff. Additionally, if in
* main or log view this will split the view. To open the commit
* diff in full size view either use 'd' or press Return twice.
* Tab::
* Cursor navigation
* ~~~~~~~~~~~~~~~~~
* Up::
- * Move curser one line up.
+ * Move cursor one line up.
* Down::
* Move cursor one line down.
* k::
- * Move curser one line up and enter. When used in the main view
+ * Move cursor one line up and enter. When used in the main view
* this will always show the diff of the current commit in the
* split diff view.
* j::
* Move cursor one line down and enter.
* PgUp::
- * Move curser one page up.
+ * Move cursor one page up.
* PgDown::
* Move cursor one page down.
* Home::
* z::
* Stop all background loading. This can be useful if you use
* tig(1) in a repository with a long history without limiting
- * the log output.
+ * the revision log.
* v::
* Show version.
* n::
*/
static struct ref *refs;
-size_t refs_size;
+static size_t refs_size;
static struct ref **
get_refs(char *id)
pclose(pipe);
+ if (refs_size == 0)
+ die("Not a git repository");
+
return OK;
}
}
/**
- * Specifying revisions
- * --------------------
- * This section describes various ways to specify what revisions to
- * display or otherwise limit the view to.
+ * [[refspec]]
+ * Revision specification
+ * ----------------------
+ * This section describes various ways to specify what revisions to display
+ * or otherwise limit the view to. tig(1) does not itself parse the described
+ * revision options so refer to the relevant git man pages for futher
+ * information. Relevant man pages besides git-log(1) are git-diff(1) and
+ * git-rev-list(1).
+ *
+ * You can tune the interaction with git by making use of the options
+ * explained in this section. For example, by configuring the environment
+ * variables described in the <<view-commands, "View commands">> section.
+ *
+ * Limit by path name
+ * ~~~~~~~~~~~~~~~~~~
+ * If you are interested only in those revisions that made changes to a
+ * specific file (or even several files) list the files like this:
+ *
+ * $ tig log Makefile
+ *
+ * To avoid ambiguity with repository references such as tag name, be sure
+ * to separate file names from other git options using "\--". So if you
+ * have a file named 'master' it will clash with the reference named
+ * 'master', and thus you will have to use:
+ *
+ * $ tig log -- master
+ *
+ * NOTE: For the main view, avoiding ambiguity will in some cases require
+ * you to specify two "\--" options. The first will make tig(1) stop
+ * option processing and the latter will be passed to git log.
*
* Limit by date or number
* ~~~~~~~~~~~~~~~~~~~~~~~
* to show both for the log and main view. Either limit by date using
* e.g. `--since=1.month` or limit by the number of commits using `-n400`.
*
- * NOTE: You can tune the interaction with git by making use of the options
- * explained in this section.
+ * If you are only interested in changed that happened between two dates
+ * you can use:
*
- * NOTE: tig(1) does not itself parse the revision options
- * described in this section.
+ * $ tig -- --after=May.5th --before=2006-05-16.15:44
*
- * Ranges
- * ~~~~~~
+ * NOTE: The dot (".") is used as a separator instead of a space to avoid
+ * having to quote the option value. If you prefer use `--after="May 5th"`
+ * instead of `--after="May 5th"`.
+ *
+ * Limiting by commit ranges
+ * ~~~~~~~~~~~~~~~~~~~~~~~~~
* Alternatively, commits can be limited to a specific range, such as
* "all commits between 'tag-1.0' and 'tag-2.0'". For example:
*
* ~~~~~~~~~~~~~~~~~~~~~~~~
* Git interprets the range specifier "tag-1.0..tag-2.0" as
* "all commits reachable from 'tag-2.0' but not from 'tag-1.0'".
+ * Where reachability refers to what commits are ancestors (or part of the
+ * history) of the branch or tagged revision in question.
+ *
* If you prefer to specify which commit to preview in this way use the
* following:
*
* $ tig log tag-2.0 ^tag-1.0
*
- * You can think of '^' as a negator. Using this alternate syntax, it is
- * possible to furthur prune commits by specifying multiple negators.
+ * You can think of '^' as a negation operator. Using this alternate syntax,
+ * it is possible to further prune commits by specifying multiple branch
+ * cut offs.
+ *
+ * Combining revisions specification
+ * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ * Revisions options can to some degree be combined, which makes it possible
+ * to say "show at most 20 commits from within the last month that changed
+ * files under the Documentation/ directory."
+ *
+ * $ tig -- --since=1.month -n20 -- Documentation/
+ *
+ * Examining all repository references
+ * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ * In some cases, it can be useful to query changes across all references
+ * in a repository. An example is to ask "did any line of development in
+ * this repository change a particular file within the last week". This
+ * can be accomplished using:
+ *
+ * $ tig -- --all --since=1.week -- Makefile
*
* BUGS
* ----
~mdw / tig / blobdiff