[Monotone-commits-diffs] net.venge.monotone.list_workspaces: a2a3357b0ff17f5fbc0fcda117fb0310125b60da

[code]

revision:            a2a3357b0ff17f5fbc0fcda117fb0310125b60da
date:                2011-01-13T23:51:07
author:              address@hidden
branch:              net.venge.monotone.list_workspaces
changelog:
* monotone.texi: mention register_workspace and unregister_workspace
in the managed databases section; ensure that all references to
monotone commands get wrapped into @command{} which leads to proper
(fixed) formatting

manifest:
format_version "1"

new_manifest [b36b0c3dc1bacabe2229ff37681953f608c9f98f]

old_revision [309d7f514b5483b21e470d833677258ac0ed4a7e]

patch "monotone.texi"
 from [3dbe176414dc624d451d9fe6712699be0ec219fc]
   to [1d687d3afd5caea6bfb39a740fe1041b58e71f34]
============================================================
--- monotone.texi	3dbe176414dc624d451d9fe6712699be0ec219fc
+++ monotone.texi	1d687d3afd5caea6bfb39a740fe1041b58e71f34
@@ -1223,7 +1223,7 @@ @section Creating a Database
 the leading colon in its name.  This special alias can now be used
 interchangeably in every monotone invocation.  If Beth wants to see
 where monotone actually created the database and what other databases
-monotone knows of, she uses the @ref{mtn list databases} command
+monotone knows of, she uses the @address@hidden list databases}} command
 (or @command{mtn ls dbs}) for that.  We'll come back to this in a bit.
 
 @page
@@ -3795,17 +3795,25 @@ @section Managed Databases
 Monotone searches for this file name in common locations and internally
 expands it to a full path once it found an unambigious match.
 
-Some commands, most noticable @ref{mtn clone} and @ref{mtn setup}, work
-out of the box without that any @option{--db} option is needed; they
-fall back on a managed ``default'' database and even initialize that
-in case it is not existant.
+Some commands, most noticable @address@hidden clone}} and
address@hidden@ref{mtn setup}}, work out of the box without that any
address@hidden option is needed; they fall back on a managed ``default''
+database and even initialize that in case it is not existant.
 
 To keep an overview of managed databases and their workspaces, the commands
address@hidden list databases} and @ref{mtn list workspaces} can be used:  The
-former shows a list of all known databases in all managed locations together
-with their workspaces, while the latter only shows the list of workspaces for
-a single, specified database.
address@hidden@ref{mtn list databases}} and @address@hidden list workspaces}}
+can be used:  The former shows a list of all known databases in all managed
+locations together with their workspaces, while the latter only shows the
+list of workspaces for a single, specified database.
 
+Monotone usually keeps track of known workspaces automatically in the
+background and updates the references as soon as your workspace' database
+option in @file{_MTN/options} is set up or changed. There are a few cases
+where monotone is unable to detect changes, though, for example when a
+workspace is moved in the file system. To get monotone back on track in
+cases like this, the commands @address@hidden register_workspace}} and
address@hidden@ref{mtn unregister_workspace}} can be used.
+
 Finally, all this magic behaviour can be customized by a variety of
 lua hooks:
 
@@ -4083,7 +4091,7 @@ @section File Attributes
 Windows users can view and modify the attr like anyone else.)
 
 Attrs in the current workspace can be seen and modified using the
address@hidden attr} command.  Attrs can also be found by examining any
address@hidden@ref{mtn attr}} command.  Attrs can also be found by examining any
 manifest directly.
 
 You can tell monotone to automatically take actions based on these
@@ -5374,7 +5382,7 @@ @subheading Commands
 merge are used.
 
 The conflicts file format is as output by the @command{automate
-show_conflicts} command; see @ref{mtn automate show_conflicts}.
+show_conflicts} command; see @address@hidden automate show_conflicts}}.
 
 Content conflicts that can be resolved by the internal line merger
 have resolutions, so they will not show up in subsequent
@@ -6235,7 +6243,7 @@ @section Informative
 
 Normally, branches that have been suspended are not listed; the global
 option @option{--ignore-suspend-certs} causes suspended branches to
-be listed; see @ref{mtn suspend}.
+be listed; see @address@hidden suspend}}.
 
 @item mtn list certs @var{id}
 @itemx mtn ls certs
@@ -6319,9 +6327,9 @@ @section Informative
 @itemx mtn ls dbs
 
 Show all @ref{Managed Databases} and the workspaces registered in
-them. The commands @ref{mtn register_workspace} and @ref{mtn unregister_workspace}
-can be used to explicitely register and unregister workspaces shown
-within this list.
+them. The commands @address@hidden register_workspace}} and
address@hidden@ref{mtn unregister_workspace}} can be used to explicitely
+register and unregister workspaces shown within this list.
 
 @item mtn list duplicates address@hidden
 @itemx mtn ls duplicates
@@ -6432,7 +6440,7 @@ @section Informative
 This command shows all registered workspaces for a database, be it
 managed or unmanaged.  If no database is given explicitely, defaults to
 the workspace' database in which the command is executed.  The commands
address@hidden register_workspace} and @ref{mtn unregister_workspace}
address@hidden@ref{mtn register_workspace}} and @address@hidden unregister_workspace}}
 can be used to explicitely register and unregister workspaces shown
 within this list.  See @ref{Managed Databases} for more information.
 
@@ -6661,8 +6669,8 @@ @section Variables
 @anchor{mtn address@hidden mtn register_workspace address@hidden
 
 Registers the given workspace (default the current workspace) in the
-current database, so that it will show up in the output of @ref{mtn
-list databases} (the database has to be in a managed location for
+current database, so that it will show up in the output of @address@hidden
+list databases}} (the database has to be in a managed location for
 @command{list databases} to work; see @ref{Managed Databases}).
 
 @item mtn set @var{domain} @var{name} @var{value}
@@ -6671,7 +6679,7 @@ @section Variables
 
 @anchor{mtn address@hidden mtn unregister_workspace address@hidden
 Unregisters the given workspace from the current database, so that it
-will no longer show up in the output of @ref{mtn list databases}.
+will no longer show up in the output of @address@hidden list databases}}.
 
 If no @var{workspace_path} is given, this command defaults to the
 current workspace.
@@ -7385,7 +7393,7 @@ @section Automation
 @item Purpose:
 
 Create a new workspace containing the given revision; see
address@hidden checkout}.
address@hidden@ref{mtn checkout}}.
 
 @item Sample output:
 
@@ -7397,7 +7405,7 @@ @section Automation
 
 @item Error conditions:
 
-see @ref{mtn checkout}.
+see @address@hidden checkout}}.
 
 @end table
 
@@ -9543,7 +9551,7 @@ @section Automation
 [--[no-]merges] address@hidden
 
 Same as @command{mtn log}, but without the output control options; see
address@hidden log}.
address@hidden@ref{mtn log}}.
 
 @item Added in:
 
@@ -9569,7 +9577,7 @@ @section Automation
 
 @item Error conditions:
 
-See @ref{mtn log}.
+See @address@hidden log}}.
 
 @end table
 
@@ -11136,7 +11144,7 @@ @section Automation
 @item Purpose:
 
 Update the current workspace to the latest or given revision; see
address@hidden update}.
address@hidden@ref{mtn update}}.
 
 @item Sample output:
 
@@ -11158,7 +11166,7 @@ @section Automation
 
 @item Error conditions:
 
-see @ref{mtn update}.
+see @address@hidden update}}.
 
 @end table
 
@@ -11794,7 +11802,7 @@ @subsection User Defaults
 @address@hidden get_default_database_locations ()
 
 Returns a table of paths where monotone should look for managable
-databases.  The command @ref{mtn list databases} searches all these
+databases.  The command @address@hidden list databases}} searches all these
 paths for valid monotone databases and outputs details on each one.
 
 The default implementation returns a table with a single entry,
@@ -12585,7 +12593,7 @@ @subsection Meta Hooks
 @subsection Meta Hooks
 
 Monotone allows the execution of arbitrary Lua hooks and functions through a
-special generalized "meta hook". See @ref{mtn automate lua} for more
+special generalized "meta hook". See @address@hidden automate lua}} for more
 information.
 
 @ftable @code