by
Changes to 15 files · Browse files at 174f73d980d2 Showing diff from parent 84084745ccf4 b59b401ddb61 Diff from another changeset...
@@ -20,3 +20,50 @@ On Windows, if you have no make tool you can use build.bat. If HTML
compiler and miktex are installed you can directly generate chm
(build chm) and pdf (build pdf).
+
+Hacking the source
+==================
+
+Please follow this rules when hacking the doc source files.
+
+- As suggested by Sphinx (see http://sphinx.pocoo.org/rest.html#sections)
+ use:
+
+ *************
+ Chapter title
+ *************
+
+ Section title
+ =============
+
+ Subsection title
+ ----------------
+
+ Subsubsection title
+ ^^^^^^^^^^^^^^^^^^^
+
+- To indicate a key or a combination of keys use :kbd:, for example:
+
+ :kbd:`Ctrl-A`
+
+- To indicate a label, button or anything that appears in user interfaces
+ use :guilabel:, for example:
+
+ :guilabel:`Commit`
+
+- To indicate a menu choise use :menuselection: and -->, for example:
+
+ :menuselection:`TortoiseHg... --> About`
+
+- To indicate a file use :file:, for example:
+
+ :file:`.hg/hgrc`
+
+- To indicate a command to enter into command window use :command:, for example:
+
+ :command:`hgtk log`
+
+- To indicate a text to enter into a text input field in the GUI use ``, for example:
+
+ ``myproxy:8000``
+
|
@@ -1,6 +1,6 @@ - ===========================
+***************************
TortoiseHg Changelog Viewer
-===========================
+***************************
.. module:: changelog.dialog
:synopsis: Dialog used to view log
@@ -32,7 +32,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 +51,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 +114,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 +139,8 @@
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
changeset browser is very similar to the commit and shelve tools. It has
@@ -159,7 +160,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.
@@ -191,7 +192,7 @@
From command line
------------------
+=================
The changelog viewer can be started from command line ::
|
|
|
@@ -1,6 +1,6 @@ - ======================
+**********************
TortoiseHg Commit Tool
-======================
+**********************
.. module:: commit.dialog
:synopsis: Dialog used to perform commit
@@ -24,7 +24,7 @@ Commit dialog
Features
---------
+========
Walking across the toolbar, the buttons perform the following tasks:
@@ -81,7 +81,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 +92,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 +102,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 +119,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 +145,7 @@
Keyboard navigation
--------------------
+===================
:kbd:`Ctrl-Enter`
will trigger the commit
@@ -163,7 +163,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 +177,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 +203,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 +212,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 +243,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 +272,7 @@
Configurables
--------------
+=============
:menuselection:`Commit --> Username`
Sets username associated with your commits
@@ -290,7 +290,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 +323,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 +349,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,6 +1,6 @@ - ===============
+***************
Common Features
-===============
+***************
.. module:: common.dialog
:synopsis: Common features to all the dialog
|
@@ -1,6 +1,6 @@ - ===================
+*******************
TortoiseHg Datamine
-===================
+*******************
.. module:: datamine.dialog
:synopsis: Dialog used to search in the history
@@ -11,7 +11,7 @@
Search Tabs
------------
+===========
.. figure:: figures/search.png
:alt: Search dialog
@@ -55,7 +55,7 @@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
@@ -69,7 +69,7 @@ open a changelog window with this file's revision history
Annotate Tabs
--------------
+=============
.. figure:: figures/annotate.png
:alt: Annotate tabs
@@ -94,7 +94,7 @@: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
@@ -106,7 +106,7 @@annotated at the same changeset.
Configurables
-~~~~~~~~~~~~~
+-------------
The annotate tabs support the following configurations defined primarily
for other tools:
@@ -117,7 +117,7 @@ Number of spaces to expand tabs in diffs and annotate output
From command line
------------------
+=================
The datamine tool can be started from command line ::
|
@@ -1,12 +1,13 @@ - ============================
+****************************
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
other Tortoise client, such as TortoiseCVS and TortoiseSVN.
@@ -34,7 +35,8 @@ @@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
displaying/refreshing the windows explorer. In most cases, the delay is
@@ -53,7 +55,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,6 +1,6 @@ - ==============
+**************
TortoiseHg FAQ
-==============
+**************
*What is TortoiseHg?*
|
@@ -1,6 +1,6 @@ - =======================
+***********************
TortoiseHg Introduction
-=======================
+***********************
.. module:: introduction
:synopsis: Introduce TortoiseHg and its various parts
@@ -54,7 +54,7 @@
Language settings
-~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^
The TortoiseHg user interface has been translated into many languages.
You don't need to download a language pack. All the available languages
@@ -92,7 +92,7 @@`MacOSX <http://bitbucket.org/tortoisehg/stable/wiki/MacOSX>`_.
Language settings
-~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^
The TortoiseHg tools use Python's
`gettext <http://docs.python.org/library/gettext.html>`_ library to
|
@@ -1,6 +1,6 @@ - =======
+*******
Preface
-=======
+*******
.. module:: preface
:synopsis: About this manual
|
@@ -1,6 +1,6 @@ - ==============================
+******************************
A quick tour for the impatient
-==============================
+******************************
.. module:: tour
:synopsis: A Gentle Introduction to Using TortoiseHg on Windows
|
@@ -1,6 +1,6 @@ - ===================
+*******************
TortoiseHg Recovery
-===================
+*******************
.. module:: recovery.dialog
:synopsis: Dialog used to perform recovery operations
|
@@ -1,6 +1,6 @@ - ================
+****************
TortoiseHg Serve
-================
+****************
.. module:: serve.dialog
:synopsis: Dialog used to start/stop the web server
@@ -47,7 +47,7 @@shell context menu.
From command line
------------------
+=================
The server tool can be started from command line ::
@@ -65,7 +65,8 @@
Changes since 0.7
------------------
+=================
+
* Improved error handling
* i18n fixes
|
@@ -1,6 +1,6 @@ - ===================
+*******************
TortoiseHg Settings
-===================
+*******************
.. module:: settings.dialog
:synopsis: Dialog used to set preferences
|
@@ -1,6 +1,6 @@ - ======================
+**********************
TortoiseHg Shelve Tool
-======================
+**********************
.. module:: shelve.dialog
:synopsis: Dialog used to perform shelve/unshelve operations
@@ -51,7 +51,7 @@clean, ignored}.
Shelving Changes
-----------------
+================
Just like the commit tool, this dialog uses TortoiseHg's integrated hunk
@@ -66,7 +66,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 +84,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 +92,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 +101,7 @@releases.
Keyboard navigation
--------------------
+===================
:guilabel:`Ctrl-C`
in the diff panel will copy the currently highlighted (not selected,
@@ -116,13 +116,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 ::
|
|
|
- ======================
+**********************
TortoiseHg Synchronize
-======================
+**********************
.. module:: synchronize.dialog
:synopsis: Dialog used to perform synchronization operations
.. figure:: figures/synchronize.png
:alt: Synchronize dialog
Synchronize dialog
The synchronize tool is used to transmit changesets between repositories
or optionally to email recipients.
:guilabel:`Incoming`
show changesets that would be pulled from target repository
:guilabel:`Pull`
pull incoming changesets from target repository
:guilabel:`Outgoing`
show changesets that would be pushed to target repository
:guilabel:`Push`
push outgoing changesets to target repository
:guilabel:`Email`
send outgoing changesets (to target repository) as email
:guilabel:`Stop`
stop current operation
:guilabel:`Configure`
configure repository paths (aliases)
Below the toolbar are two buttons and a text entry:
:guilabel:`Repo:`
browse for a local repository to synchronize with
:guilabel:`Bundle:`
browse for a local bundle file to pull from
The text entry/combo box is where you enter or select paths of target
repositories. The synchronize tool will seed the drop-down list with
path aliases configured for this repository.
The :guilabel:`Post Pull Operation` frame contains radio buttons for
selecting the operation which is performed after a pull. This behavior
is configurable via the :guilabel:`Configure` button. You can select a
default behavior for your user account and override that selection on a
per-repository basis.
:guilabel:`Nothing`
No operations are performed after a pull. You will be allowed to
view the pulled changesets in the log viewer, and you will have the
option to update to the new tip if applicable.
:guilabel:`Update`
Automatically update to the new branch tip if, and only if, new
revisions were pulled into the local repository. This could trigger
a merge if the pulled changes conflict with local uncommitted
changes.
:guilabel:`Fetch`
Equivalent to hg fetch. See the fetch extension documentation for
it's behavior.
:guilabel:`Rebase`
Equivalent to pull --rebase. See the rebase extension documentation
for it's behavior. Rebase operations disable connections to any
changelog tools, since it is very destructive to any app which is
holding a repository object.
The :guilabel:`use proxy` button is a quick way to disable your proxy
configuration for individual operations. The button is only sensitive
when an http proxy is configured.
All operations which require authentication will pop up dialog boxes to
get the required information from the user. TortoiseHg uses the
TortoisePlink tool (borrowed from the TortoiseSVN distribution) to
handle *ssh:* connections and authentication. See the FAQ_ for help if
you have trouble connecting to ssh servers.
.. _FAQ: http://bitbucket.org/tortoisehg/stable/wiki/FAQ#tortoisehg-faq
Under the :guilabel:`Advanced Options` fold-up panel are a number of
configurables that are valid for most push/pull operations.
:guilabel:`Force pull or push`
override warnings about multiple heads or unrelated repositories
:guilabel:`Target Revision`
to avoid sending all revisions
:guilabel:`Remote Command`
provides -e argument
:guilabel:`Show patches`
show diffs in incoming and outging changes
:guilabel:`Show Newest First`
reverse order that changesets are listed
:guilabel:`Show No Merges`
filter out merge changesets from output (does not affect push/pull)
After Pull
-----------
+==========
After changesets are pulled into your repository, two buttons may appear
at the bottom of the dialog:
:guilabel:`View pulled changesets`
Open the changelog viewer and inspect pulled changesets
:guilabel:`Update to tip`
Update your working directory to the new tip
Either button may be hidden if it is not applicable.
Email
------
+=====
.. figure:: figures//email.png
:alt: Email dialog
Email dialog
The email dialog can be launched from two TortoiseHg tools.
1) The changelog tool, in which case the user intends to email a single
revision or a range of revisions.
2) The synchronize tool, in which case the user intends to email all
outgoing changes to the current target repository (it's good practice to
check the outgoing changes before launching the email dialog).
The :guilabel:`Send` button is obvious, and the :guilabel:`Configure`
dialog predictably opens the TortoiseHg Settings dialog to the email tab
where you can configure your SMTP settings and set default
:guilabel:`To:` and :guilabel:`From:` addresses.
:guilabel:`In-Reply-To:` can be used to get your patches properly
threaded in mailing lists.
Please consult the Mercurial documentation for the differences between
plain patches, HG patches, Git patches, and bundles.
From command line
------------------
+=================
The synchronize tool can be started from command line ::
hgtk synch
or ::
hgtk pull
or ::
hgtk push
or ::
hgtk incoming
or ::
hgtk outcoming
or ::
hgtk email
The syntax is simple, no options or parameters are needed, except the
global options. If the synchronize tool is started via push, outgoing,
or email command aliases, it will automatically select the
*default-push* URL if. For all other aliases the tool selects the
*default* URL. If the selected URL is not found, it will use the first
path it finds.
Changes since 0.7
------------------
+=================
* Path drop-down list no longer includes most-recently-used paths. It
only includes configured repository paths.
* Email dialog now has buttons for configuring in-reply-to tags and the
attachment types.
* Email dialog now sends an intro message only when one has been
entered, regardless of patch count.
.. vim: noet ts=4
|
Loading...