Definitions for terms used in "bzr help commands"

[Martin Pool]

  affects /products/bzr

----- Forwarded message from "Reg. Charney" <email address hidden> -----

From: "Reg. Charney" <email address hidden>
Subject: Definitions for terms used in "bzr help commands"
Date: Mon, 06 Feb 2006 15:40:53 -0500
To: <email address hidden>
X-Spam-Status: No, score=-100.3 required=3.0 tests=BAYES_00,RCVD_IN_BLARS_RBL,
 RCVD_NUMERIC_HELO,USER_IN_WHITELIST autolearn=no version=3.1.0
User-Agent: Thunderbird 1.4 (X11/20050908)

The "bzr help commands" command uses the following terms, none of which
have a definition or syntax that I can find:

BRANCH
DEST
DIR
FILE
FILENAME
FROM_LOCATION TO_LOCATION
FROM_NAME TO_NAME
LOCATION
NAME_PATTERN
NAMES
NICKNAME
OTHER_BRANCH
SELECTED
SOURCE
TOPIC

Please also note that some of the names seem to overlap, like FILE and
FILENAME.

This is a real problem for me, because I do not know how to write the
"bzr pull LOCATION" command since I don't know the format of a LOCATION
when it is not on the local system.

P.S. Here is the list of the commands that use these terms and their
basic formats:

bzr add [FILE...]
   Add specified files or directories.
bzr annotate FILENAME
   Show the origin of each line in a file.
bzr branch FROM_LOCATION [TO_LOCATION]
   Create a new copy of a branch.
bzr cat FILENAME
   Write a file's text from a previous revision.
bzr check [BRANCH]
   Validate consistency of branch history.
bzr commit [SELECTED...]
   Commit changes into a new revision.
bzr diff [FILE...]
   Show differences in working tree.
bzr export DEST
   Export past revision to destination directory.
bzr help [TOPIC]
   Show help on a command or other topic.
bzr ignore NAME_PATTERN
   Ignore a command or pattern.
bzr info [BRANCH]
   Show statistical information about a branch.
bzr init [LOCATION]
   Make a directory into a versioned branch.
bzr log [FILENAME]
   Show log of this branch.
bzr merge [BRANCH]
   Perform a three-way merge.
bzr missing [OTHER_BRANCH]
   Show unmerged/unpulled revisions between two branches.
bzr mkdir DIR...
   Create a new versioned directory.
bzr move SOURCE... DEST
   Move files to a different directory.
bzr mv [NAMES...]
   Move or rename a file.
bzr nick [NICKNAME]
   Print or set the branch nickname.
bzr pull [LOCATION]
   Pull any changes from another branch into the current one.
bzr push [LOCATION]
   Push this branch into another branch.
bzr remerge [FILE...]
   Redo a merge.
bzr remove FILE...
   Make a file unversioned.
bzr rename FROM_NAME TO_NAME
   Change the name of an entry.
bzr renames [DIR]
   Show list of renamed files.
bzr resolve [FILE...]
   Mark a conflict as resolved.
bzr revert [FILE...]
   Reverse all changes since the last commit.
bzr revno [LOCATION]
   Show current revision number.
bzr root [FILENAME]
   Show the tree root directory.
bzr status [FILE...]
   Display status summary.
bzr testament [BRANCH]
   Show testament (signing-form) of a revision.
bzr uncommit [LOCATION]
   Remove the last committed revision.
bzr upgrade [DIR]
   Upgrade branch storage to current format.

----- End forwarded message -----
--
Martin

[Martin Pool (mbp)]

Real bug.

Not sure what would be the best place to put these though - in the online help under 'bzr help glossary' perhaps?

[Nikos Mouchtaris (isidev)]

I would suggest "bzr help terminology" or "bzr help terms".

Also, there should be descriptions about how the "remembered" locations are used by bzr commands and for which commands, etc.

For example, it should be mentioned either under "bzr help terminology" or even "bzr help info" that "parent branch" means the branch that "bzr pull" uses by default and so on.

Currently I am puzzled by "submit branch". I suspect that it is the branch that "bzr merge" uses, but it very unclear.

[Ian Brandt (ian-ianbrandt)]

Just FYI in my own search for a definition of the "submit branch" term from 'bzr info' I stumbled onto this mailing list post also requesting clarification be added to http://bazaar-vcs.org/BzrGlossary: https://lists.ubuntu.com/archives/bazaar/2008q2/043101.html.