tools/patman/gitutil.py

3 # SPDX-License-Identifier:	GPL-2.0+
17 # True to use --no-decorate - we check this in Setup()
27         oneline: True to use --oneline, else False
28         reverse: True to reverse the log (--reverse)
35         cmd += ['--git-dir', git_dir]
36     cmd += ['--no-pager', 'log', '--no-color']
38         cmd.append('--oneline')
40         cmd.append('--no-decorate')
42         cmd.append('--reverse')
44         cmd.append('-n%d' % count)
48     # Add this in case we have a branch with the same name as a directory.
51     cmd.append('--')
64             ['wc', '-l']]
70     """Gets the revision name for a commit
76         Name of revision, if any, else None
78     pipe = ['git', 'name-rev', commit_hash]
81     # We expect a commit, a space, then a revision name
82     name = stdout.split(' ')[1].strip()
83     return name
90     'git name-rev' returns a plain branch name, with no ! or ^ modifiers.
93         git_dir: Git directory containing repo
94         branch: Name of branch
98             Name of upstream branch (e.g. 'upstream/master') or None if none
108         name = NameRevision(commit_hash)
109         if '~' not in name and '^' not in name:
110             if name.startswith('remotes/'):
111                 name = name[8:]
112             return name, "Guessing upstream as '%s'" % name
116     """Returns the name of the upstream for a branch
119         git_dir: Git directory containing repo
120         branch: Name of branch
124             Name of upstream branch (e.g. 'upstream/master') or None if none
128         remote = command.OutputOneLine('git', '--git-dir', git_dir, 'config',
130         merge = command.OutputOneLine('git', '--git-dir', git_dir, 'config',
139         leaf = merge.split('/')[-1]
150         git_dir: Directory containing git repo
151         branch: Name of branch
166         git_dir: Directory containing git repo
184         git_dir: Directory containing git repo
185         branch: Name of branch
204             ['wc', '-l']]
217         pipe.extend(['--git-dir', git_dir])
219         pipe.extend(['--work-tree', work_tree])
222         pipe.append('-f')
242     """Fetch from the origin repo
249         pipe.extend(['--git-dir', git_dir])
251         pipe.extend(['--work-tree', work_tree])
261     git format-patch.
272     cmd = ['git', 'format-patch', '-M', '--signoff']
274         cmd.append('--cover-letter')
277         cmd += ['--subject-prefix=%s' % prefix]
317     >>> BuildEmailList(['john', 'mary'], '--to', alias)
318     ['--to "j.bloggs@napier.co.nz"', \
319 '--to "Mary Poppins <m.poppins@cloud.net>"']
323     quote = '"' if tag and tag[0] == '-' else ''
346         cc_fname: Filename of Cc file for per-commit Cc
348         in_reply_to: If set we'll pass this to git as --in-reply-to.
350         thread: True to add --thread to git send-email (make
351             all patches reply to cover-letter or first patch in series)
366     >>> alias[os.getenv('USER')] = ['this-is-me@me.com']
370     >>> EmailPatches(series, 'cover', ['p1', 'p2'], True, True, 'cc-fname', \
372     'git send-email --annotate --to "f.bloggs@napier.co.nz" --cc \
373 "m.poppins@cloud.net" --cc-cmd "./patman --cc-cmd cc-fname" cover p1 p2'
374     >>> EmailPatches(series, None, ['p1'], True, True, 'cc-fname', False, \
376     'git send-email --annotate --to "f.bloggs@napier.co.nz" --cc \
377 "m.poppins@cloud.net" --cc-cmd "./patman --cc-cmd cc-fname" p1'
379     >>> EmailPatches(series, 'cover', ['p1', 'p2'], True, True, 'cc-fname', \
381     'git send-email --annotate --to "this-is-me@me.com" --cc-cmd "./patman \
382 --cc-cmd cc-fname" cover p1 p2'
383     >>> EmailPatches(series, 'cover', ['p1', 'p2'], True, True, 'cc-fname', \
385     'git send-email --annotate --to "f.bloggs@napier.co.nz" --cc \
386 "f.bloggs@napier.co.nz" --cc "j.bloggs@napier.co.nz" --cc \
387 "m.poppins@cloud.net" --cc-cmd "./patman --cc-cmd cc-fname" cover p1 p2'
392     to = BuildEmailList(series.get('to'), '--to', alias, raise_on_error)
399                    "Series-to: Fred Bloggs <f.blogs@napier.co.nz>\n"
401                    "git config sendemail.to u-boot@lists.denx.de")
403     cc = BuildEmailList(list(set(series.get('cc')) - set(series.get('to'))),
404                         '--cc', alias, raise_on_error)
406         to = BuildEmailList([os.getenv('USER')], '--to', alias, raise_on_error)
408     cmd = ['git', 'send-email', '--annotate']
411             in_reply_to = in_reply_to.encode('utf-8')
412         cmd.append('--in-reply-to="%s"' % in_reply_to)
414         cmd.append('--thread')
418     cmd += ['--cc-cmd', '"%s --cc-cmd %s"' % (sys.argv[0], cc_fname)]
429     """If an email address is an alias, look it up and return the full name
517     """Return name of top-level directory for this git repo.
520         Full path to git top-level directory
528     return command.OutputOneLine('git', 'rev-parse', '--show-toplevel')
531     """Gets the name of the git alias file.
543     """Gets the user.name from .gitconfig file.
546         User name found in .gitconfig file, or None if none
548     uname = command.OutputOneLine('git', 'config', '--global', 'user.name')
557     uemail = command.OutputOneLine('git', 'config', '--global', 'user.email')
589     return command.OutputOneLine('git', 'show', '-s', '--pretty=format:%H')