[PATCH] doc: provide clone commands for the pre-built docs

[PATCH] doc: provide clone commands for the pre-built docs

[kristofferhaugsbakk]

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

These repositories need to have these specific names.  You could end
up cloning the “git” organization htmldocs repository[1] which is named
“htmldocs”.  So you would need to provide `git-htmldocs` as the second
argument.  But it’s easier to clone the GitHub “gitster” user
repositories since they have the expected names.

The aforementioned “git” repository also uses `gh-pages` instead of
`master`.  Which means that the `quick-install-html` target will fail
since it expects `master` (`GIT_MAN_REF`).

[1]: https://github.com/git/htmldocs

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---

Notes (series):
    Spaces used for indentation here inside the comment.  I don’t know if
    that is correct.

 Documentation/Makefile | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/Documentation/Makefile b/Documentation/Makefile
index b109d25e9c8..0493a38684f 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -439,6 +439,11 @@ install-webdoc : html
 
 # You must have a clone of 'git-htmldocs' and 'git-manpages' repositories
 # next to the 'git' repository itself for the following to work.
+#
+#     # From this directory
+#     cd ../..
+#     git clone https://github.com/gitster/git-htmldocs/
+#     git clone https://github.com/gitster/git-manpages/
 
 quick-install: quick-install-man
 

base-commit: b07857f7dcffee4d3b428df8dce6c9b49a57c9c1
-- 
kh/v2.50.0-rc2

Re: [PATCH] doc: provide clone commands for the pre-built docs

[Junio C Hamano]

kristofferhaugsbakk@fastmail.com writes:

> From: Kristoffer Haugsbakk <code@khaugsbakk.name>
>
> These repositories need to have these specific names.  You could end
> up cloning the “git” organization htmldocs repository[1] which is named
> “htmldocs”.  So you would need to provide `git-htmldocs` as the second
> argument.  But it’s easier to clone the GitHub “gitster” user
> repositories since they have the expected names.

I'd rather not see people do that.