Merge lp:~parthm/bzr/538703-default-ignore-rules into lp:bzr

[Parth Malwankar]

Implement 'ignore --default-rules', remove 'ignore --old-default-rules'

=== Fixed Bug #538703 ===
This merge proposal adds the --default-rules option to 'bzr ignore' which prints out the default ignores used by bzr.

The test case uses the python2.4+ builtin 'set' to test this option. I am assuming bzr is supported only on python2.4+. If this is not the case please let me know and I can conditionally use the sets module.

[538703-default-ignore-rules]% ./bzr --no-plugins ignore --default-rules
*.a
*.o
*.py[co]
*.so
*.sw[nop]
*~
.#*
[#]*#
[538703-default-ignore-rules]%

IMO --old-default-rules can be removed as it is for bzr < 0.9 but that can be a separate patch so that functionality is untouched.

[Robert Collins (lifeless)]

This doesn't entirely make sense to me; we write the ignores out to
~/.bazaar/ignores - showing the defaults isn't all that useful, because of
that.

[Parth Malwankar (parthm)]

On Wed, Apr 21, 2010 at 7:24 AM, Robert Collins
<email address hidden> wrote:
> This doesn't entirely make sense to me; we write the ignores out to
> ~/.bazaar/ignores - showing the defaults isn't all that useful, because of
> that.
>

The intent is avoid confusion caused by not knowing what
files are ignored by default. The bug #538703 entry captures
this confusion well :)

It was originally filed by me as a bug that bzr is not
adding *.a files by default and then the confusion cleared a
little but I couldn't really find a list of default ignores. Granted
that I could have 'cat ~/.bazaar/ignores' but I wasn't aware
of the file (maybe I could have read the docs better but I
think an the average user may not do that). I became aware
of the ignores file and its implicit creation only after looking
at the code.

IMO this option would make default ignores discoverable.
Also, the ~/.bazaar/ignores files may be edited over time
so the user will then be left with no way of know what
files bzr ignores by default.

[Vincent Ladeuil (vila)]

Having both --default-rules and --old-default-rules sounds messy, let's delete the later entirely.

As mentioned in the bug report, I think it's good to have the option to display
the *default* so that users can compare it to their ~/.bazaar/ignores.

review: Needs Fixing

[Parth Malwankar (parthm)]

> Having both --default-rules and --old-default-rules sounds messy, let's delete
> the later entirely.
>

Sounds fine to me. I can do that either in this patch or separately.
Is there a deprecation policy we need to follow for deletion of
--old-default-rules or is it reasonable to just remove it?

> As mentioned in the bug report, I think it's good to have the option to
> display
> the *default* so that users can compare it to their ~/.bazaar/ignores.

[Vincent Ladeuil (vila)]

I can't imagine anyone relying on --old-default-rules, so let's just delete it.

[Parth Malwankar (parthm)]

> I can't imagine anyone relying on --old-default-rules, so let's just delete
> it.

Thanks Vincent. I have removed --old-default-rules.
I have also updated 'bzr help ignore' to mention ~/.bazaar/ignore' because that was missing.

[Vincent Ladeuil (vila)]

Thanks, we just need a second review now.

review: Approve

[Ian Clatworthy (ian-clatworthy)]

review: Approve

=== modified file 'NEWS'
--- NEWS	2010-04-21 05:05:02 +0000
+++ NEWS	2010-04-22 14:18:26 +0000
@@ -19,6 +19,11 @@
 * ``bzr diff`` now supports a --format option, which can be used to 
   select alternative diff formats. (Jelmer Vernooij, #555994)
 
+* ``bzr ignore`` now supports a ``--default-rules`` option that displays
+  the default ignore rules used by bzr. The flag ``--old-default-rules``
+  is no longer supported by ``ignore``.
+  (Parth Malwankar, #538703)
+
 * ``bzr pack`` now supports a ``--clean-obsolete-packs`` option that
   can save disk space by deleting obsolete pack files created during the
   pack operation.

=== modified file 'bzrlib/builtins.py'
--- bzrlib/builtins.py	2010-04-19 13:04:30 +0000
+++ bzrlib/builtins.py	2010-04-22 14:18:26 +0000
@@ -2649,6 +2649,12 @@
     using this command or directly by using an editor, be sure to commit
     it.
     
+    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
+    the global ignore file can be found in the application data directory as
+    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
+    Global ignores are not touched by this command. The global ignore file
+    can be edited directly using an editor.
+
     Patterns prefixed with '!' are exceptions to ignore patterns and take
     precedence over regular ignores.  Such exceptions are used to specify
     files that should be versioned which would otherwise be ignored.
@@ -2695,20 +2701,20 @@
     _see_also = ['status', 'ignored', 'patterns']
     takes_args = ['name_pattern*']
     takes_options = [
-        Option('old-default-rules',
-               help='Write out the ignore rules bzr < 0.9 always used.')
+        Option('default-rules',
+               help='Display the default ignore rules that bzr uses.')
         ]
 
-    def run(self, name_pattern_list=None, old_default_rules=None):
+    def run(self, name_pattern_list=None, default_rules=None):
         from bzrlib import ignores
-        if old_default_rules is not None:
-            # dump the rules and exit
-            for pattern in ignores.OLD_DEFAULTS:
+        if default_rules is not None:
+            # dump the default rules and exit
+            for pattern in ignores.USER_DEFAULTS:
                 self.outf.write("%s\n" % pattern)
             return
         if not name_pattern_list:
             raise errors.BzrCommandError("ignore requires at least one "
-                                  "NAME_PATTERN or --old-default-rules")
+                "NAME_PATTERN or --default-rules.")
         name_pattern_list = [globbing.normalize_pattern(p)
                              for p in name_pattern_list]
         for name_pattern in name_pattern_list:

=== modified file 'bzrlib/ignores.py'
--- bzrlib/ignores.py	2010-03-29 00:54:27 +0000
+++ bzrlib/ignores.py	2010-04-22 14:18:26 +0000
@@ -27,66 +27,6 @@
 
 from trace import warning
 
-# This was the full ignore list for bzr 0.8
-# please keep these sorted (in C locale order) to aid merging
-OLD_DEFAULTS = [
-    '#*#',
-    '*$',
-    '*,v',
-    '*.BAK',
-    '*.a',
-    '*.bak',
-    '*.elc',
-    '*.exe',
-    '*.la',
-    '*.lo',
-    '*.o',
-    '*.obj',
-    '*.orig',
-    '*.py[oc]',
-    '*.so',
-    '*.tmp',
-    '*~',
-    '.#*',
-    '.*.sw[nop]',
-    '.*.tmp',
-    # Our setup tests dump .python-eggs in the bzr source tree root
-    './.python-eggs',
-    '.DS_Store',
-    '.arch-ids',
-    '.arch-inventory',
-    '.bzr.log',
-    '.del-*',
-    '.git',
-    '.hg',
-    '.jamdeps'
-    '.libs',
-    '.make.state',
-    '.sconsign*',
-    '.svn',
-    '.sw[nop]',    # vim editing nameless file
-    '.tmp*',
-    'BitKeeper',
-    'CVS',
-    'CVS.adm',
-    'RCS',
-    'SCCS',
-    'TAGS',
-    '_darcs',
-    'aclocal.m4',
-    'autom4te*',
-    'config.h',
-    'config.h.in',
-    'config.log',
-    'config.status',
-    'config.sub',
-    'stamp-h',
-    'stamp-h.in',
-    'stamp-h1',
-    '{arch}',
-]
-
-
 # ~/.bazaar/ignore will be filled out using
 # this ignore list, if it does not exist
 # please keep these sorted (in C locale order) to aid merging

=== modified file 'bzrlib/tests/blackbox/test_ignore.py'
--- bzrlib/tests/blackbox/test_ignore.py	2010-02-17 17:11:16 +0000
+++ bzrlib/tests/blackbox/test_ignore.py	2010-04-22 14:18:26 +0000
@@ -106,12 +106,14 @@
         """'ignore' with no arguments returns an error"""
         self.make_branch_and_tree('.')
         self.run_bzr_error(('bzr: ERROR: ignore requires at least one '
-                            'NAME_PATTERN or --old-default-rules\n',),
+                            'NAME_PATTERN or --default-rules.\n',),
                            'ignore')
 
-    def test_ignore_old_defaults(self):
-        out, err = self.run_bzr('ignore --old-default-rules')
-        self.assertContainsRe(out, 'CVS')
+    def test_ignore_default_rules(self):
+        out, err = self.run_bzr(['ignore', '--default-rules'])
+        reference_set = set(ignores.USER_DEFAULTS)
+        output_set = set(out.rstrip().split('\n'))
+        self.assertEqual(reference_set, output_set)
         self.assertEqual('', err)
 
     def test_ignore_versioned_file(self):