Merge lp:~patrick-regan/bzr/ignoreclarify into lp:bzr

[Patrick Regan]

[Patrick Regan (patrick-regan)]

Bug #59608 was pretty old, and something I could help on.

I've added some more clarification in both the tutorial and the online help text that tells the user that the ignore command will create a .bzrignore file and also implicitly add it for the next commit.

My first contribution, please feel free to give input. I am expecting to make mistakes for the first few.

[John A Meinel (jameinel)]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Patrick Regan wrote:
> Patrick Regan has proposed merging lp:~patrick-regan/bzr/ignoreclarify into lp:bzr.
>
> Requested reviews:
> bzr-core (bzr-core)
> Related bugs:
> #59608 'bzr ignore' undocumented behaviour and misleading tutorial
> https://bugs.launchpad.net/bugs/59608
>
>
> Bug #59608 was pretty old, and something I could help on.
>
> I've added some more clarification in both the tutorial and the online help text that tells the user that the ignore command will create a .bzrignore file and also implicitly add it for the next commit.
>
> My first contribution, please feel free to give input. I am expecting to make mistakes for the first few.
>

+ In the case that a .bzrignore file does not exist, the ignore command
+ will create one and add the specified files or patterns to the newly
+ created file. The ignore command will also automatically add the
+ .bzrignore file to be versioned. If creating a .bzrignore file without
+ the use of the ignore command will require an explicit add command.
+

What about:

 "If a .bzrignore file does not exist, ..."

Creating a .bzrignore file without using the ignore command will
require an explicit add command.

I like the rest.

 review: needs_fixing

John
=:->
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (Cygwin)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAksFtHQACgkQJdeBCYSNAANhEwCeIMX+uGpdTSkCtGciO0n5e6Et
TbkAn0jDb9sdxdKlwe5p3IpjVKI+I63l
=+eoA
-----END PGP SIGNATURE-----

review: Needs Fixing

[Patrick Regan (patrick-regan)]

My only concern with getting rid of the

"The ignore command will also automatically add the .bzrignore file to be versioned."

sentence is that the original bug complaint was the following:

"From observation of behaviour, not by reading code, it is apparent that 'ignore' creates a .bzrignore file if none exists, or appends to it if it exists already. That might be expected. 'ignore' ALSO does an implicit and silent ADD of .bzrignore to the versioned file set. That was not entirely expected, and the tutorial is misleading in this respect."

I added that sentence to specifically mention that it does do a silent ADD. Do you think that the mentioning of this implicit add in the tutorial is enough? I've since changed the other suggestions in my local branch.

[John A Meinel (jameinel)]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Patrick Regan wrote:
> My only concern with getting rid of the
>
> "The ignore command will also automatically add the .bzrignore file to be versioned."
>
> sentence is that the original bug complaint was the following:
>
> "From observation of behaviour, not by reading code, it is apparent that 'ignore' creates a .bzrignore file if none exists, or appends to it if it exists already. That might be expected. 'ignore' ALSO does an implicit and silent ADD of .bzrignore to the versioned file set. That was not entirely expected, and the tutorial is misleading in this respect."
>
> I added that sentence to specifically mention that it does do a silent ADD. Do you think that the mentioning of this implicit add in the tutorial is enough? I've since changed the other suggestions in my local branch.

I wasn't asking to remove that line, just change the wording on the
first one, and rewrite the last. Keep everything else the same.

John
=:->
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (Cygwin)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAksFzL4ACgkQJdeBCYSNAANbcQCdHvCHakUGQDuGQuvDSd84gQ8v
8qIAn3p+BgXEX9XXj/W/GOaiiJqlHFmK
=e12A
-----END PGP SIGNATURE-----

[Patrick Regan (patrick-regan)]

Ok, sounds good. I'll post tonight.

Sent from Android phone.

On Thu, Nov 19, 2009 at 5:57 PM, John A Meinel <email address hidden>wrote:

> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
>
> Patrick Regan wrote:
> > My only concern with getting rid of the
> >
> > "The ignore command will also automatically add the .bzrignore file to be
> versioned."
> >
> > sentence is that the original bug complaint was the following:
> >
> > "From observation of behaviour, not by reading code, it is apparent that
> 'ignore' creates a .bzrignore file if none exists, or appends to it if it
> exists already. That might be expected. 'ignore' ALSO does an implicit and
> silent ADD of .bzrignore to the versioned file set. That was not entirely
> expected, and the tutorial is misleading in this respect."
> >
> > I added that sentence to specifically mention that it does do a silent
> ADD. Do you think that the mentioning of this implicit add in the tutorial
> is enough? I've since changed the other suggestions in my local branch.
>
>
> I wasn't asking to remove that line, just change the wording on the
> first one, and rewrite the last. Keep everything else the same.
>
> John
> =:->
> -----BEGIN PGP SIGNATURE-----
> Version: GnuPG v1.4.9 (Cygwin)
> Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/
>
> iEYEARECAAYFAksFzL4ACgkQJdeBCYSNAANbcQCdHvCHakUGQDuGQuvDSd84gQ8v
> 8qIAn3p+BgXEX9XXj/W/GOaiiJqlHFmK
> =e12A
> -----END PGP SIGNATURE-----
> --
> https://code.launchpad.net/~patrick-regan/bzr/ignoreclarify/+merge/15019
> You are the owner of lp:~patrick-regan/bzr/ignoreclarify.
>

[Patrick Regan (patrick-regan)]

This is a resubmition with the changes Mr. Meinel suggested.

review: Needs Resubmitting

[Patrick Regan (patrick-regan)]

> This is a resubmition with the changes Mr. Meinel suggested.
Please disregard this vote. I had thought that it was a tag, but just now realized that it was a vote. Please excuse the newbie mistake.

[Ian Clatworthy (ian-clatworthy)]

I'll go ahead and land this now given John's previous vote. Well done on getting your first patch through the system!

review: Approve

[Patrick Regan (patrick-regan)]

> I'll go ahead and land this now given John's previous vote. Well done on
> getting your first patch through the system!

Thanks, I had lots of help.

=== modified file 'bzrlib/builtins.py'
--- bzrlib/builtins.py	2009-11-19 06:28:13 +0000
+++ bzrlib/builtins.py	2009-11-19 23:34:11 +0000
@@ -2577,6 +2577,12 @@
 
     See ``bzr help patterns`` for details on the syntax of patterns.
 
+    If a .bzrignore file does not exist, the ignore command
+    will create one and add the specified files or patterns to the newly
+    created file. The ignore command will also automatically add the 
+    .bzrignore file to be versioned. Creating a .bzrignore file without
+    the use of the ignore command will require an explicit add command.
+
     To remove patterns from the ignore list, edit the .bzrignore file.
     After adding, editing or deleting that file either indirectly by
     using this command or directly by using an editor, be sure to commit

=== modified file 'doc/en/tutorials/tutorial.txt'
--- doc/en/tutorials/tutorial.txt	2009-09-02 16:03:51 +0000
+++ doc/en/tutorials/tutorial.txt	2009-11-19 23:34:11 +0000
@@ -403,6 +403,26 @@
     % bzr commit -m "Add ignore patterns"
 
 
+bzr ignore
+----------
+
+As an alternative to editing the ``.bzrignore`` file, you can use the 
+``bzr ignore`` command. The ``bzr ignore`` command takes filenames and/or
+patterns as arguments and then adds them to the ``.bzrignore`` file. If a
+``.bzrignore`` file does not exist the ``bzr ignore`` command will 
+automatically create one for you, and implicitly add it to be versioned::
+
+    % bzr ignore tags
+    % bzr status
+    added:
+      .bzrignore
+
+Just like when editing the ``.bzrignore`` file on your own, you should
+commit the automatically created ``.bzrignore`` file::
+
+    % bzr commit -m "Added tags to ignore file"
+
+
 Global ignores
 --------------