为别名命令添加“ git help”？

Question

我已经实现了一个Git命令，并使用git别名将其挂钩到Git中，但是有没有办法挂钩Git帮助？我在Windows上运行，如果出现问题，则会git help mycmd弹出一个对话框，告诉我Git找不到git-mycmnd.html文件。

我已经使用Python实现了命令，因此除了“只知道”必须在何处放置帮助文件之外，是否有适当的方法添加帮助？

Answer 1

您可以为您的别名定制文档，该文档可以本地保存，也可以通过网络在线访问。它的工作原理如下：

git config --local help.format html

cd ~/Documents

git clone git://git.kernel.org/pub/scm/git/git-htmldocs.git git-doc

假设你的命令是love这样的：

cd ~/Documents/git-doc
touch gitlove.html 
Add some text to the gitlove.html

cd YOUR_PROJECT_REPO
git config --local help.htmlpath ~/Documents/git-doc

现在你可以这样做：git help love你的 html 页面将会弹出。

享受！

对我来说，我同意。但作为向很多人推出有用的 git 扩展的一种方式，我可以使用“pip install this then run this git alias command”，但我不能要求人们开始像这样乱搞 Git 文档。我的“完美”解决方案是某种“帮助别名”，可能会处理别名，可能会传递“帮助”和格式（man、html等），然后让我的脚本完成其余的工作。 (2认同)