Re: Custom subcommand help handlers

From: Erik Cervin Edin <erik@cervined.in>
Date: Dec 21, 2021, 09:12 UTC
Message-ID: <CA+JQ7M8ofJfnTGn+eFPhW4vL6xi0M7GU-=fvPG2knrvJppU9kQ@mail.gmail.com>
In-Reply-To: <xmqqa6guub9n.fsf@gitster.g>

> I should point out that in most cases on Unix, it _is_ expected that you
> install your manual pages into the same place as everyone else, so in
> this case, installing the HTML documentation alongside Git's may be the
> best solution.

I also think this sounds sensible A hurdle is that while Unix man pages are well established and I'm not aware of a standard or convention around HTML documentation.

On windows, you can install the HTML pages into /mingw64/share/doc/git-doc/ the problem is "git for windows" default installs in program files so admin rights are required.

You can supply a custom path for HTML pages git -c help.htmlPath=`realpath.exe ~/doc/git/html/` help git-filter-repo so an option is for user/admins to move/copy all the help documentation to a different path.

An idea is that if HTML documentation is not found at help.htmlPath to look for HTML documentation at the path of the command before failing I don't know if that's a good idea but it sounds simple

On Tue, Dec 21, 2021 at 12:06 AM Junio C Hamano <gitster@pobox.com> wrote:

Show 9 quoted lines

>
> "brian m. carlson" <sandals@crustytoothpaste.net> writes:
>
> > I should point out that in most cases on Unix, it _is_ expected that you
> > install your manual pages into the same place as everyone else, so in
> > this case, installing the HTML documentation alongside Git's may be the
> > best solution.
>
> Yup, that sounds like the most sensible way to do things.