~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: Martin Pool
  • Date: 2005-05-09 03:01:21 UTC
  • Revision ID: mbp@sourcefrog.net-20050509030121-c025382fb31c72ed
- very short tutorial on help page

Show diffs side-by-side

added added

removed removed

Lines of Context:
29
29
 
30
30
* No merge operators yet.
31
31
 
32
 
Interesting commands:
33
 
 
34
 
  bzr help [COMMAND]
35
 
      Show help screen
36
 
  bzr version
37
 
      Show software version/licence/non-warranty.
38
 
  bzr init
39
 
      Start versioning the current directory
40
 
  bzr add FILE...
41
 
      Make files versioned.
42
 
  bzr log
43
 
      Show revision history.
44
 
  bzr rename FROM TO
45
 
      Rename one file.
46
 
  bzr move FROM... DESTDIR
47
 
      Move one or more files to a different directory.
48
 
  bzr diff [FILE...]
49
 
      Show changes from last revision to working copy.
50
 
  bzr commit -m 'MESSAGE'
51
 
      Store current state as new revision.
52
 
  bzr export [-r REVNO] DESTINATION
53
 
      Export the branch state at a previous version.
54
 
  bzr status
55
 
      Show summary of pending changes.
56
 
  bzr remove FILE...
57
 
      Make a file not versioned.
58
 
  bzr info
59
 
      Show statistics about this branch.
60
 
  bzr check
61
 
      Verify history is stored safely. 
62
 
  (for more type 'bzr help commands')
 
32
 
 
33
To make a branch, use 'bzr init' in an existing directory, then 'bzr
 
34
add' to make files versioned.  'bzr add .' will recursively add all
 
35
non-ignored files.
 
36
 
 
37
'bzr status' describes files that are unknown, ignored, or modified.
 
38
'bzr diff' shows the text changes to the tree or named files.
 
39
'bzr commit -m <MESSAGE>' commits all changes in that branch.
 
40
 
 
41
'bzr move' and 'bzr rename' allow you to rename files or directories.
 
42
'bzr remove' makes a file unversioned but keeps the working copy;
 
43
to delete that too simply delete the file.
 
44
 
 
45
'bzr log' shows a history of changes, and
 
46
'bzr info' gives summary statistical information.
 
47
'bzr check' validates all files are stored safely.
 
48
 
 
49
Files can be ignored by giving a path or a glob in .bzrignore at the
 
50
top of the tree.  Use 'bzr ignored' to see what files are ignored and
 
51
why, and 'bzr unknowns' to see files that are neither versioned or
 
52
ignored.
 
53
 
 
54
For more help on any command, type 'bzr help COMMAND', or 'bzr help
 
55
commands' for a list.
63
56
"""
64
57
 
65
58
 
 
59
 
66
60
def help(topic=None):
67
61
    if topic == None:
68
62
        print global_help