Merge lp:~bialix/bzr/ignores-docstring into lp:bzr

[Alexander Belchenko]

Improve the docstring for tree_ignores_add_patterns and remove a magic constant.

This branch put the docstring of tree_ignores_add_patterns to reflect the real code. Currently it does not. At all.

Also I've changed the '.bzrignore' literal to named constant from bzrlib/__init__.py to keep consistency.

[John A Meinel (jameinel)]

review: Approve

=== modified file 'bzrlib/ignores.py'
--- bzrlib/ignores.py	2010-04-26 13:51:08 +0000
+++ bzrlib/ignores.py	2010-04-30 07:59:16 +0000
@@ -176,10 +176,11 @@
 
 
 def tree_ignores_add_patterns(tree, name_pattern_list):
-    """Retrieve a list of ignores from the ignore file in a tree.
+    """Add more ignore patterns to the ignore file in a tree.
+    If ignore file does not exist then it will be created.
+    The ignore file will be automatically added under version control.
 
-    :param tree: Tree to retrieve the ignore list from.
-    :return:
+    :param tree: Working tree to update the ignore list.
     """
     ifn = tree.abspath(bzrlib.IGNORE_FILENAME)
     if tree.has_filename(ifn):
@@ -206,5 +207,5 @@
     finally:
         f.close()
 
-    if not tree.path2id('.bzrignore'):
-        tree.add(['.bzrignore'])
+    if not tree.path2id(bzrlib.IGNORE_FILENAME):
+        tree.add([bzrlib.IGNORE_FILENAME])