We are currently indexing your data, so search results may be incomplete until we finish.
merge with stable
by
Changes to 15 files · Browse files at 174f73d980d2 Showing diff from parent 84084745ccf4 b59b401ddb61 Diff from another changeset...
-
doc/ReadMe.txt
-
doc/source/changelog.txt
-
doc/source/commit.txt
-
doc/source/common.txt
-
doc/source/datamine.txt
-
doc/source/explorer.txt
-
doc/source/faq.txt
-
doc/source/intro.txt
-
doc/source/preface.txt
-
doc/source/quick.txt
-
doc/source/recovery.txt
-
doc/source/serve.txt
-
doc/source/settings.txt
-
doc/source/shelve.txt
-
doc/source/synchronize.txt
|
@@ -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
|
||
|
|
|
- ===================
+*******************
TortoiseHg Settings
-===================
+*******************
.. module:: settings.dialog
:synopsis: Dialog used to set preferences
.. figure:: figures/settings.png
:alt: Settings dialog
Settings dialog
The Settings dialog is used to configure both TortoiseHg and the
underlying Mercurial DVCS. Since TortoiseHg uses Mercurial's underlying
configuration system to store and retrieve its settings, these are
essentially the same thing.
Mercurial on Windows has a three-tier configuration system.
1) A site-wide configuration file in
:file:`C:\\Program Files\\TortoiseHg\\Mercurial.ini`
This file is read first and thus has the lowest priority.
2) A per-user configuration file in
:file:`C:\\Documents and Settings\\username\\Mercurial.ini`
This file is read second and thus can override settings in the
site-wide configuration file.
3) A per-repository configuration file in :file:`repo-root\\.hg\\hgrc` This
file is read last and can override site-wide and user global settings.
The site-wide file can be overwritten on upgrades so it is recommended
that you do not make changes to this file. Instead, you should make
changes to your user :file:`Mercurial.ini` and/or the repository
:file:`hgrc` file. The TortoiseHg Settings dialog enforces this
suggestion by only operating in two modes:
Global
edits your user :file:`Mercurial.ini` file
Repository
edits a repository :file:`.hg/hgrc` file
In TortoiseHg 0.8, you may toggle between the two modes using the combo
box at the top of the dialog.
Most TortoiseHg users will want to store all configurables in their
global user settings, and only use the repository hgrc to store paths
(remote repository aliases) and web settings, though it is possible to
override many configurables per-repository (a common example is to
configure a different username for use in a repository). Also note that
the user and repository configuration files may not exist until you run
the Settings dialog for the first time.
Tabs
====
The Settings tool is a tabbed application.
Each tab corresponds roughly to a section of your :file:`Mercurial.ini`
file, though there is a certain amount of overlap. Some sections were
split across multiple tabs for clarity.
Every tab but :guilabel:`Sync` has the same format, a list of
configurable options with a drop-down combo box with possible values and
a history of options you have used for that setting. The configurable
name (label) has a tooltip which describes in more detail what you are
configuring and its default value. The description of the currently
focused configurable is also shown in a text box at the bottom of the
dialog.
Please consult the Mercurial wiki for more detailed information about
these configurables (except for the first three tabs:
:guilabel:`TortoiseHg`, :guilabel:`Commit`, :guilabel:`Changelog`, which
are specifically for TortoiseHg).
.. module:: TortoiseHg.settings
:synopsis: Dialog used to set general TortoiseHg preferences
TortoiseHg
----------
:guilabel:`3-way Merge Tool:`
Graphical merge program for resolving merge conflicts. If left
unspecified, Mercurial will use the first applicable tool it finds
on your system or use its internal merge tool that leaves conflict
markers in place. Chose :guilabel:`internal:merge` to force conflict markers,
:guilabel:`internal:prompt` to always select local or other, or :guilabel:`internal:dump`
to leave files in the working directory for manual merging.
:guilabel:`Visual Diff Command:`
Specify visual diff tool; must be an extdiff command.
:guilabel:`Skip Diff Window:`
Bypass the builtin visual diff dialog and directly use your
visual diff tool's directory diff feature. Only enable this
feature if you know your diff tool has a valid extdiff
configuration. Default: False.
:guilabel:`Visual Editor:`
Specify the visual editor used to view files, etc.
:guilabel:`CLI Editor:`
The editor to use during a commit and other
instances where Mercurial needs multiline input from
the user. Only used by command line interface commands.
:guilabel:`Tab Width:`
Specify the number of spaces that tabs expand to in various
TortoiseHg windows. Default: Not expanded.
:guilabel:`Max Diff Size:`
The maximum size file (in KB) that TortoiseHg will
show changes for in the changelog, status, and commit windows.
A value of zero implies no limit. Default: 1024 (1MB).
:guilabel:`Bottom Diffs:`
Show the diff panel below the file list in status, shelve, and
commit dialogs.
Default: False (show diffs to right of file list).
.. module:: commit.settings
:synopsis: Dialog used to set commit specific preferences
Commit
------
:guilabel:`Username:`
Name associated with commits.
:guilabel:`External Commit Tool:`
Select commit tool launched by TortoiseHg. (Qct is no longer
distributed as part of TortoiseHg).
Default: None (use the builtin tool). [DEPRECATED]
:guilabel:`Summary Line Length:`
Maximum length of the commit message summary line.
If set, TortoiseHg will issue a warning if the
summary line is too long or not separated by a
blank line. Default: 0 (unenforced).
:guilabel:`Message Line Length:`
Word wrap length of the commit message. If
set, the popup menu can be used to format
the message and a warning will be issued
if any lines are too long at commit.
Default: 0 (unenforced).
.. module:: changelog.settings
:synopsis: Dialog used to set changelog specific preferences
Changelog
---------
:guilabel:`Author Coloring:`
Color changesets by author name. If not enabled,
the changes are colored green for merge, red for
non-trivial parents, black for normal.
Default: False.
:guilabel:`Long Summary:`
If true, concatenate multiple lines of changeset summary
until they reach 80 characters.
Default: False.
:guilabel:`Log Batch Size:`
The number of revisions to read and display in the
changelog viewer in a single batch.
Default: 500.
:guilabel:`Copy Hash:`
Allow the changelog viewer to copy the changeset hash
of the currently selected changeset into the clipboard.
Default: False.
.. module:: synchronize.settings
:synopsis: Dialog used to set synchronize specific preferences
Sync
----
The :guilabel:`Sync` tab is where you can store URLs (paths) to related
repositories. It is rare to store paths in the site-wide or user
configuration files, most of the time you will only store these in a
repository configuration file. Mercurial has two special path names that
can be used as default targets for some operations.
* *default* - the default URL to pull from, usually clone source
* *default-push* - the default push target when using the command line
:guilabel:`After pull operation:`
Operation which is performed directly after a successful pull.
:guilabel:`update` equates to :command:`pull --update`, :guilabel:`fetch`
equates to the fetch extension, :guilabel:`rebase` equates to
:command:`pull --rebase`. Default: none.
:guilabel:`Remote repository paths`
In this pane you can configure aliases for repositories that you
frequently synchronize with. Mercurial will add a *default* alias
to the clone source automatically. All configured path aliases will
be listed in the Synchronize tool path drop-down box, and they can
be used as short-cuts on the command line.
.. module:: web.settings
:synopsis: Dialog used to set web server specific preferences
Web
---
:guilabel:`Name:`
Repository name to use in the web interface.
Default is the working directory.
:guilabel:`Description:`
Textual description of the repository's purpose or
contents.
:guilabel:`Contact:`
Name or email address of the person in charge of the
repository.
:guilabel:`Style:`
Which template map style to use.
:guilabel:`Archive Formats:`
Comma separated list of archive formats allowed for
downloading.
:guilabel:`Port:`
Port to listen on.
:guilabel:`Push Requires SSL:`
Whether to require that inbound pushes be transported
over SSL to prevent password sniffing.
:guilabel:`Stripes:`
How many lines a "zebra stripe" should span in multiline output.
Default is 1; set to 0 to disable.
:guilabel:`Max Files:`
Maximum number of files to list per changeset.
:guilabel:`Max Changes:`
Maximum number of changes to list on the changelog.
:guilabel:`Allow Push:`
Whether to allow pushing to the repository. If empty or not
set, push is not allowed. If the special value "*", any remote
user can push, including unauthenticated users. Otherwise, the
remote user must have been authenticated, and the authenticated
user name must be present in this list (separated by whitespace
or ","). The contents of the allow_push list are examined after
the deny_push list.
:guilabel:`Deny Push:`
Whether to deny pushing to the repository. If empty or not set,
push is not denied. If the special value "*", all remote users
are denied push. Otherwise, unauthenticated users are all
denied, and any authenticated user name present in this list
(separated by whitespace or ",") is also denied. The contents
of the deny_push list are examined before the allow_push list.
:guilabel:`Encoding:`
Character encoding name.
.. module:: proxy.settings
:synopsis: Dialog used to set proxy specific preferences
Proxy
-----
:guilabel:`Host:`
Host name and (optional) port of proxy server, for
example ``myproxy:8000``.
:guilabel:`Bypass List:`
Optional. Comma-separated list of host names that
should bypass the proxy.
:guilabel:`Password:`
Optional. Password to authenticate with at the
proxy server.
:guilabel:`User:`
Optional. User name to authenticate with at the
proxy server.
.. module:: email.settings
:synopsis: Dialog used to set email specific preferences
Email
-----
:guilabel:`From:`
Email address to use in the "From" header and for the SMTP envelope.
:guilabel:`To:`
Comma-separated list of recipient email addresses.
:guilabel:`Cc:`
Comma-separated list of carbon copy recipient email
addresses.
:guilabel:`Bcc:`
Comma-separated list of blind carbon copy recipient
email addresses.
:guilabel:`method:`
Optional. Method to use to send email messages. If value is "smtp" (default),
use SMTP (configured below). Otherwise, use as name of program to run that
acts like sendmail (takes :command:`-f` option for sender, list of recipients on
command line, message on stdin). Normally, setting this to ``sendmail`` or
``/usr/sbin/sendmail`` is enough to use sendmail to send messages.
:guilabel:`SMTP Host:`
Host name of mail server.
:guilabel:`SMTP Port:`
Port to connect to on mail server.
Default: 25.
:guilabel:`SMTP TLS:`
Connect to mail server using TLS.
Default: False.
:guilabel:`SMTP Username:`
Username to authenticate to mail server with.
:guilabel:`SMTP Password:`
Password to authenticate to mail server with.
:guilabel:`Local Hostname:`
Hostname the sender can use to identify itself to the mail server.
.. module:: diff.settings
:synopsis: Dialog used to set diff specific preferences
Diff
----
:guilabel:`Git Format:`
Use git extended diff header format.
Default: False.
:guilabel:`No Dates:`
Do not include modification dates in diff headers.
Default: False.
:guilabel:`Show Function:`
Show which function each change is in.
Default: False.
:guilabel:`Ignore White Space:`
Ignore white space when comparing lines.
Default: False.
:guilabel:`Ignore WS Amount:`
Ignore changes in the amount of white space.
Default: False.
:guilabel:`Ignore Blank Lines:`
Ignore changes whose lines are all blank.
Default: False.
From command line
=================
The setting dialog can be started from command line ::
hgtk repoconfig
for the repository settings (:file:`.hg/hgrc` file) or ::
hgtk userconfig
for the user configuration (:file:`Mercurial.ini` file).
The syntax is simple, no options or parameters are needed, except the global options.
.. vim: noet ts=4
|
|
@@ -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 ::
|
||
|
@@ -1,6 +1,6 @@ - ======================
+**********************
TortoiseHg Synchronize
-======================
+**********************
.. module:: synchronize.dialog
:synopsis: Dialog used to perform synchronization operations
@@ -93,7 +93,7 @@
After Pull
-----------
+==========
After changesets are pulled into your repository, two buttons may appear
at the bottom of the dialog:
@@ -106,7 +106,7 @@Either button may be hidden if it is not applicable.
Email
------
+=====
.. figure:: figures//email.png
:alt: Email dialog
@@ -134,7 +134,7 @@plain patches, HG patches, Git patches, and bundles.
From command line
------------------
+=================
The synchronize tool can be started from command line ::
@@ -168,7 +168,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...