Commit a1dcee84 authored by Doug Anderson's avatar Doug Anderson Committed by Simon Glass

patman: Add the concept of multiple projects

There are cases that we want to support different settings (or maybe
even different aliases) for different projects.  Add support for this
* Adding detection for two big projects: U-Boot and Linux.
* Adding default settings for Linux (U-Boot is already good with the
  standard patman defaults).
* Extend the new "settings" feature in .patman to specify per-project
Signed-off-by: default avatarDoug Anderson <>
Acked-by: default avatarSimon Glass <>
parent 8568baed
......@@ -114,6 +114,19 @@ verbose: True
If you want to adjust settings (or aliases) that affect just a single
project you can add a section that looks like [project_settings] or
[project_alias]. If you want to use tags for your linux work, you could
process_tags: True
How to run it
......@@ -34,6 +34,7 @@ import checkpatch
import command
import gitutil
import patchstream
import project
import settings
import terminal
import test
......@@ -59,6 +60,9 @@ parser.add_option('--cc-cmd', dest='cc_cmd', type='string', action='store',
default=None, help='Output cc list for patch file (used by git)')
parser.add_option('--no-tags', action='store_false', dest='process_tags',
default=True, help="Don't process subject tags as aliaes")
parser.add_option('-p', '--project', default=project.DetectProject(),
help="Project name; affects default option values and "
"aliases [default: %default]")
parser.usage = """patman [options]
......@@ -66,7 +70,10 @@ Create patches from commits in a branch, check them and email them as
specified by tags you place in the commits. Use -n to """
settings.Setup(parser, '')
# Parse options twice: first to get the project and second to handle
# defaults properly (which depends on project).
(options, args) = parser.parse_args()
settings.Setup(parser, options.project, '')
(options, args) = parser.parse_args()
# Run our meagre tests
# Copyright (c) 2012 The Chromium OS Authors.
# See file CREDITS for list of people who contributed to this
# project.
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation; either version 2 of
# the License, or (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
# MA 02111-1307 USA
import os.path
import gitutil
def DetectProject():
"""Autodetect the name of the current project.
This looks for signature files/directories that are unlikely to exist except
in the given project.
The name of the project, like "linux" or "u-boot". Returns "unknown"
if we can't detect the project.
top_level = gitutil.GetTopLevel()
if os.path.exists(os.path.join(top_level, "include", "u-boot")):
return "u-boot"
elif os.path.exists(os.path.join(top_level, "kernel")):
return "linux"
return "unknown"
......@@ -26,6 +26,140 @@ import re
import command
import gitutil
"""Default settings per-project.
These are used by _ProjectConfigParser. Settings names should match
the "dest" of the option parser from
_default_settings = {
"u-boot": {},
"linux": {
"process_tags": "False",
class _ProjectConfigParser(ConfigParser.SafeConfigParser):
"""ConfigParser that handles projects.
There are two main goals of this class:
- Load project-specific default settings.
- Merge general default settings/aliases with project-specific ones.
# Sample config used for tests below...
>>> import StringIO
>>> sample_config = '''
... [alias]
... me: Peter P. <>
... enemies: Evil <>
... [sm_alias]
... enemies: Green G. <>
... [sm2_alias]
... enemies: Doc O. <>
... [settings]
... am_hero: True
... '''
# Check to make sure that bogus project gets general alias.
>>> config = _ProjectConfigParser("zzz")
>>> config.readfp(StringIO.StringIO(sample_config))
>>> config.get("alias", "enemies")
'Evil <>'
# Check to make sure that alias gets overridden by project.
>>> config = _ProjectConfigParser("sm")
>>> config.readfp(StringIO.StringIO(sample_config))
>>> config.get("alias", "enemies")
'Green G. <>'
# Check to make sure that settings get merged with project.
>>> config = _ProjectConfigParser("linux")
>>> config.readfp(StringIO.StringIO(sample_config))
>>> sorted(config.items("settings"))
[('am_hero', 'True'), ('process_tags', 'False')]
# Check to make sure that settings works with unknown project.
>>> config = _ProjectConfigParser("unknown")
>>> config.readfp(StringIO.StringIO(sample_config))
>>> sorted(config.items("settings"))
[('am_hero', 'True')]
def __init__(self, project_name):
"""Construct _ProjectConfigParser.
In addition to standard SafeConfigParser initialization, this also loads
project defaults.
project_name: The name of the project.
self._project_name = project_name
# Update the project settings in the config based on
# the _default_settings global.
project_settings = "%s_settings" % project_name
if not self.has_section(project_settings):
project_defaults = _default_settings.get(project_name, {})
for setting_name, setting_value in project_defaults.iteritems():
self.set(project_settings, setting_name, setting_value)
def get(self, section, option, *args, **kwargs):
"""Extend SafeConfigParser to try project_section before section.
See SafeConfigParser.
See SafeConfigParser.
return ConfigParser.SafeConfigParser.get(
self, "%s_%s" % (self._project_name, section), option,
*args, **kwargs
except (ConfigParser.NoSectionError, ConfigParser.NoOptionError):
return ConfigParser.SafeConfigParser.get(
self, section, option, *args, **kwargs
def items(self, section, *args, **kwargs):
"""Extend SafeConfigParser to add project_section to section.
See SafeConfigParser.
See SafeConfigParser.
project_items = []
has_project_section = False
top_items = []
# Get items from the project section
project_items = ConfigParser.SafeConfigParser.items(
self, "%s_%s" % (self._project_name, section), *args, **kwargs
has_project_section = True
except ConfigParser.NoSectionError:
# Get top-level items
top_items = ConfigParser.SafeConfigParser.items(
self, section, *args, **kwargs
except ConfigParser.NoSectionError:
# If neither section exists raise the error on...
if not has_project_section:
item_dict = dict(top_items)
return item_dict.items()
def ReadGitAliases(fname):
"""Read a git alias file. This is in the form used by git:
......@@ -102,7 +236,7 @@ def _UpdateDefaults(parser, config):
parser: An instance of an OptionParser whose defaults will be
config: An instance of SafeConfigParser that we will query
config: An instance of _ProjectConfigParser that we will query
for settings.
defaults = parser.get_default_values()
......@@ -117,14 +251,16 @@ def _UpdateDefaults(parser, config):
print "WARNING: Unknown setting %s" % name
def Setup(parser, config_fname=''):
def Setup(parser, project_name, config_fname=''):
"""Set up the settings module by reading config files.
parser: The parser to update
project_name: Name of project that we're working on; we'll look
for sections named "project_section" as well.
config_fname: Config filename to read ('' for default)
config = ConfigParser.SafeConfigParser()
config = _ProjectConfigParser(project_name)
if config_fname == '':
config_fname = '%s/.patman' % os.getenv('HOME')
......@@ -141,3 +277,8 @@ def Setup(parser, config_fname=''):
# These are the aliases we understand, indexed by alias. Each member is a list.
alias = {}
if __name__ == "__main__":
import doctest
Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment