← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/ignores.py

  • Committer: John Arbash Meinel
  • Date: 2006-07-21 04:02:14 UTC
  • mto: This revision was merged to the branch mainline in revision 1877.
  • Revision ID: john@arbash-meinel.com-20060721040214-9db86450785a5c3e
Make set_user_ignores a private function, and update the doc string to recommend it isn't used.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/ignores.py
121
121
        # We want to ignore if we can't write to the file
122
122
        # since get_* should be a safe operation
123
123
        try:
124
 
            set_user_ignores(USER_DEFAULTS)
 
124
            _set_user_ignores(USER_DEFAULTS)
125
125
        except (IOError, OSError), e:
126
126
            if e.errno not in (errno.EPERM,):
127
127
                raise
133
133
        f.close()
134
134
 
135
135
 
136
 
def set_user_ignores(patterns):
 
136
def _set_user_ignores(patterns):
137
137
    """Fill out the user ignore file with the given patterns
138
138
 
139
139
    This may raise an error if it doesn't have permission to
140
140
    write to the user ignore file.
 
141
    This is mostly used for testing, since it would be
 
142
    bad form to rewrite a user's ignore list.
 
143
    bzrlib only writes this file if it does not exist.
141
144
    """
142
145
    ignore_path = config.user_ignore_config_filename()
143
146
    config.ensure_config_dir_exists()