本节讨论如何开始开发gem5。
GEM5样式指南
在修改任何开源项目时,请务必遵循项目的风格指南。关于gem5样式的详细信息,可参见gem5编码风格页面。
为了帮助用户遵守样式指南,gem5包含一个每当用户在Git中提交变更时都会运行的脚本,该脚本在用户首次构建gem5时由SCons自动添加到.git/config文件中。注意不要忽略这些警告或者错误。但是,在极少数的一些情况下,用户可能需要提交不符合GEM5风格指南的文件(例如,GEM5源代码树以外的文件),用户可以使用git的--no-verify选项跳过运行样式检查。
风格指南的主要内容有:
- 使用4个空格,而非制表符
- 对includes包含内容进行排序
- 类名使用大写的驼峰大小写、成员变量和函数使用驼峰大小写、局部变量的蛇形大小写。
- 注释代码
git分支
大多数使用gem5开发的人都使用git工具的分支功能来跟踪gem5的变化,这使得用户变更后可以很容易地将更改提交回到原来的gem5版本,此外,使用分支还可以更轻松地将gem5更新到其他人新修改的版本但是另外保留自己的修改。Git一书中有一章很好地描述了如何使用分支的细节。