Tldr: Let's document! git edition

Created on 30 Mar 2020 · 6Comments · Source: tldr-pages/tldr

For those not in the know, tldr-pages is about more than just commands. Those commands that are too expansive to fit on 1 page often have multiple subcommands - which we can document on their own pages. For example, try these:

tldr git merge
tldr git add
tldr ip address

In the case of git, it has quite a number of subcommands. Let's document them all!

[x] git am
[x] git apply
[x] git archive
[x] git bundle
[x] git cherry
[x] git describe
[x] git difftool
[x] git fsck
[x] git help
[x] git ignore
[x] git instaweb
[x] git mergetool
[x] git notes
[ ] git range-diff
[x] git repack
[x] git replace
[x] git request-pull
[x] git send-email
[x] git show-branch
[x] git stage
~~git whatchanged~~

help wanted new command

Source

sbrl

❤6

Most helpful comment

Not sure if git-gitk is needed, as it's really just linking to gitk, which exists.

Also, the last four items (replace, request-pull, send-email, show-branch) are listed twice.

Amorymeltzer on 4 Oct 2020

👍2

All 6 comments

I really the "Let's document them all!".

Just one question, are translations also included in this "challenge"? 🙈🤗

ivanhercaz on 13 May 2020

🎉2

Lol, if you'd like to join in and translate them, that'd be great @ivanhercaz! I only know English though, so I can't really participate in the translations department :P

sbrl on 13 May 2020

These don't seem necessary:

citool: citool is a default alias to gui citool which starts git-gui in a particular mode. That's literally it.
whatchanged: From git-whatchanged(1):

New users are encouraged to use git-log(1) instead. [...] The command is kept primarily for historical reasons
request-pull has one specific usage, which is explained in the very short man page.

Also remote-keybase is not part of git, you may have it from a third party.

jn64 on 7 Jun 2020

Thanks, @jn64 - I'll update the list. I just took all the subcommands from the bash autocompletion list - -I haven't yet had time to check them all :P

whatchanged: agreed - this doesn't seem necessary.
request-pull: It might be short, but regular commands such as arch and nproc still have tldr pages, so I think this is fine.
citool: Hrm - my machine doesn't seem to even have that alias anymore. Either way, I think it's best to avoid documenting aliases if possible and stick to the canonical names unless there's a good reason.