在OSX上安装Git HTML帮助

时间:2012-01-03 07:59:35

标签: macos git

我已尝试根据以下链接提供的说明在OSX上安装Git HTML帮助页面:

但是当我进入涉及运行的最终验证步骤时:

git help --web commit

我收到以下错误:

fatal: '/usr/local/git/share/doc/git-doc': not a documentation directory

我已经验证了文件夹/ usr / local / git / share / doc / git-doc实际上是在我运行“git clone”时创建的,并且它充满了看起来像git文档的文件文件。

有人能让我知道我错过了什么吗?谢谢!

以下是git-doc文件夹中创建的一些文件的简短列表:

  • exec_cmd.c
  • exec_cmd.h
  • 快速import.c
  • 取-pack.h
  • 修正-内建
  • FMT-合并-msg.h
  • fsck.c
  • fsck.h
  • generate-cmdlist.sh
  • gettext.c
  • gettext.h
  • git的相加 - interactive.perl
  • git-am.sh
  • GIT-archimport.perl
  • git-bisect.sh
  • GIT-COMPAT-util.h
  • GIT-cvsexportcommit.perl
  • GIT-cvsimport.perl
  • GIT-cvsserver.perl
  • git-difftool--helper.sh
  • GIT-difftool.perl
  • git-filter-branch.sh

编辑: 只是查看了git clone结果并发现了这个警告,不确定它是否有所不同: “在上游原点找不到远程分支html,而是使用HEAD”

2 个答案:

答案 0 :(得分:12)

更改克隆命令地址
$ sudo git clone git://git.kernel.org/pub/scm/git/git.git git-doc --branch html

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

希望很快就会在Github教程中进行更改。

更新:

如果您是那些认为使用Xcode 4提供Apple Git发行版的人之一:

# create directory to keep Git documentation html-files
$ sudo mkdir -p /usr/local/git/share/doc # or whatever directory you choose

# change to that directory
$ cd /usr/local/git/share/doc

# clone repo with documentation 
$ sudo git clone git://git.kernel.org/pub/scm/git/git-htmldocs.git git-doc 

# point your Git explicitly to a new documentation directory
$ git config --global help.htmlpath /usr/local/git/share/doc/git-doc

# tell Git to use html-formatted help by default
$ git config --global help.format html

这将在您的.gitconfig中创建一个条目,如:

[help]
    format = html
    htmlpath = /usr/local/git/share/doc/git-doc

答案 1 :(得分:0)

代码是(builtin/help.c):

static void get_html_page_path(struct strbuf *page_path, const char *page)
{
  struct stat st;
  const char *html_path = system_path(GIT_HTML_PATH);

  /* Check that we have a git documentation directory. */
  if (stat(mkpath("%s/git.html", html_path), &st)
      || !S_ISREG(st.st_mode))
    die("'%s': not a documentation directory.", html_path);

  strbuf_init(page_path, 0);
  strbuf_addf(page_path, "%s/%s.html", html_path, page);
}

因此GIT_HTML_PATH环境变量可能存在问题(如old issue中所述),或者您的目标帮助目录中没有任何git.html文件。