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

Side by Side Diff: docs/src/git-map.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 unified diff | Download patch
« no previous file with comments | « docs/src/git-freeze.txt ('k') | docs/src/git-map-branches.txt » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
1 git-map(1)
2 ==========
3
4 NAME
5 ----
6 git-map -
7 include::_git-map_desc.helper.txt[]
8
9 SYNOPSIS
10 --------
11 [verse]
12 'git map' [<extra_args>...]
13
14 DESCRIPTION
15 -----------
16
17 Git map formats the output of `git log --graph` from all refs such that:
18
19 * Current branch is [aqua]#cyan#.
20 * Local branches are [green]#green#.
21 * Remote branches are [red]#red#.
22 * Tags are [fuchsia]#magenta#.
23 * The currently checked out commit is highlighted with a [yellow blue-background ]#blue background#.
24
25 The output is automatically piped through the `less` pager command, even on
26 windows.
27
28 OPTIONS
29 -------
30 <extra_args>...::
31 Extra parameters to pass to the internal linkgit:git-log[1] invocation. This
32 can be used to restrict what refs 'git map' operates on, etc.
33 +
34 If you run git map with a series of fixed arguments frequently, you can use
35 the depot_tools.map_extra configuration variable to pre-set arguments (See
36 `CONFIGURATION VARIABLES`)
37
38
39 CONFIGURATION VARIABLES
40 -----------------------
41
42 depot_tools.map_extra
43 ~~~~~~~~~~~~~~~~~~~~~
44
45 Each value of the 'depot_tools.map_extra' config variable is applied as an
46 additional argument to `git log` during the execution of git map. If you wish to
47 configure this, use git `config --add depot_tools.map_extra <value>` to do so.
48
49 EXAMPLE
50 -------
51
52 Running 'git map' would result in an output something like:
53
54 [subs="quotes,attributes"]
55 ----
56 [white]**$ git map**
57 [white blue-background]##*##{zwsp}[blue-background red]** 7dcfe47 ** [gree n]##(##{zwsp}[aqua]**frozen_changes**{zwsp}[green]##)## [yellow]##2014-03-12## \ ~ FREEZE.unindexed
58 * [red]**4b0c180** [yellow]##2014-03-12## \~ modfile
59 * [red]**59a7cca** [yellow]##2014-03-12## \~ a deleted file
60 * [red]**6bec695** [green]##(##{zwsp}[red]##origin/master##{zwsp}[green]# #)## [yellow]##2014-03-11## \~ Add neat feature
61 * [red]**d15a38a** [yellow]##2014-03-11## \~ Epic README update
62 * [red]**d559894** [green]##(##{zwsp}[lime]**master**{zwsp}[green]##)## [ yellow]##2014-03-11## \~ Important upstream change
63 [red]##|## * [red]**9c311fd** [green]##(##{zwsp}[lime]**cool_feature**{zwsp }[green]##)## [yellow]##2014-03-11## \~ Respond to CL comments
64 [red]##|## [green]##|## * [red]**2a1eeb2** [green]##(##{zwsp}[lime]**subfeatu re**{zwsp}[green]##)## [yellow]##2014-03-11## \~ integrate with CoolService
65 [red]##|## [green]##|## * [red]**d777af6** [yellow]##2014-03-11## \~ slick co mmenting action
66 [red]##|## [green]##|/##
67 [red]##|## * [red]**265803a** [yellow]##2014-03-11## \~ another improvement
68 [red]##|## * [red]**6d831ac** [green]##(##{zwsp}[fuchsia]**spleen_tag**{zws p}[green]##)## [yellow]##2014-03-11## \~ Refactor spleen
69 [red]##|## * [red]**82e74ab** [yellow]##2014-03-11## \~ Add widget
70 [red]##|/##
71 * [red]**d08c5b3** [green]##(##{zwsp}[lime]**bogus_noparent**{zwsp}[green ]##)## [yellow]##2014-03-11## ~ Wonderful beginnings
72 ----
73
74 As you can see, the structure of the commit history is visible, particularly
75 what the parents of each commit are. In order to see the 'upstream'
76 relationships of the branches (i.e. which branch is tracking which other
77 branch), use the linkgit:git-map-branches[1] command.
78
79 SEE ALSO
80 --------
81 linkgit:git-map-branches[1]
82
83 include::_footer.txt[]
84
85 // vim: ft=asciidoc noexpandtab:
OLDNEW
« no previous file with comments | « docs/src/git-freeze.txt ('k') | docs/src/git-map-branches.txt » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698