git-extras
git-extras copied to clipboard
Usage output should use `git foo` when invoked via git
If I run the git-cp script directly with no parameters, the output says USAGE: /foo/bar/bin/git-cp [...] which is on point. I might want it to just say git-cp there, but that's a minor quibble.
More importantly, and the subject of this issue, is that if I run git cp and git searches my path to find the git-cp script, then the output STILL says USAGE: /foo/bar/bin/git-cp [...] when I think it should say USAGE: git cp [...] in keeping with the behavior of most other git commands.
Some git command scripts included with git use different approaches for this:
git-archimport,git-cvsexportcommit,git-cvsimport,git-cvsserver, andgit-merge-one-fileall hard code the usage text ofgit whateverwithout regard for the actual filenamegit-filter-branch,git-merge-one-file,git-mergetool,git-submodule, andgit-web--browseall usegit-sh-setup'susage()to parse the script filename and blindly removes the first dashgit-p4does whatgit-extrasdoes now, outputting the full path to the script
I propose one of the following solutions:
- Hard code
git fooas the usage invocation forgit-fooacross all the scripts - Use
git-sh-setup'susage() - Implement a custom detection of git invocation, perhaps by checking for
GIT_EXEC_PATH
I volunteer to implement any of these if you pick one.
PR is welcome!
@spacewander Any suggestion on whether I pursue option 1, 2, or 3?
Also, how complete would such a change need to be to get accepted? I notice a lot of the git-extras scripts were written with different usage string paradigms already, probably copied from different upstream behaviors. Some of them will be easy to convert to use something more flexible. Others are already very complex and may be difficult to convert.
I don't have a strong opinion, but I would vote for option 1. It's the easiest way to implement.
I have underestimated how many different usage output paradigms there would be in the different scripts here. This will be a bigger undertaking than I originally thought. I still want to do it, just not today.
@sparr Thanks for your investigation! We can wait for it.