Merge lp:~vila/bzr/mergetool-doc into lp:bzr

Proposed by Vincent Ladeuil on 2012-09-19
Status: Merged
Approved by: Martin Packman on 2012-10-10
Approved revision: 6568
Merged at revision: 6569
Proposed branch: lp:~vila/bzr/mergetool-doc
Merge into: lp:bzr
Diff against target: 25 lines (+16/-0)
1 file modified
bzrlib/help_topics/en/configuration.txt (+16/-0)
To merge this branch: bzr merge lp:~vila/bzr/mergetool-doc
Reviewer Review Type Date Requested Status
Martin Packman (community) 2012-09-19 Approve on 2012-09-19
Review via email: mp+125150@code.launchpad.net

Commit message

Clarify how `mergetool` templates should be used with `bzr config`.

Description of the change

Basde on an IRC discussion with mgz.

I think that should address
https://answers.launchpad.net/bzr/+question/196441 confusion.

To post a comment you must log in.
Martin Packman (gz) wrote :

So, I don't like "the following will (rightly) break", and perhaps we don't want to give the "wrong" version at all, but perhaps it's useful for people doing a search on the error message? So, just tone down the "we write software that's hard to use on purpose" angle and this should be fine.

review: Approve
lp:~vila/bzr/mergetool-doc updated on 2012-09-19
6566. By Vincent Ladeuil on 2012-09-19

Tone down ;)

Vincent Ladeuil (vila) wrote :

Is that better ?

Martin Packman (gz) wrote :

Typo, 'conflit'. But actually I find the sentence still rather hard to read, let's see if I can help...

"""
Because mergetool and config itself both use curly braces as interpolation markers, trying to display the mergetool line results in the following problem:

...

To avoid this, config can be instructed not to try expanding variables:

...
"""

Something like that? This is user-focused after all, so they shouldn't really care too much about the details.

lp:~vila/bzr/mergetool-doc updated on 2012-10-10
6567. By Vincent Ladeuil on 2012-10-10

Don't explain gory details, most users won't care.

6568. By Vincent Ladeuil on 2012-10-10

Fix formattting.

Vincent Ladeuil (vila) wrote :

> Typo, 'conflit'. But actually I find the sentence still rather hard to read,
> let's see if I can help...

Thanks ;)

> Something like that? This is user-focused after all, so they shouldn't really
> care too much about the details.

Agreed, done.

Vincent Ladeuil (vila) wrote :

sent to pqm by email

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
=== modified file 'bzrlib/help_topics/en/configuration.txt'
--- bzrlib/help_topics/en/configuration.txt 2012-06-20 13:58:18 +0000
+++ bzrlib/help_topics/en/configuration.txt 2012-10-10 18:32:18 +0000
@@ -713,6 +713,22 @@
713713
714 bzr.mergetool.kdiff3 = kdiff3 {base} {this} {other} -o {result}714 bzr.mergetool.kdiff3 = kdiff3 {base} {this} {other} -o {result}
715715
716Because ``mergetool`` and ``config`` itself both use curly braces as
717interpolation markers, trying to display the mergetool line results in the
718following problem::
719
720
721 $ bzr config bzr.mergetool.kdiff3='kdiff3 {base} {this} {other} -o {result}'
722 $ bzr config bzr.mergetool.kdiff3
723 bzr: ERROR: Option base is not defined while expanding "kdiff3 {base} {this} {other} -o {result}".
724
725To avoid this, ``config`` can be instructed not to try expanding variables::
726
727 $ bzr config --all bzr.mergetool.kdiff3
728 branch:
729 bzr.mergetool.kdiff3 = kdiff3 {base} {this} {other} -o {result}
730
731
716bzr.default_mergetool732bzr.default_mergetool
717~~~~~~~~~~~~~~~~~~~~~733~~~~~~~~~~~~~~~~~~~~~
718734