[Monotone-commits-diffs] net.venge.monotone: e996870f732306efb4c556a11e49c1eeb5336bc7

[code]

revision:            e996870f732306efb4c556a11e49c1eeb5336bc7
date:                2011-01-09T19:00:04
author:              address@hidden
branch:              net.venge.monotone
changelog:
* monotone.texi (Command Reference): mention command abbreviations, aliases. 
mention short options. Start reviewing individual commands; done to 'mtn 
setup'. For commands with options not currently in the manual, either add them 
(if not too many), or refer to the online help. Add references to appropriate 
manual sections.

manifest:
format_version "1"

new_manifest [ff8f08dea41658e3f22053cda5bee6dc04cf3bfe]

old_revision [da5a05ae6faaf68a54f58998829d8fd81ef81e1d]

patch "monotone.texi"
 from [d6ca2921cbcacbc1e7ae596cc0d8b402a5781dc8]
   to [a101ed9fc176388b4b2c73cd34edeff7a5b1bea8]
============================================================
--- monotone.texi	d6ca2921cbcacbc1e7ae596cc0d8b402a5781dc8
+++ monotone.texi	a101ed9fc176388b4b2c73cd34edeff7a5b1bea8
@@ -4874,10 +4874,16 @@ @chapter Command Reference
 @command{log}, you can override that with @command{mtn log
 --no-brief}.
 
+Command names can be abbreviated to the shortest unique strings. Some
+commands also have short aliases, such as @command{mv} for
address@hidden
+
 The command descriptions describe the most important options for each
 command, and only one of each pair of options. For a complete list of
 options, see the online help (@command{mtn help cmd}), or the manpage.
 
+Many options can be specified by a single character; see the online
+help for those.
 
 @menu
 * Global Options::              Options that affect all commands
@@ -5046,17 +5052,16 @@ @section Tree
 @anchor{mtn address@hidden mtn checkout [--[no-]move-conflicting-paths] address@hidden @var{directory}
 @itemx mtn checkout [--[no-]move-conflicting-paths] address@hidden @var{directory}
 @itemx mtn co
address@hidden is an alias for @command{checkout}
+
 These commands copy a revision @var{id} out of your database,
 recording the chosen revision (the @dfn{base revision}) in the file
 @address@hidden/_MTN/revision}. These commands then copy every
 file version listed in the revision's manifest to paths under
 @var{directory}.
 
address@hidden is an alias for @command{checkout}
+For example, if the revision's manifest contains these entries:
 
-For example, if the revision's manifest contains
-these entries:
-
 @smallexample
 @group
 dir ""
@@ -5096,6 +5101,8 @@ @section Tree
 See @ref{Conflicts}
 
 @item mtn explicit_merge @var{id} @var{id} @var{destbranch}
+See the online help for options.
+
 This command merges exactly the two @var{id}s you give it, and places
 the result in branch @var{destbranch}.  It is useful when you need more
 control over the merging process than @command{propagate} or @command{merge}
@@ -5104,8 +5111,9 @@ @section Tree
 have a branch with two heads, and you want to propagate one of them to
 another branch, again, you can use this command.
 
address@hidden mtn heads address@hidden
-This command lists the ``heads'' of @var{branchname}.
address@hidden mtn heads address@hidden
+This command lists the ``heads'' of @var{branchname} (defaults to the
+current workspace).
 
 The ``heads'' of a branch is the set of revisions which are members of
 the branch, but which have no descendants. These revisions are
@@ -5115,7 +5123,9 @@ @section Tree
 computer clocks is not reliable, so monotone usually ignores time.
 
 @item mtn import address@hidden address@hidden [--[no-]dry-run] @var{dir}
address@hidden mtn import address@hidden address@hidden [--[no-]dry-run] @var{dir}
address@hidden mtn import address@hidden address@hidden [--[no-]dry-run] @var{dir}
+See the online help for more options.
+
 This command imports the contents of the given directory and commits it
 to the head of the given branch or as a child of the given revision (and
 consequently into the branch that revision resides in).
@@ -5141,21 +5151,28 @@ @section Tree
 to be the given revision or the head of the given branch instead of the
 null revision.
 
address@hidden mtn merge address@hidden
-This command merges the ``heads'' of @var{branchname}, if there are
-multiple heads, and commits the results to the database, marking the
-resulting merged revision as a member of @var{branchname}. The merged
-revision will contain each of the head revision IDs as ancestors.
address@hidden mtn merge address@hidden [--message @var{string}] [--message-file @var{filename}]
+See the online help for more options.
 
-A commit message may be provided. A message stating the revision ids
-that were merged will be prepended to any user commit message.
+This command merges the ``heads'' of @var{branchname} (default the
+branch of the current workspace), if there are multiple heads, and
+commits the results to the database, marking the resulting merged
+revision as a member of @var{branchname}. The merged revision will
+contain each of the head revision IDs as ancestors.
 
+A commit message may be provided via @command{--message @var{string}}
+or @command{--message-file @var{filename}}. A message stating the
+revision ids that were merged will be prepended to any user commit
+message.
+
 Merging is performed by repeated pairwise merges: two heads are
 selected, then their least common ancestor is located in the ancestry
 graph and these 3 revisions are provided to the built-in 3-way merge
 algorithm. The process then repeats for each additional head, using
 the result of each previous merge as an input to the next.
 
address@hidden Conflicts} can occur.
+
 @item mtn merge_into_dir @var{sourcebranch} @var{destbranch} @var{dir}
 This command takes a unique head from @var{sourcebranch} and merges it
 into a unique head of @var{destbranch}, as a directory. The resulting
@@ -5175,7 +5192,9 @@ @section Tree
 originally in @var{sourcebranch}, which is almost certainly not what would be
 intended.
 
address@hidden mtn merge_into_workspace @var{revision}
address@hidden Conflicts} can occur.
+
address@hidden mtn merge_into_workspace [--[no]-move-conflicting-paths] @var{revision}
 Merges @var{revision} into the current workspace; the result is not
 committed to the database. There can be no pending changes in the
 current workspace. The workspace's selected branch is not
@@ -5184,16 +5203,18 @@ @section Tree
 When a later commit is done, both @var{revision} and the workspace's
 base revision will be recorded as parents.
 
-Merge conflicts can occur.
address@hidden Conflicts} and @ref{Workspace Collisions} can occur.
 
address@hidden mtn migrate_workspace @var{[directory]}
address@hidden mtn migrate_workspace address@hidden
 Migrates a workspace directory's metadata to the latest format.
 
 If no directory is given, defaults to the current workspace.
 
 This may be needed when upgrading to a new version of monotone.
 
address@hidden mtn propagate @var{sourcebranch} @var{destbranch}
address@hidden mtn propagate @var{sourcebranch} @var{destbranch} [--message @var{string}] [--message-file @var{filename}]
+See online help for more options.
+
 This command takes a unique head from @var{sourcebranch} and merges it
 with a unique head of @var{destbranch}, using the least common
 ancestor of the two heads for a 3-way merge. The resulting revision is
@@ -5201,8 +5222,10 @@ @section Tree
 either @var{sourcebranch} or @var{destbranch} has multiple heads,
 @command{propagate} aborts, doing nothing.
 
-A commit message may be provided. A message stating the source and
-target branches will be prepended to any user commit message.
+A commit message may be provided via @command{--message @var{string}}
+or @command{--message-file @var{filename}}. A message stating the
+source and target branches will be prepended to any user commit
+message.
 
 The purpose of @command{propagate} is to copy all the changes on
 @var{sourcebranch}, since the last @command{propagate}, to
@@ -5212,6 +5235,8 @@ @section Tree
 branches, public contribution branches, or branches devoted to the
 development of a single module within a larger project.
 
address@hidden Conflicts} can occur.
+
 @item mtn refresh_inodeprints
 This command puts the current workspace into @ref{Inodeprints} mode,
 if it was not already, and forces a full inodeprints cache refresh.
@@ -5219,19 +5244,19 @@ @section Tree
 in inodeprints mode, and that the inodeprints cache is accurate and up
 to date.
 
address@hidden mtn setup -b @var{branchname} [-d @var{database}] address@hidden
-This command prepares @var{directory} as a monotone workspace, by
-creating and populating the @file{_MTN} directory with basic
-information.  This information must include at least the branch to be
-used.  If no database is given, the configured default database is
-created or re-used (see @ref{get_default_database_alias} for more
-details).  Both settings, branch and database name, will be placed in
-the @file{_MTN/options} file.
address@hidden mtn setup --branch @var{branchname} [--db @var{database}] address@hidden
+This command prepares @var{directory} (default current directory) as a
+monotone workspace, by creating and populating the @file{_MTN}
+directory with basic information.
 
+If no database is given, the configured default database is created or
+re-used (see @ref{get_default_database_alias} for more details).  Both
+settings, branch and database name, will be placed in the
address@hidden/options} file.
+
 This can be used with an empty directory to start a new blank project,
 or within an existing directory full of files, prior to using
address@hidden commit}. If no directory is specified, the current
-directory is used.
address@hidden commit}.
 
 @end ftable
 
@@ -5309,7 +5334,7 @@ @subheading Single file conflict resolut
 For single file conflicts, there are several possible resolutions:
 
 @ftable @command
address@hidden interactive @var{[file]}
address@hidden interactive address@hidden
 The Lua @code{merge3} hook is called to allow the user to manually
 merge the left and right files, leaving the result in the specified file.
 
@@ -5412,10 +5437,10 @@ @section Workspace
 @var{attr}.
 
     @table @command
-    @item mtn attr drop @var{path} @var{[attr]}
+    @item mtn attr drop @var{path} address@hidden
     Remove attributes.
 
-    @item mtn attr get @var{path} @var{[attr]}
+    @item mtn attr get @var{path} address@hidden
     Output the attributes.
 
     @item mtn attr set @var{path} @var{attr} @var{value}
@@ -5430,18 +5455,16 @@ @section Workspace
 @itemx mtn commit address@hidden address@hidden @var{pathname...}
 @itemx mtn commit address@hidden @var{pathname...}
 @itemx mtn ci
address@hidden is an alias for @command{commit}.
 
 This command looks at your workspace, decides which files have
-changed, and saves the changes to your database.
+changed, and saves the changes to your database. It works by loading
+the revision named in @ref{_MTN/revision}, locating the base manifest
+for your workspace, applying any pathname changes described in
address@hidden/revision}, and then comparing the updated base manifest to
+the files it finds in your workspace, to determine which files have
+been edited.
 
address@hidden is an alias for @command{commit}.
-
address@hidden works by loading the revision named in
address@hidden/revision}, locating the base manifest for your workspace,
-applying any pathname changes described in @file{_MTN/revision}, and
-then comparing the updated base manifest to the files it finds in your
-workspace, to determine which files have been edited.
-
 For each edited file, a delta is copied into the database. Then the
 newly constructed manifest is recorded (as a delta) and finally the
 new revision.  Once all these objects are recorded in you database,
@@ -5607,17 +5630,19 @@ @section Workspace
 
 @item mtn drop [--bookkeep-only] @var{pathname...}
 @itemx mtn drop --missing
address@hidden mtn rm
address@hidden is an alias for @command{drop}.
+
 This command places ``drop'' entries for the paths specified in
 @var{pathname...} in @ref{_MTN/revision} and deletes the file from
 the workspace. This will be part of the next @command{commit}.
 
address@hidden is an alias for @command{drop}.
-
 This command also removes any attributes on @var{pathname}; see
address@hidden Attributes} for more details.  If you use the
address@hidden flag it will add drop entries for any paths that
-monotone is tracking for which you have already removed the files from
-the filesystem, in addition to all those specified in
address@hidden Attributes} for more details.
+
+If you use the @option{--missing} flag it will add drop entries for
+any paths that monotone is tracking for which you have already removed
+the files from the filesystem, in addition to all those specified in
 @var{pathname...}.
 
 There are situations in which @command{drop} will tell monotone
@@ -5711,14 +5736,14 @@ @section Workspace
 @item mtn rename [--bookkeep-only] @var{src} @var{dst}
 @itemx mtn rename [--bookkeep-only] @var{src1} @var{...} @var{dst/}
 @itemx mtn mv
address@hidden is an alias for @command{rename}.
+
 This command places ``rename'' entries for the paths specified in
 @var{src} and @var{dst} in @ref{_MTN/revision}, and optionally renames
 the paths on the disk. The second form renames a number of source
 paths to the given destination. This will be part of the next
 @command{commit}.
 
address@hidden is an alias for @command{rename}.
-
 This command also moves any attributes on @var{src} to @var{dst}; see
 @ref{File Attributes} for more details, and, unless the
 @option{--bookkeep-only} option is supplied, it will rename the files
@@ -6094,13 +6119,13 @@ @section Informative
 @itemx mtn diff address@hidden address@hidden
 @itemx mtn diff address@hidden address@hidden @var{pathname...}
 @itemx mtn di
address@hidden is an alias for @command{diff}.
+
 These commands print out GNU ``unified diff format'' textual difference
 listings between various manifest versions. With no @option{--revision}
 options, @command{diff} will print the difference from the
 base revision to the current revision in the workspace.
 
address@hidden is an alias for @command{diff}.
-
 With one @option{--revision} option, @command{diff} will print the
 difference from the revision @var{id} to the current revision in the
 workspace. If @option{--reverse} is given, the order of the diff is
@@ -6110,7 +6135,6 @@ @section Informative
 difference from revision @var{id1} to @var{id2}, ignoring any
 workspace.
 
-
 In all cases, monotone will print a textual summary -- identical to
 the summary presented by @command{mtn status} -- of the logical
 differences between revisions in lines proceeding the diff. These