From: Jonas Fonseca Date: Tue, 16 May 2006 18:11:33 +0000 (+0200) Subject: Sync docs X-Git-Url: https://git.distorted.org.uk/~mdw/tig/commitdiff_plain/395d626e537970a6c5bbc3c07dc0d50ed491d473?hp=-c Sync docs --- 395d626e537970a6c5bbc3c07dc0d50ed491d473 diff --git a/tig.1 b/tig.1 index 02cf8e6..b291fbb 100644 --- a/tig.1 +++ b/tig.1 @@ -324,12 +324,15 @@ Open prompt\&. This allows you to specify what git command to run\&. Example: :log \-p .fi -.SH "SPECIFYING REVISIONS" +.SH "REVISION SPECIFICATION" -This section describes various ways to specify what revisions to display or otherwise limit the view to\&. Note, that tig(1) does not itself parse the described revision options\&. +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)\&. -.SS "File history" + +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" section\&. + +.SS "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: @@ -358,15 +361,22 @@ For the main view, avoiding ambiguity will in some cases require you to specify To speed up interaction with git, you can limit the amount of commits 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\&. + +If you are only interested in changed that happened between two dates you can use: + +.nf +$ tig \-\- \-\-after=may\&.5th \-\-before=2006\-05\-16\&.15:44 +.fi + .RS .Sh "Note" -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" section\&. +The dot ("\&.") is used as a separator instead of a space to avoid having to quote the option value\&. .RE -.SS "Ranges" +.SS "Limiting by commit ranges" Alternatively, commits can be limited to a specific range, such as "all commits between \fItag\-1\&.0\fR and \fItag\-2\&.0\fR"\&. For example: @@ -388,7 +398,10 @@ will list what will be pushed to the remote branch\&. Optionally, the ending \fI .SS "Limiting by reachability" -Git interprets the range specifier "tag\-1\&.0\&.\&.tag\-2\&.0" as "all commits reachable from \fItag\-2\&.0\fR but not from \fItag\-1\&.0\fR"\&. If you prefer to specify which commit to preview in this way use the following: +Git interprets the range specifier "tag\-1\&.0\&.\&.tag\-2\&.0" as "all commits reachable from \fItag\-2\&.0\fR but not from \fItag\-1\&.0\fR"\&. 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: .nf $ tig log tag\-2\&.0 ^tag\-1\&.0 @@ -397,6 +410,24 @@ $ tig log tag\-2\&.0 ^tag\-1\&.0 You can think of \fI^\fR as a negation operator\&. Using this alternate syntax, it is possible to further prune commits by specifying multiple branch cut offs\&. +.SS "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\&." + +.nf +$ tig \-\- \-\-since=1\&.month \-n20 \-\- Documentation/ +.fi + +.SS "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: + +.nf +$ tig \-\- \-\-all \-\-since=1\&.week \-\- Makefile +.fi + .SH "BUGS" diff --git a/tig.1.html b/tig.1.html index 9eeabc8..8fa2ed7 100644 --- a/tig.1.html +++ b/tig.1.html @@ -776,12 +776,17 @@ n -

Specifying revisions

+

Revision specification

This section describes various ways to specify what revisions to display -or otherwise limit the view to. Note, that tig(1) does not itself parse -the described revision options.

-

File history

+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" 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:

@@ -810,17 +815,22 @@ option processing and the latter will be passed to git log.

To speed up interaction with git, you can limit the amount of commits 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.

+

If you are only interested in changed that happened between two dates +you can use:

+
+
+
$ tig -- --after=may.5th --before=2006-05-16.15:44
+
- +
Note
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" section.The dot (".") is used as a separator instead of a space to avoid +having to quote the option value.
-

Ranges

+

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:

@@ -839,7 +849,9 @@ upstream remote branch, using:

Limiting by reachability

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". -If you prefer to specify which commit to preview in this way use the +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:

@@ -848,6 +860,23 @@ following:

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

@@ -896,7 +925,7 @@ gitview(1): git repository browser written using python/gtk.
diff --git a/tig.1.txt b/tig.1.txt index 9c643b0..ce0e353 100644 --- a/tig.1.txt +++ b/tig.1.txt @@ -256,14 +256,20 @@ n:: :log -p [[refspec]] -Specifying revisions --------------------- +Revision specification +---------------------- This section describes various ways to specify what revisions to display -or otherwise limit the view to. Note, that tig(1) does not itself parse -the described revision options. +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). -File history -~~~~~~~~~~~~ +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 <> 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: @@ -286,12 +292,16 @@ To speed up interaction with git, you can limit the amount of commits 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. For example, by configuring the environment -variables described in the <> section. +If you are only interested in changed that happened between two dates +you can use: + + $ 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. + +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: @@ -310,6 +320,9 @@ Limiting by reachability ~~~~~~~~~~~~~~~~~~~~~~~~ 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: @@ -319,6 +332,23 @@ 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 ---- Known bugs and problems: