~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/optional-edit.txt

  • Committer: Vincent Ladeuil
  • Date: 2013-08-09 15:09:23 UTC
  • mto: This revision was merged to the branch mainline in revision 6587.
  • Revision ID: v.ladeuil+lp@free.fr-20130809150923-y71dusyorep0hbkt
Fix various typos in docstrings. Rename 'buffer' to 'buf' since it's now a python builtin function.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
******************************
2
 
Optional explicit edit command
3
 
******************************
4
 
 
5
 
The default is for each branch to have an editable working copy, which
6
 
can be modified and committed.  However, in some cases (following RCS
7
 
and BK) people might prefer to have either a read-only working copy,
8
 
or none at all.
9
 
 
10
 
Reasons:
11
 
 
12
 
 - Branches which are never edited don't need it; removing it saves
13
 
   some time and space.  In particular this applies to branches on a
14
 
   server which are meant to be branched from or committed too, not
15
 
   edited.
16
 
 
17
 
 - Files for which there is no working copy or a read-only copy are
18
 
   known not to be edited, and this can make some operations such as
19
 
   diffing a bit simpler.
20
 
 
21
 
Since this is mostly an optimization and requires user knowledge it
22
 
perhaps should not be added.  Certainly not yet.
23
 
 
24
 
Sketch::
25
 
 
26
 
  $ bzr get --no-wc SOURCE TARGET
27
 
  $ bzr edit --remove
28
 
  $ bzr edit --read-only .
29
 
  $ bzr edit --write foo.c
30