当前位置: 首页 > ONOS > 正文

ONOS开发环境配置

ONOS开发环境配置

未完待续。。。。。

内容目录:

  1. IDE配置
    1. 导入ONOS源代码
    2. 代码格式化(Code Formatting)
    3. 软件著作权
  2. Git/Gerrit 配置
    1. Git remotes
    2. Configuring Gerrit
    3. Uploading SSH Public Keys
    4. Configuring git
  3. 构建 API 文档

本教程假定您已经完成http://sdnhub.cn/index.php/build-onos-from-source-code/

1. IDE配置

主要介绍ONOS源代码在Eclipse中的配置。

1.1 导入ONOS源代码

由于ONOS是基于Maven开发的,所以需要使用较高版本的Eclipse,自带Maven插件。

将ONOS以Maven Project的方式导入Eclipse的步骤如下:

  • File > Import > Maven > Existing Maven Projects
  • 选择onos源代码的根目录。由于ONOS是一个多模块项目(multi-module project),可能出现很多以“onos-”开头的项目,在Eclipse中这是很正常的。关于ONOS的软件模块列表参考 http://api.onosproject.org,和 Source Tree Organization

故障排除:

在Eclipse中导入ONOS项目后出现关于jacoco-maven-pluginonos-maven-plugin的如下错误:”Plugin execution not covered …”,解决方法如下:
(1)在一个Plugin execution not covered…错误上点击鼠标右键,选择Quick Fix,如下图所示:

1error_list

(2)选择Mark the goal as ignored in Eclipse build in Eclipse preference,然后点击Finish,如下图所示:

2quickfix2

(3)选择一个ONOS相关的项目,并打开Update Project对话框,然后选择Select All,更新所有的项目,如下图所示:

3update_project

(4)通过上面的步骤,maven goal resolution errors for the sname goal应该消失了。(jacoco-maven-plugin)。对于余下的goal error重复上面的步骤。(onos-maven-plugin)

4repeat

1.2 代码格式化(Code Formatting)

ONOS项目的代码格式化遵循如下规定:

  • 缩进4个空格
  • 没有结尾空格,即,每行代码(包括空行)不能以空格结束。
  • 关键字(如:if,for,while)后有空格。

空格格式化通过 Checkstyle 强制检查。它在Maven进行build是进行运行检查。如果代码的格式化检查失败的话,则导致ONOS编译失败。

完整的代码风格指南,在这里:Code Style Guidelines

1.3 软件著作权

所有的开发者都应该设置IDE,代码包含 Apache 2 license 文件头文本。内容包含在文件 tools/dev/header.txt 中。详细的License参考:http://www.apache.org/licenses/LICENSE-2.0.html

下面介绍IntelliJ和Eclipse中的具体设置:

IntelliJ的Copyright设置:

首先需要确保 Copyright 插件已经激活。在 Preferences 中选择 Copyright 部分,并且创建一个新的 Copyright prifile,名字为 Apache 2,具体内容从上面的文件中拷贝过来即可,如下图所示:

5IntelliJ-copyright

Eclipse的Copyright设置

如下图所示:

6Eclipse_Copyright

别忘了选中:Automatically add comments for new methods and types

2. Git/Gerrit 配置

2.1 Git remotes

可以使用httpsssh两种方式从Gerrit克隆ONOS的源代码。在ONOS的源码目录下执行如下命令:

root@mininet-vm:~/onos.bak# git remote -v
origin  https://github.com/opennetworkinglab/onos.git (fetch)
origin  https://github.com/opennetworkinglab/onos.git (push)

未完待续。。。。

3. 构建API文档

To build a local set of the ONOS Java API documentation bundle, use the onos-build-docs utility, which uses Maven to generate both internal and external documentation.
Running onos-build-docs from any location generates HTML pages under ONOS_ROOT/docs/, and can be accessed by pointing a browser to ONOS_ROOT/docs/target/site/apidocs/index.html .
The generated documentation is also wrapped into a gzipped tar archive and placed under /tmp with the naming convention onos-apidocs-..tar.gz.

本文固定链接: http://sdnhub.cn/index.php/setup-onos-development-environment/ | 软件定义网络SDN

该日志由 sdnhub 于2015年04月09日发表在 ONOS 分类下, 通告目前不可用,你可以至底部留下评论。
原创文章转载请注明: ONOS开发环境配置 | 软件定义网络SDN
关键字: ,

ONOS开发环境配置:等您坐沙发呢!

发表评论

*

快捷键:Ctrl+Enter