# Using '--help' for aliases 5 messages from 2017-06-21 to 2017-06-24. Participants: Kaartic Sivaraam, Jeff King, Samuel Lijin, brian m. carlson. Thread: https://gitlist.dev/t/46226 ## Kaartic Sivaraam, 2017-06-21 18:41 Subject: Using '--help' for aliases Message-ID: <1498070489.32360.14.camel@gmail.com> URL: https://gitlist.dev/e/1498070489.32360.14.camel%40gmail.com ``` Hello all, I am yet another user of 'git alias' (who wouldn't ?). It has become so natural to me to use the aliased version that at some point of time I tried the following, > $ git co --help > `git co' is aliased to `checkout' That made me wonder. Git is able to inform the user that 'co' is aliased to 'checkout' but isn't it possible for it to take one step more to display help ? Just wondering if there were any reason for not doing it. -- Regards, Kaartic Sivaraam ``` ## Jeff King, 2017-06-21 18:55 Subject: Re: Using '--help' for aliases Message-ID: <20170621185518.nhnqlkbt63hdoate@sigill.intra.peff.net> URL: https://gitlist.dev/e/20170621185518.nhnqlkbt63hdoate%40sigill.intra.peff.net In-Reply-To: <1498070489.32360.14.camel@gmail.com> ``` On Thu, Jun 22, 2017 at 12:11:29AM +0530, Kaartic Sivaraam wrote: > I am yet another user of 'git alias' (who wouldn't ?). It has become so > natural to me to use the aliased version that at some point of time I > tried the following, > > > $ git co --help > > `git co' is aliased to `checkout' > > That made me wonder. Git is able to inform the user that 'co' is > aliased to 'checkout' but isn't it possible for it to take one step > more to display help ? Just wondering if there were any reason for not > doing it. It could do that. I think we even discussed it at one point, but I didn't dig up the thread. However, you have the problem that running "man checkout" is likely to clobber the mention of the alias. So the question is whether it is more important to tell the user that it's an alias (and which options the alias is using!), or to show them the referred command's manpage. -Peff ``` ## Kaartic Sivaraam, 2017-06-21 19:14 Subject: Re: Using '--help' for aliases Message-ID: <1498072442.32360.20.camel@gmail.com> URL: https://gitlist.dev/e/1498072442.32360.20.camel%40gmail.com In-Reply-To: <20170621185518.nhnqlkbt63hdoate@sigill.intra.peff.net> ``` On Wed, 2017-06-21 at 14:55 -0400, Jeff King wrote: > It could do that. I think we even discussed it at one point, > but I > didn't dig up the thread. However, you have the problem that running > "man checkout" is likely to clobber the mention of the alias. So the > question is whether it is more important to tell the user that it's > an > alias (and which options the alias is using!), Now, that's something I didn't think of. Does seem to quite an issue as aliases accept argument this. I seem to be getting the idea of '--help' just now. All these days, I was actually considering it to be another way of getting to the man page of a command. Have to play with it a little to see in what other ways '--help' could help me! In case there's anything that's so useful about it that I'm missing, let me know. > or to show them the > referred command's manpage. > > -Peff -- Regards, Kaartic Sivaraam ``` ## Samuel Lijin, 2017-06-22 05:39 Subject: Re: Using '--help' for aliases Message-ID: URL: https://gitlist.dev/e/CAJZjrdXYqmQuxrCuayy2zcwPkR5Gq56caurR%2BjO107MFrGspBA%40mail.gmail.com In-Reply-To: <1498072442.32360.20.camel@gmail.com> ``` You could also just make the alias a bash function that does git help checkout when you pass the --help flag to the alias. ``` ## brian m. carlson, 2017-06-24 17:20 Subject: Re: Using '--help' for aliases Message-ID: <20170624172011.5afp3qhrec5ovynl@genre.crustytoothpaste.net> URL: https://gitlist.dev/e/20170624172011.5afp3qhrec5ovynl%40genre.crustytoothpaste.net In-Reply-To: <1498070489.32360.14.camel@gmail.com> ``` On Thu, Jun 22, 2017 at 12:11:29AM +0530, Kaartic Sivaraam wrote: > I am yet another user of 'git alias' (who wouldn't ?). It has become so > natural to me to use the aliased version that at some point of time I > tried the following, > > > $ git co --help > > `git co' is aliased to `checkout' > > That made me wonder. Git is able to inform the user that 'co' is > aliased to 'checkout' but isn't it possible for it to take one step > more to display help ? Just wondering if there were any reason for not > doing it. It's possible to do if "co" is an alias for "checkout", but it works less well when co is the following[0]: co = "!f() { if git checkout -h | grep -qs recurse-submodules; \ then git checkout --recurse-submodules \"$@\"; \ else git checkout \"$@\" && git sui; \ fi; };f" If this alias were to run on a Git with that option but without checkout --recurse-submodules, then it would print help and then update submodles, which isn't what I want. [0] sui is an alias for submodule update --init. -- brian m. carlson / brian with sandals: Houston, Texas, US https://www.crustytoothpaste.net/~bmc | My opinion only OpenPGP: https://keybase.io/bk2204 ```