# oebuild

**Repository Path**: heroba-ai/oebuild

## Basic Information

- **Project Name**: oebuild
- **Description**: this is a openEuler Embedded meta tool
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-12-05
- **Last Updated**: 2022-12-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

这是openEuler Embedded meta tool，**oebuild**

#### 目录介绍：

##### bin:

bin目录是已经打包好的whl文件，下载相应的whl安装包执行以下命令即可完成安装：

```
sudo pip install -U <package.whl>
```

目前oebuild是为了openEuler Embedded用户更方便的去完成构建而开发，通过以下指导相信您很快就会完成一次openEuler Embedded的镜像构建，所有oebuild指令获取帮助格式为：

```
oebuild -h
```

或

```
oebuild <command> -h
```

##### src:

src目录存放构建oebuild的源码，开发者可以在该目录下添加相应的命令插件

##### .gitignore

.gitignore文件为git的忽略文件，在该文件中的内容将不被列入git的追踪文件

##### MANIFEST.ini

MANIFEST.ini文件为pip在打包时包含额外文件的配置文件，在该文件中的内容将在执行python打包时按规则进行包含

##### setup.py

setup.py文件为python打包入口文件

#### 使用指导

##### 初始化环境

我们需要创建一个可以构建openEuler Embedded的环境，后续所有操作都在该环境下进行，执行命令：

```
oebuild init <directory>
```

​	directory 是你初始化环境命名，该命令将在当前目录下创建一个你命名的目录，并进一步格式化好目录结构，目录结构如下：

​	-embedded

​		-src

​	-.oebuild

​		-config

- src目录下将存放openEuler Embedded的meta层源码

- config文件记录构建openEuler Embedded必要的环境参数

##### 更新环境

该操作将根据config文件来完成相应的环境准备工作，执行命令：

```
oebuild update
```

具体详情请添加-h获取帮助命令，该命令主要完成两个步骤，一，下载或更新config配置文件中列出的docker镜像，二，下载或更新meta_repo.yaml文件中的meta仓

##### 创建应用

该操作将创建一个应用构建目录，后续的构建相关操作都需要在应用目录中进行，执行命令：

```
oebuild sample -c -n <app name>
```

-c:为创建的缩写

-n:后跟要创建的应用名

##### 执行构建操作

在应用目录下可以执行构建相关的操作，这些操作包括列出支持的cpu platform, 一键式构建，bitbake交互，以下将列出构建相关指令：

##### board

该指令为cpu架构相关指令，目前只有-l参数，意为获取openEuler Embedded支持的cpu架构列表，命令范例如下：

```
oebuild board -l
```

##### compile

一键式构建，该命令不需要任何交互，有-c(cpu架构)，-p(构建包名)，-b(构建分支)，命令范例如下：

```
oebuild compile -c arm-std -p busybox -b master
```

如果参数缺失，-c默认为aarch64-std ,-p默认为openeuler-image,-b默认为master分支

##### bitbake

交互式构建，该命令执行后将进入bitbake构建交互界面，可以直接执行bitbake任何指令，目前的参数有-c(CPU架构)，-b(构建分支)，命令范例如下：

```
oebuild bitbake -c aarch64-std -b master
```

如果参数缺失，-c默认为aarch64-std ,-b默认为master分支



以上compile和bitbake构建操作将在应用目录下创建build构建目录，该目录中将存放构建产生的相关文件