git@vger.kernel.org list mirror (unofficial, one of many)
 help / color / mirror / code / Atom feed
From: Eric Sunshine <sunshine@sunshineco.com>
To: Pratyush Yadav <me@yadavpratyush.com>,
	Junio C Hamano <gitster@pobox.com>
Cc: Git List <git@vger.kernel.org>, Johannes Sixt <j6t@kdbg.org>
Subject: Re: [PATCH v2] git-gui: remove lines starting with the comment character
Date: Sun, 28 Feb 2021 18:00:49 -0500	[thread overview]
Message-ID: <CAPig+cT-sfgMDi9-6AEKF85NtOiXeqddJjk-pYuhDtTVAE-UEw@mail.gmail.com> (raw)
In-Reply-To: <20210218181937.83419-1-me@yadavpratyush.com>

[Junio: please do not pull the latest git-gui changes yet; they break
on macOS, making git-gui unusable]

On Thu, Feb 18, 2021 at 1:20 PM Pratyush Yadav <me@yadavpratyush.com> wrote:
> The comment character is specified by the config variable
> 'core.commentchar'. Any lines starting with this character is considered
> a comment and should not be included in the final commit message.
>
> Teach git-gui to filter out lines in the commit message that start with
> the comment character using git-stripspace. If the config is not set,
> '#' is taken as the default. Also add a message educating users about
> the comment character.

Thanks for working on this. I've been looking forward to the
improvement; the old behavior of not stripping comment lines has been
a long-time annoyance.

Unfortunately, however, the changes break git-gui badly on macOS. See below...

> Signed-off-by: Pratyush Yadav <me@yadavpratyush.com>
> ---
> diff --git a/git-gui.sh b/git-gui.sh
> @@ -3436,6 +3437,10 @@ proc trace_commit_type {varname args} {
> +       set comment_char [get_config core.commentchar]
> +       set txt [string cat $txt \
> +                                [mc " (Lines starting with '$comment_char' will be ignored)"]]

The old Tcl 8.5.9 on macOS does not have a string `cat` method, so
`string cat` crashes:

    can't set "commit_type": unknown or ambiguous subcommand "cat":
        must be bytelength, compare, equal, first, index, is, last,
        length, map, match, range, repeat, replace, reverse, tolower,
        totitle, toupper, trim, trimleft, trimright, wordend, or
        wordstart
    unknown or ambiguous subcommand "cat": must be bytelength,
        compare, equal, first, index, is, last, length, map, match,
        range, repeat, replace, reverse, tolower, totitle, toupper,
        trim, trimleft, trimright, wordend, or wordstart while
        executing
    "string cat $txt [mc " (Lines starting with '$comment_char' will
        be ignored)"]"

> diff --git a/lib/commit.tcl b/lib/commit.tcl
> @@ -141,6 +141,20 @@ proc setup_commit_encoding {msg_wt {quiet 0}} {
> +proc strip_msg {msg} {
> +       set cmd [concat [list | ] [_git_cmd stripspace] --strip-comments]
> +       _trace_exec $cmd
> +       set fd [open $cmd r+]
> +       fconfigure $fd -translation binary -encoding utf-8
> +       puts -nonewline $fd $msg
> +       close $fd w
> +       set result [read $fd]
> +       close $fd
> +       return $result
> +}

The old Tcl on macOS does not support closing one end of a
bidirectional pipe, so `close $fd w` errors out:

    wrong # args: should be "close channelId"
    wrong # args: should be "close channelId"
        while executing
    "close $fd w"

I'll send a patch which resolves both problems.

      parent reply	other threads:[~2021-02-28 23:03 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-02-18 18:19 Pratyush Yadav
2021-02-22 14:51 ` Pratyush Yadav
2021-02-28 23:00 ` Eric Sunshine [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CAPig+cT-sfgMDi9-6AEKF85NtOiXeqddJjk-pYuhDtTVAE-UEw@mail.gmail.com \
    --to=sunshine@sunshineco.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=j6t@kdbg.org \
    --cc=me@yadavpratyush.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this inbox:

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).