首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >问答首页 >为自定义git命令提供帮助文档的正确方式是什么?

为自定义git命令提供帮助文档的正确方式是什么?
EN

Stack Overflow用户
提问于 2015-07-10 18:20:27
回答 1查看 61关注 0票数 5

如果我编写了一个名为git-foo的脚本,并将其放在我的PATH中的某个地方,那么我可以运行git foo来执行该脚本,并且可以运行git foo --option argument来将命令行选项和参数传递给我的脚本。

然而,当尝试打印帮助文档时,这种语法糖就失效了。我已经让git-foo --help工作了,但是如果我运行git foo --help,git不会将--help转发到我的脚本,而是尝试为git-foo打开一个man页面。我不想这样。有没有办法抑制自定义命令的这种行为?(理想情况下,作为脚本作者,但作为用户,我愿意接受一种抑制这一点的方法。)

我怀疑我应该生成一个man页面,但这似乎相当繁琐:然后脚本将需要与一个额外的文件打包,这个额外的文件将需要安装在其他地方,然后在卸载时有更多的工作要撤消。

EN

回答 1

Stack Overflow用户

发布于 2015-07-11 05:11:02

我想你被卡住了。Git有意通过man页面实现--help,以确保信息来源单一(而不是让手册页与嵌入式帮助输出不同步)。

如果您编写了一个man页面,您应该能够将其安装在与安装脚本的bin目录相同级别的man目录中。

安装和删除一个额外的文件似乎不是太糟糕。或者你也可以坚持

代码语言:javascript
运行
复制
git-foo --help

并告诉人们使用它。

票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/31338346

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档