threads / discuss / 25011

Should git-citool be in mainporcelain in command-list?

Subject: Should git-citool be in mainporcelain in command-list?

## tl;dr

6 messages between Sep 6, 2010 and Sep 6, 2010.

replies: 5people: 2as markdown or json

Ævar Arnfjörð Bjarmason· Sep 6, 2010, 21:27 UTC · lore
Maybe there should be an aliases category:
    $ grep -e git-gui -e citool command-list.txt
    git-citool                              mainporcelain
    git-gui                                 mainporcelain

A very minor nit, just something I ran into while gettext-izing and wondered "what's that".

But I'm probably the only one that's used command-list.txt for anything non-Make related in a while :)

Jonathan Nieder· Sep 6, 2010, 21:39 UTC · re: Ævar Arnfjörð Bjarmason · lore

Re: Should git-citool be in mainporcelain in command-list?

Ævar Arnfjörð Bjarmason wrote:
Show 11 quoted lines
> Maybe there should be an aliases category:
> 
>     $ grep -e git-gui -e citool command-list.txt
>     git-citool                              mainporcelain
>     git-gui                                 mainporcelain
> 
> A very minor nit, just something I ran into while gettext-izing and
> wondered "what's that".
> 
> But I'm probably the only one that's used command-list.txt for
> anything non-Make related in a while :)
Its main purpose is to populate the command list in git.1:
   Main porcelain commands
[...]
	git-citool(1)
	   Graphical alternative to git-commit.
[...]
	git-gui(1)
	   A portable graphical interface to Git.

What do you think this should say? (Honest question --- I haven't thought hard about it.)

Ævar Arnfjörð Bjarmason· Sep 6, 2010, 22:00 UTC · re: Jonathan Nieder · lore

Re: Should git-citool be in mainporcelain in command-list?

On Mon, Sep 6, 2010 at 21:39, Jonathan Nieder <jrnieder@gmail.com> wrote:
Show 26 quoted lines
> Ævar Arnfjörð Bjarmason wrote:
>
>> Maybe there should be an aliases category:
>>
>>     $ grep -e git-gui -e citool command-list.txt
>>     git-citool                              mainporcelain
>>     git-gui                                 mainporcelain
>>
>> A very minor nit, just something I ran into while gettext-izing and
>> wondered "what's that".
>>
>> But I'm probably the only one that's used command-list.txt for
>> anything non-Make related in a while :)
>
> Its main purpose is to populate the command list in git.1:
>
>   Main porcelain commands
> [...]
>        git-citool(1)
>           Graphical alternative to git-commit.
> [...]
>        git-gui(1)
>           A portable graphical interface to Git.
>
> What do you think this should say?  (Honest question --- I
> haven't thought hard about it.)

I haven't either, and I don't use git-gui or the git citool alias. I didn't even know about it until yesterday.

The entries in git(1) don't indicate that citool is a convenience alias for git-gui:

       git-gui(1)
           A portable graphical interface to Git.
       git-citool(1)
           Graphical alternative to git-commit.

Maybe it shouldn't be listed there at all to avoid confusion, or maybe it should be in an aliases category to clearly indicate its function as a convenience alias in the manpage.

Jonathan Nieder· Sep 6, 2010, 22:07 UTC · re: Ævar Arnfjörð Bjarmason · lore

Re: Should git-citool be in mainporcelain in command-list?

Ævar Arnfjörð Bjarmason wrote:
> The entries in git(1) don't indicate that citool is a convenience
> alias for git-gui:
That's because it isn't, no?
SYNOPSIS
       git citool
DESCRIPTION
       A Tcl/Tk based graphical interface to review modified
       files, stage them into the index, enter a commit message
       and record the new commit onto the current branch. This
       interface is an alternative to the less interactive git
       commit program.
       git citool is actually a standard alias for git gui
       citool. See git-gui(1) for more details.
Ævar Arnfjörð Bjarmason· Sep 6, 2010, 22:17 UTC · re: Jonathan Nieder · lore

Re: Should git-citool be in mainporcelain in command-list?

On Mon, Sep 6, 2010 at 22:07, Jonathan Nieder <jrnieder@gmail.com> wrote:
Show 6 quoted lines
> Ævar Arnfjörð Bjarmason wrote:
>
>> The entries in git(1) don't indicate that citool is a convenience
>> alias for git-gui:
>
> That's because it isn't, no?

I mean "convenience" interchangeably with "standard" as this paragraph uses it:

>       git citool is actually a standard alias for git gui
>       citool. See git-gui(1) for more details.

I.e. `git gui citool` and `git citool` launch the same thing, the latter is just a shorter way to do it.

Jonathan Nieder· Sep 6, 2010, 22:31 UTC · re: Ævar Arnfjörð Bjarmason · lore

Re: Should git-citool be in mainporcelain in command-list?

Ævar Arnfjörð Bjarmason wrote:
> On Mon, Sep 6, 2010 at 22:07, Jonathan Nieder <jrnieder@gmail.com> wrote:
Show 5 quoted lines
>>       git citool is actually a standard alias for git gui
>>       citool. See git-gui(1) for more details.
>
> I.e. `git gui citool` and `git citool` launch the same thing, the
> latter is just a shorter way to do it.

All I meant is that it is not an alias for "git gui" but for "git gui citool". I can imagine a person reading git(1) and learning about the ability to say

	git citool

though I guess by the same token a person might wonder why the list does not include similar

	git blametool
and
	git browsertool

commands. Anyway, I have nothing against a separate "aliases" category. Sorry for the noise.

← back to recent threads