From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 12119 invoked by alias); 24 Jan 2015 15:45:30 -0000 Mailing-List: contact zsh-workers-help@zsh.org; run by ezmlm Precedence: bulk X-No-Archive: yes List-Id: Zsh Workers List List-Post: List-Help: X-Seq: 34370 Received: (qmail 21889 invoked from network); 24 Jan 2015 15:45:25 -0000 X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on f.primenet.com.au X-Spam-Level: X-Spam-Status: No, score=-2.7 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,RCVD_IN_DNSWL_LOW autolearn=ham version=3.3.2 DKIM-Signature: v=1; a=rsa-sha1; c=relaxed/relaxed; d= daniel.shahaf.name; h=x-sasl-enc:date:from:to:subject:message-id :mime-version:content-type:content-transfer-encoding; s=mesmtp; bh=l/wjtkrCkTCMxEXz1kVrIDTxKhg=; b=2CztSq703M7SnXBoXcDEQZsu1vra 2+nbb4DyfHaH7j6zL7DydZE82d47B3AjG5AXAxQKh1bxYpieue3fpSr5LcHEjdak Dk5KXiqv7d8ruxOHKbf4MKVZ7ONQ3zycKd3HQ/aaRumROz1ugQ2F4tERhtVzhIaf 4Dj6CKxbXjAGw9U= DKIM-Signature: v=1; a=rsa-sha1; c=relaxed/relaxed; d= messagingengine.com; h=x-sasl-enc:date:from:to:subject :message-id:mime-version:content-type:content-transfer-encoding; s=smtpout; bh=l/wjtkrCkTCMxEXz1kVrIDTxKhg=; b=h/SWwoFYGXgVTWfL8 ZdCzhxwQjLyN2PcI565lasljDEHVdzy9KCwZdbdG7HdqISTd7EKBMbe++m6HNvNH LQx5HeMb3l4FcLCmWwirsvMVDNh76QRrRipsdtzLBKvn2hmFUYiVhpqcZFnw1KW4 LBOhJT9Op6LWLBQ44CFFEmKR2s= X-Sasl-enc: HwEig0w9WvBWcka5dJQdJ91zjkg+3rhEQlVdHHN6kSFW 1422114323 Date: Sat, 24 Jan 2015 15:45:21 +0000 From: Daniel Shahaf To: zsh-workers@zsh.org Subject: [PATCH] vcs_info docs: Document patch-format and more Message-ID: <20150124154521.GF20359@tarsus.local2> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="AsxXAMtlQ5JHofzM" Content-Disposition: inline Content-Transfer-Encoding: 8bit User-Agent: Mutt/1.5.21 (2010-09-15) --AsxXAMtlQ5JHofzM Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: 8bit Patch that adds all styles/hooks used by vcs_info to its documentation. Two notes about this patch: 1. I didn't actually document all of them, for some I only added placeholders. I think that would be better than not documenting them at all, but obviously it would be nice if the documentation were actually written. I don't use most of that myself (e.g., I don't use the quilt support at all), so I think the docs would be better if someone who actually uses the features documented them — for example, because they would be better placed to notice edge case bugs, instead of documenting them as features. 2. The endsitem()/startitem() hack is because otherwise the man page version rendered badly. It seems to render ok everywhere I check, but it's inelegant. Maybe the list should be converted entirely from sitem to item? I amn't familiar with the yodl stuff enough to say. Daniel P.S. All patches I sent today should be mutually non-conflicting, though some of them touch the same files as each other so offsets are expected (but no fuzz). --AsxXAMtlQ5JHofzM Content-Type: text/x-patch; charset=us-ascii Content-Disposition: attachment; filename="0001-vcs_info-docs-Document-patch-format-and-add-stubs-fo.patch" >>From db87641b8a526534235d9c19a9ef4ac9c6828f36 Mon Sep 17 00:00:00 2001 From: Daniel Shahaf Date: Sat, 24 Jan 2015 10:30:49 +0000 Subject: [PATCH] vcs_info docs: Document patch-format and more --- Doc/Zsh/contrib.yo | 46 ++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 42 insertions(+), 4 deletions(-) diff --git a/Doc/Zsh/contrib.yo b/Doc/Zsh/contrib.yo index 00ede52..c625cbd 100644 --- a/Doc/Zsh/contrib.yo +++ b/Doc/Zsh/contrib.yo @@ -944,6 +944,20 @@ item(tt(hooks))( A list style that defines hook-function names. See bf(Hooks in vcs_info) below for details. ) +kindex(patch-format) +kindex(nopatch-format) +xitem(tt(patch-format)) +item(tt(nopatch-format))( +This pair of styles format the patch information used by the tt(%m) expando in +formats and actionformats for the tt(git) and tt(hg) backends. The value is +subject to certain tt(%)-expansions described below. +) +kindex(get-unapplied) +item(tt(get-unapplied))( +TODO: undocumented. + +Used by the tt(quilt) and tt(hg) backends. +) enditem() The default values for these styles in all contexts are: @@ -975,6 +989,9 @@ sitem(tt(use-quilt))(false) sitem(tt(quilt-standalone))(false) sitem(tt(quilt-patch-dir))(empty - use tt($QUILT_PATCHES)) sitem(tt(quiltcommand))(quilt) +sitem(tt(patch-format))(var(backend dependent)) +sitem(tt(nopatch-format))(var(backend dependent)) +sitem(tt(get-unapplied))(false) endsitem() In normal tt(formats) and tt(actionformats) the following replacements are @@ -996,11 +1013,26 @@ sitem(tt(%r))(The repository name. If tt(%R) is tt(/foo/bar/repoXY), tt(%r) is tt(repoXY).) sitem(tt(%S))(A subdirectory within a repository. If tt($PWD) is tt(/foo/bar/repoXY/beer/tasty), tt(%S) is tt(beer/tasty).) -sitem(tt(%m))(A "misc" replacement. It is at the discretion of the backend to -decide what this replacement expands to. It is currently used by the tt(hg) -and tt(git) backends to display patch information from the tt(mq) and -tt(stgit) extensions.) endsitem() +startitem() +item(tt(%m))( +A "misc" replacement. It is at the discretion of the backend to +decide what this replacement expands to. + +The tt(hg) and tt(git) backends use this expando to display patch information. +tt(hg) sources patch information from the tt(mq) extensions; tt(git) from the +tt(rebase) command and from the and tt(stgit) extension. The tt(patch-format) +and tt(nopatch-format) styles control the generated string. The former is used +when at least one patch from the patch queue has been applied, and the latter +otherwise. + +The tt(hg) backend displays bookmark information in this expando (in addition +to tt(mq) information). See the tt(get-mq) and tt(get-bookmarks) styles. Both +of these styles may be enabled at the same time. If both are enabled, both +resulting strings will be shown separated by a semicolon (that cannot currently +be customized). +) +enditem() In tt(branchformat) these replacements are done: @@ -1377,6 +1409,12 @@ If tt(ret) is set to non-zero, the string in tt(${hook_com[rev-replace]}) will be used unchanged as the `tt(%i)' replacement in the variables set by tt(vcs_info). ) +item(tt(pre-addon-quilt))( +TODO: undocumented +) +item(tt(set-patch-format))( +TODO: undocumented +) item(tt(set-message))( Called each time before a `tt(vcs_info_msg_N_)' message is set. It takes two arguments; the first being the `N' in the message -- 1.9.1 --AsxXAMtlQ5JHofzM--