public inbox for git@vger.kernel.org
 help / color / mirror / Atom feed
From: kristofferhaugsbakk@fastmail.com
To: git@vger.kernel.org
Cc: Kristoffer Haugsbakk <code@khaugsbakk.name>
Subject: [PATCH] doc: provide clone commands for the pre-built docs
Date: Fri, 13 Jun 2025 18:47:04 +0200	[thread overview]
Message-ID: <45581cb36fbcc33992cae5b740bb801e2724aa90.1749833159.git.code@khaugsbakk.name> (raw)

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


             reply	other threads:[~2025-06-13 16:47 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-06-13 16:47 kristofferhaugsbakk [this message]
2025-06-14  4:05 ` [PATCH] doc: provide clone commands for the pre-built docs Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=45581cb36fbcc33992cae5b740bb801e2724aa90.1749833159.git.code@khaugsbakk.name \
    --to=kristofferhaugsbakk@fastmail.com \
    --cc=code@khaugsbakk.name \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox