Let's document! Git edition

[sbrl]

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 (139 ❗). Let's document them all!

• add (split git commands #159)
• am (git am: add page #2352)
• annotate (git-annotate: add page #5096)
• apply (git-apply: add page #4252)
• archimport - this is for importing projects that use the GNU Arch SCM, which is deprecated in favor of GNU Bazaar...should we still add this page?
• archive (git-archive: add page #4362)
• bisect (git-bisect: add page #1227)
• blame (git-blame: add page #366)
• branch (split git commands #159)
• bugreport (git-bugreport: add page #5097)
• bundle (git-bundle: add page #4364)
• cat-file (git-cat-file: add page #4492)
• check-attr (git-check-attr: add page #5098)
• check-ignore (git-check-ignore: add page #3113)
• check-mailmap (git-check-mailmap: add page #5099)
• check-ref-format (git-check-ref-format: add page #5100)
• checkout (split git commands #159)
• checkout-index (git-checkout-index: add page #5107)
• cherry (git-cherry: add page #4473)
• cherry-pick (git-cherry-pick: add page #1196)
• clean (git-clean: add page #1157)
• clone (split git commands #159)
• column (git-column: add page #5108)
• commit (split git commands #159)
• commit-graph (git-commit-graph: add page #5109)
• commit-tree (git-commit-tree: add page #5113)
• config (git-config: add page #363)
• count-objects (git-count-objects: add page #5114)
• credential (git-credential: add page #5115)
• credential-cache - you're not actually supposed to invoke this one, the synopsis is git config credential.helper 'cache [<options>]', see the docs
• credential-store - same here
• cvsexportcommit
• cvsimport
• cvsserver
• daemon (git-daemon: add page #5938)
• describe (git-describe: add page #4413)
• diff (split git commands #159)
• diff-files (git-diff-files: add page #6896)
• diff-index (git-diff-index, git-diff-tree: add page #11234)
• diff-tree (git-diff-index, git-diff-tree: add page #11234)
• difftool (git-difftool: add page #4127)
• fast-export
• fast-import
• fetch (git-rebase, git-fetch: add pages #473)
• fetch-pack
• filter-branch
• fmt-merge-msg
• for-each-ref
• for-each-repo (git-for-each-repo: add page #5490)
• format-patch (git format patch: add page #2351)
• fsck (git fsck: add page #3954)
• gc (git-gc: add page #1741)
• get-tar-commit-id
• gitweb
• grep (git grep: add page #2833)
• gui (git-gui: add page #12258)
• hash-object (git-hash-object: add page #9060)
• help (git-help: add page #4019)
• http-backend
• imap-send
• index-pack
• init (split git commands #159)
• instaweb (git-instaweb: add page #4017)
• interpret-trailers
• log (split git commands #159)
• ls-files (split git commands #159)
• ls-remote (git-ls-remote: add page #4538)
• ls-tree (git-ls-tree, git-rev-list, git-rev-parse: add pages #3644)
• mailinfo (git-mailinfo: add page #5939)
• mailsplit
• maintenance (git-maintenance: add page #5463)
• merge (split git commands #159)
• merge-base(git-merge-base: add page #9382)
• merge-file(git-merge-file: add page #14928)
• merge-index
• merge-one-file
• merge-tree
• mergetool (git-mergetool: add page #3947)
• mktag
• mktree (git-mktree: add page #11725)
• multi-pack-index
• mv (git-mv: add page #364)
• name-rev
• notes (git notes: add page #4042)
• p4
• pack-objects
• pack-redundant
• pack-refs
• patch-id
• prune (git-prune: add page #4696)
• prune-packed
• pull (git-pull: add page #368)
• push (split git commands #159)
• quiltimport
• range-diff (git-range-diff: add page #5701)
• read-tree
• rebase (git-rebase, git-fetch: add pages #473)
• reflog (git reflog: add page #2042)
• remote (git remote: add page #274)
• repack (git-repack: add page #4018)
• replace (git-replace, w: add pages #4496)
• request-pull (git-request-pull: add page #4241)
• rerere
• reset (git-reset: add page #1088)
• restore (git-restore: add page #3247)
• rev-list (git-ls-tree, git-rev-list, git-rev-parse: add pages #3644)
• rev-parse (git-ls-tree, git-rev-list, git-rev-parse: add pages #3644)
• revert (git-revert: add page #3151)
• rm (git-rm: add page #365)
• send-email (git-send-email: add page #4265)
• send-pack
• sh-i18n
• sh-setup
• shortlog (git-shortlog: add page #2044)
• show (git-show: add page #1331)
• show-branch (git-show-branch: add page #4016)
• show-index (git-show-index: add page #5940)
• show-ref (git-show-ref: add page #4426)
• sparse-checkout
• stash (891310f)
• status (split git commands #159)
• stripspace (git-stripspace: add page #5094)
• submodule (git-submodule: add page #837)
• svn (git-svn: add page #591)
• switch (git-switch: add page #3246)
• symbolic-ref (git-symbolic-ref: add page #6938)
• tag (git-tag: add page; git-push: add example of pushing tags #367)
• unpack-file(git-unpack-file: add page #9168)
• unpack-objects
• update-index (git-update-index: add page #3911)
• update-ref (git-update-ref: add page #4373)
• update-server-info
• var (git-var: add page #5095)
• verify-commit (git-verify-commit: add page #5946)
• verify-pack
• verify-tag (git-verify-tag: add page #6139)
• whatchanged (git-whatchanged: add page #5935)
• worktree (git-worktree.md: add page #1232)
• write-tree (git-write-tree: add page #11584)

[ivanhercaz]

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

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

[sbrl]

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

[jn64]

These don't seem necessary:

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

2. whatchanged: From git-whatchanged(1):

   New users are encouraged to use git-log(1) instead. [...] The command is kept primarily for historical reasons

3. 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.

[sbrl]

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.

[CleanMachine1]

Regardless of git-whatchanged being unrequired, I am going to add it since I use it. Where should I submit my work/commits

[CleanMachine1]

You can tick whatchanged off!

[kbdharun]

How is this issue closed if all the pages weren't added?

[WangLinSongss]

gitweb points to a broken link, I believe it should point to https://git-scm.com/docs/gitweb

There is already a page for the hub command, but hub has many subcommands, as suggested by @sebastiaanspeck, I created #11156 to document them.

[sebastiaanspeck]

Maybe create a new issue for it to keep this issue clean