search

msysgit / git

msysGit-based Git for Windows 1.x is now superseded by Git for Windows 2.x
http://github.com/git-for-windows/git
Other
1.01k stars 316 forks source link

Documentation missing for subtree command #263

Closed agnel-kurian closed 9 years ago

agnel-kurian commented 10 years ago

git-subtree.html file is missing.

Error message displayed when invoking "git help subtree" is as below:

Launching default browser to display HTML ... fatal: failed to launch browser for C:\Program Files (x86)\Git/doc/git/html//git-subtree.html subtree-bug

dscho commented 10 years ago

Thank you for reporting. Would you mind digging a little deeper? You'll just need to install the development environment called msysGit and figure out whether git-subtree.html is in /doc/git/html/, whether it is copied correctly in /share/msysGit/WinGit/copy-files.sh, etc.

agnel-kurian commented 10 years ago

OK. I am trying, but the environment is taking a while to download and install.

kusma commented 10 years ago

git-subtree isn't a core part of git (it lives in the contrib-folder), and isn't a part of the normal build-process. We pick the HTML renderings of the documentation from Junio. Junio does not include git-subtree in his documentation-builds. However, we do build git-subtree (while making the installer, as we do with other contrib-features).

Ideally we'd build the documentation ourselves, and be able to get all the right docs. However, we don't have the tools required to do so at the moment. But with the new Git for Windows SDK, there might be more hope: https://github.com/git-for-windows/sdk

So I guess this is a long way of saying: patches welcome! ;)

On a side-note: it seems our documentation is stuck at Git 1.9.2 for some reason. But there's no git-subtree documentation upstream either.

t-b commented 10 years ago

@kusma In the git-for-windows project we already built the git documentation ourselves. IIRC this already inlcudes the subtree documentation See here.

On a side-note: it seems our documentation is stuck at Git 1.9.2 for some reason. But there's no git-subtree documentation upstream either.

v1.9.2-468-g3f0c0 was the latest release, everything after that was for git 2.x.

kusma commented 10 years ago

@t-b: Perfect!

@agnel-kurian: OK, so a fix for this will come when migration to the new sdk is done.

agnel-kurian commented 10 years ago

@kusma OK. Thanks.

sschuberth commented 10 years ago

IIRC this already inlcudes the subtree documentation.

No, it does not. As building the Git docs does not automatically build the docs from contrib, we still need to do this manually. I'll try to find the time to work on this soon.