summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorJason Lowe-Power <jason@lowepower.com>2017-04-11 16:17:10 -0500
committerJason Lowe-Power <jason@lowepower.com>2017-04-25 20:59:01 +0000
commit2ee0992a05c48b8b1d3e12a7361f4114136264f8 (patch)
tree4c7c1ec05db961c889edb3af4ef7d7ef798714a6 /CONTRIBUTING.md
parent1c972b052659a6926dd23e5735f17f23b5f7084a (diff)
downloadgem5-2ee0992a05c48b8b1d3e12a7361f4114136264f8.tar.xz
misc: Add MAINTAINERS file
This file defines all of the commit keywords used for gem5 commits and the maintainter(s) for each of these keywords. This patch introduces a number of new keywords, and changes to previous keywords. The new keywords better follow gem5's directory structure and are more extensible. Currently, most keywords do not have a maintainer. More maintainers will be added as more people volunteer to be maintainers. This patch also updates the CONTRIBUTING.md file to point to this file instead of listing the keywords separately. When this file is committed the wiki will also be updated accordingly. Change-Id: Ib0abfeb39a3ca01b74b340e24dc9a2cd95ff813f Signed-off-by: Jason Lowe-Power <jason@lowepower.com> Reviewed-on: https://gem5-review.googlesource.com/2760 Reviewed-by: Andreas Sandberg <andreas.sandberg@arm.com> Reviewed-by: Nikos Nikoleris <nikos.nikoleris@arm.com>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md33
1 files changed, 4 insertions, 29 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a9781a34d..e1b3c6d1b 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -113,10 +113,10 @@ changes, we require all change descriptions be strictly formatted.
A canonical commit message consists of three parts:
* A short summary line describing the change. This line starts with one or
- more keywords separated by commas followed by a colon and a description of
- the change. This line should be no more than 65 characters long since
- version control systems usually add a prefix that causes line-wrapping for
- longer lines.
+ more keywords (found in the MAINTAINERS file) separated by commas followed
+ by a colon and a description of the change. This line should be no more than
+ 65 characters long since version control systems usually add a prefix that
+ causes line-wrapping for longer lines.
* (Optional, but highly recommended) A detailed description. This describes
what you have done and why. If the change isn't obvious, you might want to
motivate why it is needed. Lines need to be wrapped to 75 characters or
@@ -125,31 +125,6 @@ A canonical commit message consists of three parts:
tags to acknowledge reviewers for their work. Gerrit will automatically add
most tags.
-The keyword should be one or more of the following separated by commas:
- * Architecture name in lower case (e.g., arm or x86): Anything that is
- target-architecture specific.
- * base
- * ext
- * stats
- * sim
- * syscall_emul
- * config:
- * mem: Classic memory system. Ruby uses its own keyword.
- * ruby: Ruby memory models.
- * cpu: CPU-model specific (except for kvm)
- * kvm: KVM-specific. Changes to host architecture specific components should
- include an architecture keyword (e.g., arm or x86) as well.
- * gpu-compute
- * energy
- * dev
- * arch: General architecture support (src/arch/)
- * scons: Build-system related. Trivial changes as a side effect of doing
- something unrelated (e.g., adding a source file to a SConscript) don't
- require this.
- * tests
- * style: Changes to the style checkers of style fixes.
- * misc
-
Tags are an optional mechanism to store additional metadata about a patch and
acknowledge people who reported a bug or reviewed that patch. Tags are
generally appended to the end of the commit message in the order they happen.