From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 2533 invoked by alias); 10 Aug 2015 16:11:38 -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: 36078 Received: (qmail 20615 invoked from network); 10 Aug 2015 16:11:37 -0000 X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) 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,FREEMAIL_FROM,RCVD_IN_DNSWL_LOW,RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL autolearn=ham autolearn_force=no version=3.4.0 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=from:to:subject:date:message-id:in-reply-to:references; bh=w1f7nSRZ9Xn45f4Vozb5MTaU55rxWj/9ZdXGT1CFujQ=; b=V+xK1H66denroRcXWqdaxn80yHUB2rKGJbRj702xv/w01yjR6FijlrbX0AIxKQfu3o Dd4X65uTvIJhsXWgzOuae5w3w3IpU4SO5DLx+nbEYs/xpF3A4ShQgzcOchaMXW3m/WrS BMReG+tL7FaMXmxK8wCHP0VHBq+q/Pp2uaPlGCGdMU4drLCpxtbZnWlVE8wIsYWCYBvA O3YV31IpY6xuly+j/uBH6aR8Zp6vi8En+kXaAdFN5xQT8vZZDebotXJzhiK6W4ZZzQx+ 7El4Cv8TWM3pEXC0vvHbvGa7QCZ5JOBWL2Eqq9viwsmnFOLMo8kVrL0ovOaB7EQpIcBw Gu8Q== X-Received: by 10.194.118.227 with SMTP id kp3mr47087978wjb.97.1439223096143; Mon, 10 Aug 2015 09:11:36 -0700 (PDT) From: Mikael Magnusson To: zsh-workers@zsh.org Subject: PATCH: vcs_info: Adjust documentation for no longer exporting Date: Mon, 10 Aug 2015 18:11:30 +0200 Message-Id: <1439223090-28230-1-git-send-email-mikachu@gmail.com> X-Mailer: git-send-email 2.4.0 In-Reply-To: <1439222979-28125-1-git-send-email-mikachu@gmail.com> References: <1439222979-28125-1-git-send-email-mikachu@gmail.com> Also contains a bonus syntax fix. --- Doc/Zsh/contrib.yo | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/Doc/Zsh/contrib.yo b/Doc/Zsh/contrib.yo index 09ac5c8..909f980 100644 --- a/Doc/Zsh/contrib.yo +++ b/Doc/Zsh/contrib.yo @@ -756,7 +756,7 @@ revision number. This style lets you modify how that string should look. ) kindex(nvcsformats) item(tt(nvcsformats))( -These "formats" are exported when we didn't detect a version control system +These "formats" are set when we didn't detect a version control system for the current directory or tt(vcs_info) was disabled. This is useful if you want tt(vcs_info) to completely take over the generation of your prompt. You would do something like tt(PS1='${vcs_info_msg_0_}') to @@ -775,7 +775,7 @@ behavior using hooks. kindex(max-exports) item(tt(max-exports))( Defines the maximum number of -tt(vcs_info_msg_*_) variables tt(vcs_info) will export. +tt(vcs_info_msg_*_) variables tt(vcs_info) will set. ) kindex(enable) item(tt(enable))( @@ -1224,16 +1224,15 @@ All functions named tt(VCS_INFO_*) are for internal use only. subsect(Variable Description) startitem() -item(tt(${vcs_info_msg_)var(N)tt(_)}) (Note the trailing underscore)) -( +item(tt(${vcs_info_msg_)var(N)tt(_}) (Note the trailing underscore))( Where var(N) is an integer, e.g., tt(vcs_info_msg_0_). These variables are the storage for the informational message the last tt(vcs_info) call has assembled. These are strongly connected to the tt(formats), tt(actionformats) and tt(nvcsformats) styles described above. Those styles are lists. The first member of that list gets expanded into tt(${vcs_info_msg_0_}), the second into tt(${vcs_info_msg_1_}) -and the Nth into tt(${vcs_info_msg_N-1_}). These parameters are -exported into the environment. (See the tt(max-exports) style above.) +and the Nth into tt(${vcs_info_msg_N-1_}). (See the tt(max-exports) +style above.) ) enditem() -- 2.4.0