#688832 git-flow: no command-line documentation

Package:
git-flow
Source:
git-flow
Submitter:
Ryo IGARASHI
Date:
2021-04-19 19:45:03 UTC
Severity:
wishlist
Tags:
#688832#5
Date:
2012-09-26 01:56:59 UTC
From:
To:
Dear Maintainer,

I found from the command line that git-flow do not have document.
Usually, git subcommands have manual which can be accessed by
$ git XXX --help
but git-flow seems not to have this kind of manual.

I heavilly use command-line help, so it would be nice if you add
this kind of manual to this command.

Best regards,
- --
Ryo IGARASHI, Ph.D.
rigarash@gmail.com


- -- System Information:
Debian Release: wheezy/sid
  APT prefers stable-updates
  APT policy: (500, 'stable-updates'), (500, 'unstable'), (500, 'testing'), (500, 'stable'), (1, 'experimental')
Architecture: amd64 (x86_64)

Kernel: Linux 3.2.0-3-amd64 (SMP w/3 CPU cores)
Locale: LANG=ja_JP.UTF-8, LC_CTYPE=ja_JP.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash

Versions of packages git-flow depends on:
ii  git [git-core]  1:1.7.10.4-1

git-flow recommends no packages.

git-flow suggests no packages.

- -- no debconf information
iQIcBAEBCgAGBQJQYmDkAAoJEOx5ooBqGSMZbjQP/3jQErg1G6DiHmd+LjThmoE4
a531ri6DeC3AVleHFR4yx8yc1BklxT0p/HprKMOhOqd4xRxI77myxx82y9kB27cz
HncTBMtFft4qBJH9Es+FbZ/uEQTQPcCBAi/xeZbYtF4aIcgL9ZvgkGKFShrXnlcy
ldVvIkfZakcVSn9jx7IW9EDcZ4ySkcEUYj+Q0zyxDBTLLEDAbhRI2hN2ToQ+mRSR
HnpbYL1ZtiRppHUB8Fhg+tijRbnyOpauzuSVJloPEjLwhRWwaJLv0i0jTFWuFGtu
r0qnnovmpxvMkCfjdVI9KEAzNQdQP1lB1y6Cq6v+v4AvHmbbPr+32vj5cogU0YS5
tAzZMYtE/iDF7oN1Gk/8JDLpo1U166ca+FsgdpdeadrdemKWnxbFWtaMdufKCYv6
JDC4EXhd18sGHTa4dDPFP8Ei0Wr1rzjj8cw9FZYi4q4PgwaA2angsaUhSvCALcgb
BP949QDAiAwkKz5rvEuTMlbdgdU3Qot08ab2EACkR3e7Zp3V3AURfjXFSP5HV1vb
1UIFqBAUE0pbBBZpri6EZy6o6n+RNaP1Ckoa9B1He0T0XVAmfumx9KeRGOWTWgqA
1lV9fAU4dw6w1rjaXs/f7CAB1MNE5N0QdMERBThu25z9SCAaQNs3F2HmkmkJfnyQ
RdpUFjHzj+WeYT5femPz
=5U1o
-----END PGP SIGNATURE-----

#688832#10
Date:
2012-12-21 16:40:53 UTC
From:
To:
The convention with git commands is that you should be able to get
documentation with either:

	git help flow

or

	man git-flow

I'd say this bug should be closed when both of those work.


Workaround: the following command provides partial documentation on
how to call git-flow:

	git flow help

This will list what commandline flags are allowed, but not what
they do.

I've found the documentation I was looking for here:

https://github.com/nvie/gitflow/wiki/Command-Line-Arguments

That looks to me like what should be in the man page.

I hope this is helpful.

Thank you.

#688832#15
Date:
2014-10-15 19:12:02 UTC
From:
To:
Hi,

Actually both suggestions don't work for me:

  % man git-flow
  No manual entry for git-flow

  % git help flow
  No manual entry for git-flow
  See 'man 7 undocumented' for help when manual pages are not available.

Since recent versions "git flow" without arguments does provide
help information (same as "git flow help).

What I find inconsistent is that all commands support -h/--help, except
for the main command:

  % git flow init --help
  usage: git flow init [-h] [-d] [-f]

      Setup a git repository for git flow usage. Can also be used to
      start a git repository.

  % git flow --help
  paul@entropy% git flow --help
  No manual entry for git-flow
  See 'man 7 undocumented' for help when manual pages are not available.

Compare with:

  % git rebase --help
  [I get the manual page]

Maybe the man page is just not installed/generated (correctly)?

Cheers,

Paul

#688832#20
Date:
2021-04-19 19:17:11 UTC
From:
To:
I also face this problem because I use git flow everyday via the command-line, the lack of a manpage makes it harder to use and I always have to lookup on the internet for cheatsheets when I want to use it.

I would like to contribute by writing a manpage for it, can anyone point me to a github repository? Also I am not sure where to contribute.

#688832#25
Date:
2021-04-19 19:41:21 UTC
From:
To:
Control: tags -1 +upstream
 Upstream home and reference list for commands is on GitHub wiki[1].
 $search_engine works quite well, but for reference the actual GitHub
repository[2] is there.

Regards,
Laszlo/GCS
[1] https://github.com/petervanderdoes/gitflow-avh/wiki
[2] https://github.com/petervanderdoes/gitflow-avh