Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(1150)

Unified Diff: docs/src/git-map-branches.txt

Issue 200903002: Add documentation for git-map-branches, git-map, git-nav-downstream, (Closed) Base URL: https://chromium.googlesource.com/chromium/tools/depot_tools.git@documentation
Patch Set: rebase Created 6 years, 9 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « docs/src/git-map.txt ('k') | docs/src/git-nav-downstream.txt » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: docs/src/git-map-branches.txt
diff --git a/docs/src/git-map-branches.txt b/docs/src/git-map-branches.txt
new file mode 100644
index 0000000000000000000000000000000000000000..21bf0724f116114184c9bea7ba5e9308852513c2
--- /dev/null
+++ b/docs/src/git-map-branches.txt
@@ -0,0 +1,57 @@
+git-map-branches(1)
+===================
+
+NAME
+----
+git-map-branches -
+include::_git-map-branches_desc.helper.txt[]
+
+SYNOPSIS
+--------
+[verse]
+'git map-branches'
+
+DESCRIPTION
+-----------
+
+Git map-branches displays all local branches such that:
+
+* Current branch is [aqua]#cyan#.
+** The branch which will be modified with git-commit is denoted with an asterisk
+ (`*`) after the name.
+* Local branches are [green]#green#.
+* Remote branches are [red]#red# (usually, the root of all other branches).
+* `{NO UPSTREAM}` is a special placeholder in [fuchsia]#magenta#.
+** Branches which have this as their parent are usually misconfigured, and
+ should be assigned a parent by checking out the branch and running git branch
+ --set-upstream-to=<correct parent branch>.
+
+NOTE: If multiple branches are on the same commit, they will all be cyan.
+
+EXAMPLE
+-------
+
+Given the hypothetical demo repo in linkgit:git-map[1]\'s EXAMPLE section, and
+assuming that the `frozen_changes` branch was currently checked out, running
+'git map-branches' would result in an output like:
+
+[subs="quotes"]
+----
+[white]**$ git map-branches**
+[red]#origin/master#
+ [green]#cool_feature#
+ [green]#subfeature#
+ [aqua]#frozen_changes *#
+ [green]#master#
+[fuchsia]#{NO UPSTREAM}#
+ [green]#bogus_noparent#
+ [aqua]#duplicate_cool_feature_no_upstream#
+----
+
+SEE ALSO
+--------
+linkgit:git-map[1]
+
+include::_footer.txt[]
+
+// vim: ft=asciidoc noexpandtab:
« no previous file with comments | « docs/src/git-map.txt ('k') | docs/src/git-nav-downstream.txt » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698