~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help_topics.py

  • Committer: John Arbash Meinel
  • Date: 2007-07-13 02:23:34 UTC
  • mfrom: (2592 +trunk) (2612 +trunk)
  • mto: This revision was merged to the branch mainline in revision 2614.
  • Revision ID: john@arbash-meinel.com-20070713022334-qb6ewgo6v4251yd9
[merge] bzr.dev 2612

Show diffs side-by-side

added added

removed removed

Lines of Context:
284
284
_repositories = \
285
285
"""Repositories
286
286
 
287
 
Repositories in Bazaar are where committed information is stored. It is
288
 
possible to create a shared repository which allows multiple branches to
289
 
share their information in the same location. When a new branch is
290
 
created it will first look to see if there is a containing repository it
291
 
can share.
 
287
Repositories in Bazaar are where committed information is stored. There is
 
288
a repository associated with every branch.
 
289
 
 
290
Repositories are a form of database. Bzr will usually maintain this for
 
291
good performance automatically, but in some situations (e.g. when doing
 
292
very many commits in a short time period) you may want to ask bzr to 
 
293
optimise the database indices. This can be done by the 'bzr pack' command.
 
294
 
 
295
By default just running 'bzr init' will create a repository within the new
 
296
branch but it is possible to create a shared repository which allows multiple
 
297
branches to share their information in the same location. When a new branch is
 
298
created it will first look to see if there is a containing shared repository it
 
299
can use.
292
300
 
293
301
When two branches of the same project share a repository, there is
294
302
generally a large space saving. For some operations (e.g. branching
357
365
               this will update the tree to match the branch.
358
366
"""
359
367
 
 
368
_status_flags = \
 
369
"""Status Flags
 
370
 
 
371
Status flags are used to summarise changes to the working tree in a concise
 
372
manner.  They are in the form:
 
373
   xxx   <filename>
 
374
where the columns' meanings are as follows.
 
375
 
 
376
Column 1: versioning / renames
 
377
  + File versioned
 
378
  - File unversioned
 
379
  R File renamed
 
380
  ? File unknown
 
381
  C File has conflicts
 
382
  P Entry for a pending merge (not a file)
 
383
 
 
384
Column 2: Contents
 
385
  N File created
 
386
  D File deleted
 
387
  K File kind changed
 
388
  M File modified
 
389
 
 
390
Column 3: Execute
 
391
  * The execute bit was changed
 
392
"""
 
393
 
360
394
 
361
395
topic_registry.register("revisionspec", _help_on_revisionspec,
362
396
                        "Explain how to use --revision")
372
406
                        'Information on what a checkout is')
373
407
topic_registry.register('urlspec', _help_on_transport,
374
408
                        "Supported transport protocols")
 
409
topic_registry.register('status-flags', _status_flags,
 
410
                        "Help on status flags")
375
411
def get_bugs_topic(topic):
376
412
    from bzrlib import bugtracker
377
413
    return bugtracker.tracker_registry.help_topic(topic)