We are currently indexing your data, so search results may be incomplete until we finish.
stable doc: fix section puntaction
Changeset 59979ef85be5…
Parent ef6a0a326d32…
by
Changes to 9 files · Browse files at 59979ef85be5 Showing diff from parent ef6a0a326d32 Diff from another changeset...
|
@@ -1,4 +1,3 @@ - ===========================
TortoiseHg Changelog Viewer
===========================
@@ -32,7 +31,7 @@This changelog browser offers much more.
Revision Graph Details
-======================
+----------------------
The graph column shows the child-parent relationships between revisions
in your repository history. This column auto-sizes for as many lines of
@@ -51,7 +50,7 @@ load all remaining revisions into the graph
Revision Context Menus
-======================
+----------------------
Right-clicking on a revision in the (top) graph pane will bring up the
revision context menu.
@@ -114,7 +113,7 @@
File List Context Menus
-=======================
+-----------------------
Right-clicking on filenames in the file list (bottom left) pane will
bring up a context menu for the selected file:
@@ -139,7 +138,7 @@
Changeset browser
-=================
+-----------------
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
@@ -160,7 +159,7 @@accelerator to copy hightlighted diff hunks to the clipboard.
Configurables
-=============
+-------------
The changelog browser has a few configurable options that can be set in
the TortoiseHg Settings dialog on the Changelog tab.
@@ -192,7 +191,7 @@
From command line
-=================
+-----------------
The changelog viewer can be started from command line ::
|
||
|
|
|
@@ -1,4 +1,3 @@ - ======================
TortoiseHg Commit Tool
======================
@@ -24,7 +23,7 @@ Commit dialog
Features
-========
+--------
Walking across the toolbar, the buttons perform the following tasks:
@@ -81,7 +80,7 @@rename.
Change Selection (record)
-=========================
+-------------------------
So what does that mean when it says the commit button will commit the
selected diffs in checked files? Simple, the native TortoiseHg commit
@@ -92,7 +91,7 @@Mercurial's record extension will recognize this immediately.
When is this necessary?
------------------------
+^^^^^^^^^^^^^^^^^^^^^^^
Most often, it is when you have made more than a single coherent change
to your source code and you would like to commit your changes piecemeal.
@@ -102,7 +101,7 @@indespensable.
How does it work?
------------------
+^^^^^^^^^^^^^^^^^
By double-clicking on individual change hunks in the diff panel.
*Technically, any action which activates a change hunk row will toggle
@@ -119,7 +118,7 @@partially included, or excluded entirely.
What happens at commit time?
-----------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The short answer is that the selected files and hunks are committed to
the repository and the unselected changes are left in your working
@@ -145,7 +144,7 @@
Keyboard navigation
-===================
+-------------------
:kbd:`Ctrl-Enter`
will trigger the commit
@@ -163,7 +162,7 @@
File Context Menus
-==================
+------------------
By right clicking on files in the file list, you will get a context menu
of commands that are applicable to the selected file. If you configure a
@@ -177,7 +176,7 @@
Merges
-======
+------
The commit tool has a special mode when it is opened in a repository
that is in a merged state (technically, this means the current working
@@ -203,7 +202,7 @@
Commit Message Format
-=====================
+---------------------
If your project has guidelines for commit message format, you can
configure those in the settings tool. Once configured, the commit tool
@@ -212,7 +211,7 @@on the commit message pane that will try to enforce your policy.
MQ patches
-==========
+----------
Many advanced Mercurial users use the MQ extension to manage a patch
queue. TortoiseHg does not offer much in the way of support for MQ, but
@@ -243,7 +242,7 @@patches and take advantage of our excellent change selection support.
QNew Mode
-=========
+---------
Newly added in 0.8, the commit tool can be used to create a new patch
for your patch queue. If you have the MQ extension enabled, a text
@@ -272,7 +271,7 @@
Configurables
-=============
+-------------
:menuselection:`Commit --> Username`
Sets username associated with your commits
@@ -290,7 +289,7 @@External tool configuration is deprecated and will be removed in 0.9
From command line
-=================
+-----------------
The commit tool can be started from command line ::
@@ -323,7 +322,7 @@
Changes since 0.7
-=================
+-----------------
* The :guilabel:`Show Diff` button has been removed. Diffs are always shown.
* The commit tool no longer shows all diffs at startup. Only the first
@@ -349,7 +348,7 @@
Changes since 0.6
-=================
+-----------------
Large changes were made to the commit tool in the 0.7 release. The
previous default tool, Qct, was unbundled and TortoiseHg's native commit
|
|
@@ -1,4 +1,3 @@ - ===============
Common Features
===============
@@ -9,7 +8,7 @@here just once.
Geometry Restore
-================
+----------------
Our primary applications like commit, changelog, and datamine will
restore their geometry and position from the last time they were run.
@@ -22,7 +21,7 @@window manager to place them where it wishes.
Keyboard Accelerators
-=====================
+---------------------
We define a few keyboard accelerators that all of the TortoiseHg tools support.
@@ -47,7 +46,7 @@access cut-paste functionality, for instance.
Visual Diffs
-============
+------------
0.8 introduced a visual diff dialog that solves four usability issues:
@@ -61,7 +60,7 @@dialog and :menuselection:`TortoiseHg --> Skip Diff Window`.
Treeview searches
-=================
+-----------------
Many TortoiseHg dialogs use treeviews to present lists of data to the
user. The file lists in the status, commit, shelve, and changelog tools
@@ -82,7 +81,7 @@ matching lines
HG command dialog
-=================
+-----------------
Many TortoiseHg tools use the *hgcmd* dialog to execute Mercurial
commands that could potentially be interactive. In release 0.8, the
|
||
|
|
|
- ===================
TortoiseHg Datamine
===================
.. module:: datamine.dialog
:synopsis: Dialog used to search in the history
The datamine application is used to inspect the revision history of your
repository. It is a tabbed application that supports two tab types,
*Search* and *Annotate*.
Search Tabs
-===========
+-----------
.. figure:: figures/search.png
:alt: Search dialog
Search dialog
The search tab is used to search (*grep*) through your entire revision
history for keywords, variable names, functions, etc...
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.
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.
Search tabs are named after the search string most recently used to
start a search. The :guilabel:`New Search` toolbar button will
obviously open a new search tab while the :guilabel:`Stop` button will
terminate an ongoing search (the :guilabel:`Stop` button is only
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
Annotate Tabs
-=============
+-------------
.. figure:: figures/annotate.png
:alt: Annotate tabs
Annotate tabs
The revision graph has a simple context menu for opening the entire
changeset in the changeset browser. Activating a row in the revision
graph updates the file annotation to that revision.
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.
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.
By right-clicking on the annotate pane's column headers (Line, Rev,
Source) you can bring up a menu for showing two optional columns:
:guilabel:`filename` and :guilabel:`user`.
Following Renames
------------------
+^^^^^^^^^^^^^^^^^
The annotation data will automatically follow lines of code back through
copies and renames to find the initial changeset that introduced that
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
will allow you to follow the history graph back through the rename.
Clicking on the button will open a new tab with the older filename
annotated at the same changeset.
Configurables
--------------
+^^^^^^^^^^^^^
The annotate tabs support the following configurations defined primarily
for other tools:
:menuselection:`Changelog --> Author Coloring`
Give each author a separate color in the changelog graph
:menuselection:`TortoiseHg --> Tab width`
Number of spaces to expand tabs in diffs and annotate output
From command line
-=================
+-----------------
The datamine tool can be started from command line ::
hgtk datamine
or ::
hgtk annotate
or ::
hgtk blame
The syntax is simple, no options or parameters are needed, except the global options.
.. vim: noet ts=4
|
|
@@ -1,12 +1,11 @@ - ============================
Windows Explorer Integration
-============================
+----------------------------
.. module:: explorer
:synopsis: Windows explorer integration
Overlay Icons
-=============
+-------------
TortoiseHg provides visual representation of the file status via overlay
icons in the MS-Explorer windows. This is similar to those that found on
@@ -35,7 +34,7 @@ @@noicons
Performance Issues
-==================
+------------------
When the repository being viewed contains a large number of folders or
files, the overlay icons may appear case a perceivable delay in
@@ -55,7 +54,7 @@local disks only.
Context Menus
-=============
+-------------
The TortoiseHg commands (GUI window & dialogs) may be accessed via the
context menu of Explorer windows. The TortoiseHg context menu is
|
||
|
|
||
|
@@ -1,4 +1,3 @@ - ================
TortoiseHg Serve
================
@@ -47,7 +46,7 @@shell context menu.
From command line
-=================
+-----------------
The server tool can be started from command line ::
@@ -65,7 +64,7 @@
Changes since 0.7
-=================
+-----------------
* Improved error handling
* i18n fixes
|
||
|
@@ -1,4 +1,3 @@ - ======================
TortoiseHg Shelve Tool
======================
@@ -51,7 +50,7 @@clean, ignored}.
Shelving Changes
-================
+----------------
Just like the commit tool, this dialog uses TortoiseHg's integrated hunk
@@ -66,7 +65,7 @@to the working directory.
How is this different from record/commit?
------------------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Shelved changes are physically removed from the working directory until
you unshelve them. This means you can build your project and run tests
@@ -84,7 +83,7 @@changes made to your code after the shelving.
How is this different from MQ?
-------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
A shelf is, in effect, a single unnamed MQ patch that is never converted
into a changeset. The shelve tool can be useful when you are
@@ -92,7 +91,7 @@re-apply them to another patch (or an entirely new patch).
How is this different from attic?
----------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The attic extension is a super-set of the shelve feature. In particular,
attic allows you to have several named *shelves* which can be saved and
@@ -101,7 +100,7 @@releases.
Keyboard navigation
-===================
+-------------------
:guilabel:`Ctrl-C`
in the diff panel will copy the currently highlighted (not selected,
@@ -116,13 +115,13 @@clipboard contents always be a valid patch.
Configurables
-=============
+-------------
* :menuselection:`TortoiseHg --> Bottom Diffs`
* :menuselection:`TortoiseHg --> Tab Width`
From command line
-=================
+-----------------
The shelve tool can be started from command line ::
|
||
|
@@ -1,4 +1,3 @@ - ======================
TortoiseHg Synchronize
======================
@@ -96,7 +95,7 @@
After Pull
-==========
+----------
After changesets are pulled into your repository, two buttons may appear
at the bottom of the dialog:
@@ -109,7 +108,7 @@Either button may be hidden if it is not applicable.
Email
-=====
+-----
.. figure:: figures//email.png
:alt: Email dialog
@@ -137,7 +136,7 @@plain patches, HG patches, Git patches, and bundles.
From command line
-=================
+-----------------
The synchronize tool can be started from command line ::
@@ -171,7 +170,7 @@path it finds.
Changes since 0.7
-=================
+-----------------
* Path drop-down list no longer includes most-recently-used paths. It
only includes configured repository paths.
|
||
Add a tag
Loading...