Index: docs/src/git-map.txt |
diff --git a/docs/src/git-map.txt b/docs/src/git-map.txt |
new file mode 100644 |
index 0000000000000000000000000000000000000000..8b22f3a19041201342e17b04b3f0fea59b8e0c0f |
--- /dev/null |
+++ b/docs/src/git-map.txt |
@@ -0,0 +1,85 @@ |
+git-map(1) |
+========== |
+ |
+NAME |
+---- |
+git-map - |
+include::_git-map_desc.helper.txt[] |
+ |
+SYNOPSIS |
+-------- |
+[verse] |
+'git map' [<extra_args>...] |
+ |
+DESCRIPTION |
+----------- |
+ |
+Git map formats the output of `git log --graph` from all refs such that: |
+ |
+* Current branch is [aqua]#cyan#. |
+* Local branches are [green]#green#. |
+* Remote branches are [red]#red#. |
+* Tags are [fuchsia]#magenta#. |
+* The currently checked out commit is highlighted with a [yellow blue-background]#blue background#. |
+ |
+The output is automatically piped through the `less` pager command, even on |
+windows. |
+ |
+OPTIONS |
+------- |
+<extra_args>...:: |
+ Extra parameters to pass to the internal linkgit:git-log[1] invocation. This |
+ can be used to restrict what refs 'git map' operates on, etc. |
++ |
+If you run git map with a series of fixed arguments frequently, you can use |
+the depot_tools.map_extra configuration variable to pre-set arguments (See |
+`CONFIGURATION VARIABLES`) |
+ |
+ |
+CONFIGURATION VARIABLES |
+----------------------- |
+ |
+depot_tools.map_extra |
+~~~~~~~~~~~~~~~~~~~~~ |
+ |
+Each value of the 'depot_tools.map_extra' config variable is applied as an |
+additional argument to `git log` during the execution of git map. If you wish to |
+configure this, use git `config --add depot_tools.map_extra <value>` to do so. |
+ |
+EXAMPLE |
+------- |
+ |
+Running 'git map' would result in an output something like: |
+ |
+[subs="quotes,attributes"] |
+---- |
+[white]**$ git map** |
+[white blue-background]##*##{zwsp}[blue-background red]** 7dcfe47 ** [green]##(##{zwsp}[aqua]**frozen_changes**{zwsp}[green]##)## [yellow]##2014-03-12## \~ FREEZE.unindexed |
+* [red]**4b0c180** [yellow]##2014-03-12## \~ modfile |
+* [red]**59a7cca** [yellow]##2014-03-12## \~ a deleted file |
+* [red]**6bec695** [green]##(##{zwsp}[red]##origin/master##{zwsp}[green]##)## [yellow]##2014-03-11## \~ Add neat feature |
+* [red]**d15a38a** [yellow]##2014-03-11## \~ Epic README update |
+* [red]**d559894** [green]##(##{zwsp}[lime]**master**{zwsp}[green]##)## [yellow]##2014-03-11## \~ Important upstream change |
+[red]##|## * [red]**9c311fd** [green]##(##{zwsp}[lime]**cool_feature**{zwsp}[green]##)## [yellow]##2014-03-11## \~ Respond to CL comments |
+[red]##|## [green]##|## * [red]**2a1eeb2** [green]##(##{zwsp}[lime]**subfeature**{zwsp}[green]##)## [yellow]##2014-03-11## \~ integrate with CoolService |
+[red]##|## [green]##|## * [red]**d777af6** [yellow]##2014-03-11## \~ slick commenting action |
+[red]##|## [green]##|/## |
+[red]##|## * [red]**265803a** [yellow]##2014-03-11## \~ another improvement |
+[red]##|## * [red]**6d831ac** [green]##(##{zwsp}[fuchsia]**spleen_tag**{zwsp}[green]##)## [yellow]##2014-03-11## \~ Refactor spleen |
+[red]##|## * [red]**82e74ab** [yellow]##2014-03-11## \~ Add widget |
+[red]##|/## |
+* [red]**d08c5b3** [green]##(##{zwsp}[lime]**bogus_noparent**{zwsp}[green]##)## [yellow]##2014-03-11## ~ Wonderful beginnings |
+---- |
+ |
+As you can see, the structure of the commit history is visible, particularly |
+what the parents of each commit are. In order to see the 'upstream' |
+relationships of the branches (i.e. which branch is tracking which other |
+branch), use the linkgit:git-map-branches[1] command. |
+ |
+SEE ALSO |
+-------- |
+linkgit:git-map-branches[1] |
+ |
+include::_footer.txt[] |
+ |
+// vim: ft=asciidoc noexpandtab: |