SourceForge: tortoisehg/tortoisehg: changeset 4781:38a197405912
doc: document sync bar stable
authorSteve Borho <steve@borho.org>
Mon Oct 26 22:48:04 2009 -0500 (8 weeks ago)
branchstable
changeset 478138a197405912
parent 4780 a8c820b3a951
child 4782 1a25e7f7ec0a
doc: document sync bar
doc/source/changelog.txt
     1.1 --- a/doc/source/changelog.txt	Mon Oct 26 22:17:22 2009 -0500
     1.2 +++ b/doc/source/changelog.txt	Mon Oct 26 22:48:04 2009 -0500
     1.3 @@ -45,6 +45,76 @@
     1.4  	:guilabel:`Load all`
     1.5  		load all remaining revisions into the graph
     1.6  
     1.7 +Synch Bar
     1.8 +---------
     1.9 +
    1.10 +.. figure:: figures/syncbar.png
    1.11 +	:alt: Changelog
    1.12 +
    1.13 +	Synchronization features in changelog tool
    1.14 +
    1.15 +From left to right...
    1.16 +
    1.17 +	:guilabel:`Incoming`
    1.18 +		Download incoming changesets from the remote repository, store
    1.19 +		them in a temporary bundle file, then enter bundle preview mode
    1.20 +		with the incoming changes applied.  Incoming changesets will
    1.21 +		have a 'down' arrow in the revision graph.
    1.22 +	:guilabel:`Accept`
    1.23 +		Accept (pull) the changesets from the previewed bundle.  This
    1.24 +		button is only sensitive when previewing a changeset bundle.
    1.25 +		The after-pull effect is respected after pulling from a bundle.
    1.26 +	:guilabel:`Reject`
    1.27 +		Reject the changesets from the previewed bundle and exit preview
    1.28 +		mode.  This button is only sensitive when previewing a changeset
    1.29 +		bundle.
    1.30 +	:guilabel:`Pull`
    1.31 +		Pull incoming changesets from the remote repository, then apply
    1.32 +		after-pull effect (update, fetch, or rebase).
    1.33 +	:guilabel:`Outgoing`
    1.34 +		Determine outgoing changesets that would be pushed to the
    1.35 +		remote repository.  Outgoing changesets are marked with an 'up'
    1.36 +		arrow.
    1.37 +	:guilabel:`Push`
    1.38 +		Push outgoing changesets to the remote repository.
    1.39 +	:guilabel:`Email`
    1.40 +		Email outgoing changesets to the remote repository.
    1.41 +	:guilabel:`Stop`
    1.42 +		Stop current transaction.  The button is only sensitive during
    1.43 +		outgoing commands.
    1.44 +
    1.45 +To the right of the :guilabel:`Stop` button is a combo box containing
    1.46 +all of the configured peer repository paths for the current repository.
    1.47 +The default path is selected at startup, if it has been configured.
    1.48 +
    1.49 +To the right of the path combo box is the :guilabel:`After Pull` combo
    1.50 +that selects the operation which is performed after every pull operation
    1.51 +triggered by the search bar.  The user must have the rebase extension
    1.52 +enabled in order for that option to be available in the after pull
    1.53 +combo.  The same is true of the fetch extension and it's post pull
    1.54 +operation.
    1.55 +
    1.56 +To the right of the :guilabel:`After Pull` combo is the
    1.57 +:guilabel:`Settings` button.  It opens the repository settings tool on
    1.58 +the :guilabel:`Sync` tab where the after pull configurable and peer
    1.59 +repository paths can be configured.
    1.60 +
    1.61 +Changesets which are added to the repository after the changelog tool
    1.62 +was opened are marked with green stars in the graph.  This includes
    1.63 +recent commits, pulled changesets, and applied patches.
    1.64 +
    1.65 +.. note::
    1.66 +	To clear the new, incoming, and outgoing marks from the changeset
    1.67 +	graph, use :guilabel:`View -> Reset Marks`
    1.68 +
    1.69 +Search Bar
    1.70 +----------
    1.71 +
    1.72 +.. figure:: figures/searchbar.png
    1.73 +	:alt: Changelog
    1.74 +
    1.75 +	Synchronization features in changelog tool
    1.76 +
    1.77  
    1.78  Revision Graph Details
    1.79  ----------------------