PATCH: Clarify check-for-changes with mercurial

PATCH: Clarify check-for-changes with mercurial

[Frank Terbeck]

---
 Doc/Zsh/contrib.yo |    4 ++++
 1 files changed, 4 insertions(+), 0 deletions(-)

diff --git a/Doc/Zsh/contrib.yo b/Doc/Zsh/contrib.yo
index 476e7ca..dc62a29 100644
--- a/Doc/Zsh/contrib.yo
+++ b/Doc/Zsh/contrib.yo
@@ -826,6 +826,10 @@ these escapes can be controlled via the var(stagedstr) and var(unstagedstr)
 styles. The only backends that currently support this option are tt(git) and
 tt(hg) (tt(hg) only supports unstaged).
 
+For this style to be evaluated with the tt(hg) backend, the var(get-revision)
+needs to be set and the var(use-simple) style needs to be unset. The latter
+is the default; the former is not.
+
 Note, the actions taken if this style is enabled are potentially expensive
 (read: they may be slow, depending on how big the current repository is).
 Therefore, it is disabled by default.
-- 
1.7.5

Re: PATCH: Clarify check-for-changes with mercurial

[Bart Schaefer]

On May 7,  8:49am, Frank Terbeck wrote:
} Subject: PATCH: Clarify check-for-changes with mercurial
}
} +For this style to be evaluated with the tt(hg) backend, the var(get-revision)
} +needs to be set and the var(use-simple) style needs to be unset. The latter
} +is the default; the former is not.

Minor remarks:

"the get-revision needs to be set" is missing a word ("style"?).

Don't use var(xxx) for literal strings.  var(xxx) is for, well,
variables -- not in the shell parameter sense, but in the sense of
something that will be replaced rather than typed literally.  When
yodl'd into "info" format, var(xxx) gets rendered into all-caps XXX
(possibly depending on what info viewer is used).  The convention in
zsh doc is to use `tt(get-revision)' (with or without the single-
quotes depending on context) for literals.

-- 

Re: PATCH: Clarify check-for-changes with mercurial

[Bart Schaefer]

On May 7,  9:57am, Bart Schaefer wrote:
}
} yodl'd into "info" format, var(xxx) gets rendered into all-caps XXX
} (possibly depending on what info viewer is used).

As an example of this, when I view the vcs_info documentation I see
this kind of thing:

****

26.4.2 Configuration
--------------------

The VCS_INFO feature can be configured via ZSTYLE.

****

I'm pretty sure those weren't intended to be capitalized.

-- 

Re: PATCH: Clarify check-for-changes with mercurial

[Frank Terbeck]

Bart Schaefer wrote:
> On May 7,  9:57am, Bart Schaefer wrote:
> } yodl'd into "info" format, var(xxx) gets rendered into all-caps XXX
> } (possibly depending on what info viewer is used).
>
> As an example of this, when I view the vcs_info documentation I see
> this kind of thing:
>
> ****
>
> 26.4.2 Configuration
> --------------------
>
> The VCS_INFO feature can be configured via ZSTYLE.
>
> ****
>
> I'm pretty sure those weren't intended to be capitalized.

Huh. True. I didn't know that.

The vcs_info documentation is full of that. :-/

Regards, Frank