We are currently indexing your data, so search results may be incomplete until we finish.
stable doc: improve readability, add content. Part 3
Changeset 2bae10a0b3b8…
Parent 6394f8914483…
by
Changes to 2 files · Browse files at 2bae10a0b3b8 Showing diff from parent 6394f8914483 Diff from another changeset...
|
|
|
@@ -1,27 +1,9 @@ - TortoiseHg Changelog Viewer
-===========================
+Changelog
+=========
.. module:: changelog.dialog
:synopsis: Dialog used to view log
-.. figure:: figures/log.png
- :alt: Changelog
-
- Changelog viewer dialog
-
-The toolbar buttons from left to right:
-
-:guilabel:`Refresh`
- Reload the revision history (if you commit in another window, etc)
-:guilabel:`Filter`
- Open revision filter dialog, also has drop-down for common filters
-:guilabel:`Datamine`
- Open datamine application for history searches and file annotations
-:guilabel:`Other Parent`
- Only active when viewing merge changesets, toggles parents
-:guilabel:`Synchronize`
- Communicate changes with other repositories
-
The changelog tool is primarily used to visualize the revision history
of your repository. It presents a graph of the revision history, showing
the parent/child relationship of each change. At each revision you can
@@ -32,6 +14,25 @@tool for viewing and selecting changesets, we use it to perform nearly
all our tasks that involve changeset manipulation.
+.. figure:: figures/log.png
+ :alt: Changelog
+
+ Changelog viewer dialog
+
+The toolbar buttons from left to right:
+
+ :guilabel:`Refresh`
+ Reload the revision history (if you commit in another window, etc)
+ :guilabel:`Filter`
+ Open revision filter dialog. The toolbar button also has
+ drop-down for common filters
+ :guilabel:`Datamine`
+ Open datamine application for history searches and file annotations
+ :guilabel:`Other Parent`
+ Toggles parent revision when viewing merge changesets
+ :guilabel:`Synchronize`
+ Opens synchronize tool to communicate changes with other repositories
+
Revision Graph Details
----------------------
@@ -45,12 +46,12 @@On the right of the revision graph are three buttons. From top to bottom
these are:
-:guilabel:`column toggles`
- toggle the display of columns in the graph
-:guilabel:`next-N revisions`
- load the next N revisions into the graph
-:guilabel:`all revisions`
- load all remaining revisions into the graph
+ :guilabel:`column toggles`
+ toggle the display of columns in the graph
+ :guilabel:`next-N revisions`
+ load the next N revisions into the graph
+ :guilabel:`all revisions`
+ load all remaining revisions into the graph
The column visibility toggles are sticky settings.
@@ -61,52 +62,56 @@Right-clicking on a revision in the (top) graph pane will bring up the
revision context menu.
-:guilabel:`visualize change`
- open this change in your visual diff tool
-:guilabel:`display change`
- open this changeset in the changeset browser (more below)
-:guilabel:`diff to local`
- display changes (visual diff) between this revision and your current
- working directory
-:guilabel:`update`
- update your working directory to this revision [#rcm1]_
-:guilabel:`merge with`
- merge with this revision [#rcm2]_
-:guilabel:`copy hash`
- copy current revision's full hash to the clipboard
-:guilabel:`export patch`
- generate a patch file of this revision's changes
-:guilabel:`email patch`
- send this revision's changes to email recipient [#rcm3]_
-:guilabel:`bundle rev:tip`
- create a bundle with all revs from selected to tip
-:guilabel:`add/remove tag`
- opens the TortoiseHg tag dialog with this revision selected
-:guilabel:`backout`
- create a backout changeset for selected revision
-:guilabel:`revert`
- revert working copy to this revision's contents, without updating working
- directory parent revision. Use with care.
-:guilabel:`strip`
- Remove the selected revision and all of it's descendants from the
- repository [#rcm4]_
+ :guilabel:`visualize change`
+ open this change in your visual diff tool
+ :guilabel:`display change`
+ open this changeset in the changeset browser (more below)
+ :guilabel:`diff to local`
+ display changes (visual diff) between this revision and your
+ current working directory
+ :guilabel:`update`
+ update your working directory to this revision [#rcm1]_
+ :guilabel:`merge with`
+ merge with this revision [#rcm2]_
+ :guilabel:`copy hash`
+ copy current revision's full hash to the clipboard
+ :guilabel:`export patch`
+ generate a patch file containing this revision's changes
+ :guilabel:`email patch`
+ send this revision's changes to email recipient [#rcm3]_
+ :guilabel:`bundle rev:tip`
+ create a bundle with all revs from selected to tip
+ :guilabel:`add/remove tag`
+ opens the TortoiseHg tag dialog with this revision selected
+ :guilabel:`backout`
+ create a backout changeset for selected revision
+ :guilabel:`revert`
+ revert working copy to this revision's contents, without
+ updating working directory parent revision. Use with care.
+ :guilabel:`strip`
+ Remove the selected revision and all of it's descendants from the
+ repository [#rcm4]_
If you right-click on a row other than the one that was currently
selected, you get a different context menu. This context menu has
commands that deal with arbitrary revision ranges.
-:guilabel:`diff with selected`
- Description
-:guilabel:`visual diff with selected` [#rcm5]_
- Description
-:guilabel:`email from here to selected`
- Description
-:guilabel:`bundle from here to selected`
- Description
-:guilabel:`merge with selected` [#rcm6]_
- Description
-
+ :guilabel:`diff with selected`
+ Opens status viewer with cumulative changes of the range of
+ changesets.
+ :guilabel:`visual diff with selected` [#rcm5]_
+ Opens visual diff window with cumulative changes of the range
+ of changesets.
+ :guilabel:`email from here to selected`
+ Opens email dialog with range of changesets.
+ :guilabel:`bundle from here to selected`
+ Creates a bundle file with range of changesets.
+ :guilabel:`merge with selected` [#rcm6]_
+ Merges this revision with the current working directory parent
+ revision. This menu item is only sensitive when the working
+ parent is the current selected revision.
+
.. [#rcm1] Opens the TortoiseHg update/checkout dialog with this revision selected.
.. [#rcm2] Opens the TortoiseHg merge dialog with this revision selected.
.. [#rcm3] Opens the TortoiseHg email dialog with this revision selected.
@@ -119,24 +124,25 @@
-File List Context Menus
------------------------
+File Context Menus
+------------------
Right-clicking on filenames in the file list (bottom left) pane will
bring up a context menu for the selected file:
-:guilabel:`visual diff`
- Open this revision of the file in your visual editor [#flcm1]_
-:guilabel:`diff to local`
- Visualize differences between this revision and your checked out version
-:guilabel:`save at revision`
- Write this revision of the file to specified location
-:guilabel:`file history`
- Show revisions that modified this file [#flcm2]_
-:guilabel:`annotate file`
- Open this file in the datamine app, annotated at this revision
-:guilabel:`revert file contents`
- Checkout this specific revision of this file [#flcm3]_
+ :guilabel:`visual diff`
+ Open this revision of the file in your visual editor [#flcm1]_
+ :guilabel:`diff to local`
+ Visualize differences between this revision and your checked
+ out version
+ :guilabel:`save at revision`
+ Write this revision of the file to specified location
+ :guilabel:`file history`
+ Show revisions that modified this file [#flcm2]_
+ :guilabel:`annotate file`
+ Open this file in the datamine app, annotated at this revision
+ :guilabel:`revert file contents`
+ Checkout this specific revision of this file [#flcm3]_
.. [#flcm1] :menuselection:`Global Settings --> TortoiseHg --> Visual Editor`
.. [#flcm2] Does not show revisions where a file was deleted, as this is only a
@@ -151,7 +157,8 @@a performance optimization. If you would like to see all of the file
diffs at once, click on the :guilabel:`[All Files]` row. The changeset
browser will also skip displaying diffs for files which are above a
-maximum limit. See :menuselection:`Global Settings --> TortoiseHg --> Max Diff Size`
+maximum limit. See
+:menuselection:`Global Settings --> TortoiseHg --> Max Diff Size`
The changelog and datamine tools can open the changeset browser to view
a single revision or the combined effect of a range of revisions. The
@@ -159,33 +166,40 @@a file list on the left of all files that have been changed, and a diff
pane on the right with the changes to each file.
-In release 0.7 of TortoiseHg, the 'diff change with' changeset browser
-acquired the same change selection feature as the commit tool. You can
-select files and hunks that you wish to extract from the changeset(s)
-you are browsing and write them to a patch file using the
-:guilabel:`Save as` toolbar button. This is a very efficient way to
-cherry pick changes from a repository. This changeset browser also
-supports the :kbd:`Ctrl-C` keyboard accelerator to copy hightlighted
-diff hunks to the clipboard.
+When opened in the 'diff change with' mode, you can select files and
+hunks that you wish to extract from the changeset(s) you are browsing
+and write them to a patch file using the :guilabel:`Save as` toolbar
+button. This is a very efficient way to cherry pick changes from a
+repository. This changeset browser also supports the :kbd:`Ctrl-C`
+keyboard accelerator to copy hightlighted diff hunks to the clipboard.
Unfortunately, TortoiseHg still does not have a dialog for importing
changes into a repository, so this must be done on the command line with
the :command:`hg import` command.
+Keyboard navigation
+-------------------
+
+:kbd:`Ctrl-P`
+ Zoom to the working directory parent revision
+:kbd:`Ctrl-D`
+ Display visual diffs for selected changeset or file
+
+
Configurables
-------------
The changelog browser has a few configurable options that can be set in
the TortoiseHg Settings dialog on the Changelog tab.
-:guilabel:`Author coloring`
- If true, each author's changeset will be given a unique color
-:guilabel:`Long Summary`
- Concatenate commit message lines until 80 chars are reached
-:guilabel:`Graph batch limit`
- Number of revisions to read in each batch load
-:guilabel:`Copy Hash`
- Copy a revision's changeset id hash to the clipboard when selected
+ :guilabel:`Author coloring`
+ If true, each author's changeset will be given a unique color
+ :guilabel:`Long Summary`
+ Concatenate commit message lines until 80 chars are reached
+ :guilabel:`Graph batch limit`
+ Number of revisions to read in each batch load
+ :guilabel:`Copy Hash`
+ Copy a revision's changeset id hash to the clipboard when selected
The exact colors given to particular users can be configured by adding
lines like these to your :file:`Mercurial.ini` file: ::
@@ -196,12 +210,12 @@The changelog browser also respects the following settings on the
TortoiseHg tab:
-:guilabel:`Tab Width`
- Number of spaces to expand tabs in diffs
-:guilabel:`Max Diff Size`
- Maximum size of file to be diffed
-:guilabel:`Bottom Diffs`
- Show diffs below file list
+ :guilabel:`Tab Width`
+ Number of spaces to expand tabs in diffs
+ :guilabel:`Max Diff Size`
+ Maximum size of file to be diffed
+ :guilabel:`Bottom Diffs`
+ Show diffs below file list
From command line
@@ -209,19 +223,16 @@
The changelog viewer can be started from command line ::
- hgtk log
+ hgtk log [OPTIONS] [FILE]
-or ::
+ aliases: history
- hgtk history
+ changelog viewer
-The syntax is ::
+ options:
- hgtk log [OPTIONS] [FILES]
+ -l --limit limit number of changes displayed
-Valid [OPTIONS] are:
-
-``-l``, ``--limit``
- Specify the limit number of changes displayed.
+ use "hgtk -v help log" to show global options
.. vim: noet ts=4
|
|
|
|
@@ -1,5 +1,5 @@ - TortoiseHg Datamine
-===================
+Datamine
+========
.. module:: datamine.dialog
:synopsis: Dialog used to search in the history
@@ -13,7 +13,7 @@-----------
.. figure:: figures/search.png
- :alt: Search dialog
+ :alt: Search dialog
Search dialog
@@ -22,30 +22,29 @@
The text entry fields have these purposes:
-*regexp*
- this is where you enter your regular expression search criteria.
-*includes*
- a comma separated list of paths to include in your search. If no
- paths are given, the search is assumed to be repository wide. In
- other words, specifying an include path actually narrows the search
- criteria.
-*excludes*
- a comma separated list of paths to exclude from your search.
- Exclusion patterns are applied after inclusion patterns.
+ :guilabel:`regexp`
+ Regular expression search criteria.
+ :guilabel:`includes`
+ Comma separated list of paths to include in your search. If no
+ paths are given, the search is assumed to be repository wide. In
+ other words, specifying an include path actually narrows the
+ search criteria.
+ :guilabel:`excludes`
+ Comma separated list of paths to exclude from your search.
+ Exclusion patterns are applied after inclusion patterns.
The toggle buttons below the entry fields are for:
-:guilabel:`Follow copies and renames`
- follow searches through copies and renames out of inclusion filters
-:guilabel:`Ignore case`
- Perform the search without case considerations
-:guilabel:`Show line numbers`
- Show line numbers at the front of the matching lines
-:guilabel:`Show all matching revisions`
- Show every instance where the search criteria matches in a file, not
- just the most recent revision. It shows +/- to indicate whether the
- change adds or removes your search text.
-
+ :guilabel:`Follow copies and renames`
+ follow searches through copies and renames out of inclusion filters
+ :guilabel:`Ignore case`
+ Perform the search without case considerations
+ :guilabel:`Show line numbers`
+ Show line numbers at the front of the matching lines
+ :guilabel:`Show all matching revisions`
+ Show every instance where the search criteria matches in a file,
+ not just the most recent revision. It shows +/- to indicate
+ whether the change adds or removes your search text.
Search tabs are named after the search string most recently used to
start a search. The :guilabel:`New Search` toolbar button will
@@ -54,18 +53,19 @@sensitive when a search is in progress).
Matches
--------
+^^^^^^^
Each match will be a link to a changeset and will have a descriptive
tooltip (author, date/time, summary). Right clicking on a matched line
will bring up a context menu with these features:
-:guilabel:`display change`
- open a changeset window with this changeset, to see the full context
-:guilabel:`annotate file`
- open an annotation tab for this file at this revision
-:guilabel:`file history`
- open a changelog window with this file's revision history
+ :guilabel:`display change`
+ open a changeset window with this changeset, to see the full context
+ :guilabel:`annotate file`
+ open an annotation tab for this file at this revision
+ :guilabel:`file history`
+ open a changelog window with this file's revision history
+
Annotate Tabs
-------------
@@ -82,11 +82,12 @@
In the bottom pane is the actual annotation. Each line in the annotation
is also a link to the changeset which provided that line. Activating a
-row will open that changeset in the changeset browser.
+row will zoom the changelog (top pane) to the changeset that introduced
+that line and change focus to the top pane.
-The color scheme in the annotation pane is two tier. Authors are
-determined by hue, and age is determined by saturation. The older a
-change is, the lighter the color becomes.
+The color scheme in the annotation pane is two dimensional. Authors
+determine hue, and age determines saturation. The older a change, the
+lighter the color.
By right-clicking on the annotate pane's column headers (Line, Rev,
Source) you can bring up a menu for showing two optional columns:
@@ -96,7 +97,7 @@^^^^^^^^^^^^^^^^^
The annotation data will automatically follow lines of code back through
-copies and renames to find the initial changeset that introduced that
+copies and renames to find the initial changeset that introduced the
line. The graph log pane will not follow renames or copies
automtaically. Instead, when you click on a changeset in the revision
graph that involved a rename or copy event, a button will appear that
@@ -112,6 +113,9 @@
:menuselection:`Changelog --> Author Coloring`
Give each author a separate color in the changelog graph
+:menuselection:`Changelog --> Long Summary`
+ Concatenates lines of commit message together to reach an 80
+ character summary.
:menuselection:`TortoiseHg --> Tab width`
Number of spaces to expand tabs in diffs and annotate output
@@ -122,14 +126,10 @@
hgtk datamine
-or ::
+ aliases: annotate, blame
- hgtk annotate
+ repository search and annotate tool
-or ::
-
- hgtk blame
-
-The syntax is simple, no options or parameters are needed, except the global options.
+ use "hgtk -v help datamine" to show global options
.. vim: noet ts=4
|
Add a tag
Loading...