Skip to content

Conversation

@arxanas
Copy link
Owner

@arxanas arxanas commented Mar 6, 2023

Closes #828.

Copy link
Contributor

@alerque alerque left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this looks fine. As I understand it there will be a new dedicated subcommand to generate man pages, with an optional argument for where to place the generated file(s). That should work for distro packaging purposes.

A couple comments I wasn't clear on from skimming the PR:

  • Will the existing init subcommand still try to install man pages locally? I would suggest it not do that by default.
  • Will the man page install subcommand be hidden from --help? I typically suggest it my a hidden subcommand, but document it in the project readme or install instructions so distro folks in particular catch it but it doesn't clutter up usage info for end users that may not have access to the root system anyway and shouldn't be stuffing stuff there behind their package manager's back unless they know what they are doing.

arxanas added 2 commits March 9, 2023 19:42
This is primarily intended for package managers to generate and install man-pages, but it could also be used by individuals who installed from source.
@arxanas arxanas marked this pull request as ready for review March 10, 2023 03:44
@arxanas
Copy link
Owner Author

arxanas commented Mar 10, 2023

Will the existing init subcommand still try to install man pages locally? I would suggest it not do that by default.

No, it currently doesn't install man pages at all (and it still won't).

Will the man page install subcommand be hidden from --help? I typically suggest it my a hidden subcommand, but document it in the project readme or install instructions so distro folks in particular catch it but it doesn't clutter up usage info for end users that may not have access to the root system anyway and shouldn't be stuffing stuff there behind their package manager's back unless they know what they are doing.

The majority of git-branchless users install from source and won't have any way to install man pages (which breaks git <command> -h, see #88 (comment)), so I think I'll leave it as visible in case someone does want to install man pages on their own (at their own risk).

@arxanas arxanas enabled auto-merge (rebase) March 10, 2023 03:48
@arxanas arxanas linked an issue Mar 10, 2023 that may be closed by this pull request
@arxanas arxanas merged commit e516448 into master Mar 10, 2023
@arxanas arxanas deleted the arxanas/init branch March 10, 2023 03:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

No obvious way to generate man pages

3 participants