Git development
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: John Wilson <jwilso3@ed.ac.uk>
Cc: "git@vger.kernel.org" <git@vger.kernel.org>
Subject: Re: git help user-manual looks for incorrect filename
Date: Thu, 15 Oct 2026 11:20:59 -0700	[thread overview]
Message-ID: <xmqqzewen7uc.fsf@gitster.g> (raw)
In-Reply-To: <VI0PR05MB12991467F7BD29308AE8D5F4ED09C2@VI0PR05MB12991.eurprd05.prod.outlook.com> (John Wilson's message of "Thu, 15 Oct 2026 07:17:03 +0000")

John Wilson <jwilso3@ed.ac.uk> writes:

> Hi,
>
> I would like to raise this issue, as suggested when I erroneously
> posted on the git-for-windows repo
> (https://github.com/git-for-windows/git/issues/6466)
>
> ## Issue
>
> On Git for Windows git help user-manual looks for the wrong file.
> Git looks for gituser-manual.html, instead of user-manual.html.
>
> The Git User's Manual is installed as:
> `C:\Program Files\Git\mingw64\share\doc\git-doc\user-manual.html`
>
> However, git help user-manual fails with: `fatal: 'C:/Program
> Files/Git/mingw64/share/doc/git-doc/gituser-manual.html':
> documentation file not found.`

Thanks for reporting.  I can see that this is not GfW specific.

    $ git help --guides
    The Git concept guides are:
       core-tutorial    A Git core tutorial for developers
       credentials      Providing usernames and passwords to Git
       cvs-migration    Git for CVS users
       datamodel        Git's core data model
       diffcore         Tweaking diff output
       everyday         A useful minimum set of commands for Everyday Git
       faq              Frequently asked questions about using Git
       glossary         A Git Glossary
       namespaces       Git namespaces
       remote-helpers   Helper programs to interact with remote repositories
       submodules       Mounting one repository inside another
       tutorial         A tutorial introduction to Git
       tutorial-2       A tutorial introduction to Git: part two
       workflows        An overview of recommended workflows with Git

    'git help -a' and 'git help -g' list available subcommands and some
    concept guides. See 'git help <command>' or 'git help <concept>'
    to read about a specific subcommand or concept.
    See 'git help git' for an overview of the system.

Any of the documents that are listed above can be seen correctly

    $ git help -w everyday

But user-manual is not even listed among the above.

A few things probably needs to happen.

 * user-manual and any other "missing" documents need to be
   identified and added to the above list of --guides.

 * any of these "missing" documents are not installed with "git"
   prefix (e.g., "user-manual" becomes "gituser-manual"), their
   install path may need to be adjusted.  The old paths for them
   may also need to be retained if users have been accessing them
   via the old pathnames.



      parent reply	other threads:[~2026-10-15 18:21 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-10-15  7:17 git help user-manual looks for incorrect filename John Wilson
2026-10-15 16:58 ` D. Ben Knoble
2026-10-15 18:20 ` Junio C Hamano [this message]

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=xmqqzewen7uc.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=jwilso3@ed.ac.uk \
    /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