构建配置

更正文档

package.yaml是组件的配置文件，采用YAML文本的方式，配置组件包含哪些源文件，头文件，宏，以及组件依赖关系等等，替代了传统的makefile文件。

YAML语法说明：

中文文档

英文文档

YAML格式校验工具：

在线工具

package.yaml模板生成：在aos工作目录下使用。

当用户想把一个源码目录快速变为一个aos组件时，将组件代码复制到aos内相应的组件目录下，然后使用这个命令，会在<dir>目录下生成package.yaml文件模板，用户可根据需求再适当的调整修改package.yaml文件。

aos convert <dir>

aos-tools可运行外部脚本，并以"--longopt=value"的方式传入参数：

• prebuild_script: 在组件编译之前运行

• postbuild_script: 在组件编译完成之后运行

• postimage_script: 在工程构建完成之后运行

python版本

#!/usr/bin/env python
import os, sys, re, codecs

params = sys.argv[1:]
if os.path.isfile(sys.argv[1]):
    with codecs.open(sys.argv[1], 'r', 'UTF-8') as fh:
        params = fh.read().split()

# choose those arguments we wanted, and discard others
key_value = {}
pattern = re.compile(r'--(.+?)=(.*)')
for arg in params:
    if arg.startswith("--"):
        match = pattern.match(arg)
        if match:
            key = match.group(1)
            value = match.group(2)
            if key in ["toolchain", "lib", "target"]:
                key_value[key] = value

print("the script is %s" % sys.argv[0])
print("current dir is %s" % os.getcwd())
for key in key_value.keys():
    print("%s is %s" %(key, key_value[key]))

# =======================================================
# do our work

# =======================================================    

# result
print("run external script success")
exit(0)

Shell版本

#!/usr/bin/env bash

if [ "$(uname)" == "Darwin" ]; then
    os="Darwin"
elif [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then   
    os="Linux"
elif ["$(expr substr $(uname -s) 1 10)"=="MINGW32_NT"];then    
    os="Win32"
fi
echo "os is $os"

if [ -f $1 ]; then
# read arguments from file, and choose those arguments we wanted
for word in $(<$1)
do
    key=$(echo $word | cut -d '=' -f1)
    if [ "$os" == "Darwin" ]; then
        value=$(echo $word | cut -d '=' -f2-)
    elif [ "$os" == "Linux" ]; then
        value=$(echo $word | cut -d '=' --complement -f1)
    else
        value=""
    fi
    case "$key" in
        --toolchain) toolchain=$value;;
        --lib) lib=$value;;
        --target) target=$value;;
        *) echo "discard option $word";;
    esac;
done
else
# choose those arguments we wanted, and discard others
until [ $# -eq 0 ]
do
    key=$(echo $1 | cut -d '=' -f1)
    value=$(echo $1 | cut -d '=' --complement -f1)
    case "$key" in
        --toolchain) toolchain=$value;shift;;
        --lib) lib=$value;shift;;
        --target) target=$value;shift;;
        *) echo "discard option $1";shift;;
    esac;
done
fi

echo "the script is $0"
echo "current dir is $(pwd)"
echo "toolchain is $toolchain"
echo "lib is $lib"
echo "target is $target"

# =======================================================
# do our work

# =======================================================

# result
echo "run external script success"
exit 0

• 编写package.yaml

在各个组件内部，将需要导出的h文件和预编译库添加到package.yaml的install部分。添加规则如下：例如某个组件A的实际的文件列表如下：

compa
├── package.yaml
├── README.md
├── src
│   ├── aaa.c
│   ├── bbb.c
│   ├── ccc.c
│   └── ddd.c
├── include
│   ├── aaa.h
│   ├── bbb.h
│   └── fff
│       └── ccc.h
└── interal_include
│    └── ddd.h
└── prebuilt
     └── libeeeee.a

的 build_confg部分指定了对外头文件和预编译库：

build_config:
  include:
    - include/
  libs:
    - eee
  libpath:
    - prebuilt

那么install部分如下，其中头文件都放在Include目录下，预编译库都放在lib目录下。

install:
  # copy aaa.h bbb.h to aos_sdk/include
  - dest: "include"
    source:
      - *.h
  # copy fff/ccc.h to aos_sdk/include/fff
  - dest: "include/fff"
    source:
      - fff/*.h
  # copy drivers/libmcuhaas1000.a to aos_sdk/lib/libmcuhaas1000.a
  - dest: "lib"
    source:
      - prebuilt/libeee.a

• 在solution目录下执行编译，aos make，编译成功后会将组件编译生成的静态库自动放到aos_sdk/lib目录下。

• 在solution目录下执行导出，aos sdk，将组件对外头文件和预编译库复制到aos_sdk里的include和lib目录下。

• 删除out目录，将当前solution目录打包，提供给其他开发者做二次开发。

在package.yaml里面添加组件依赖，或者添加源文件，或者添加预编译库时，经常会使用条件。仅当条件满足时，才引入某个组件，或者添加某个文件，或者添加某个预编译库等等。

单条件

depends:
  - comp1: "v1.0 ? <COND1>"
source_file:
  - src/xx.c ? <COND2>
libs:
  - lib1.a ? <COND3>

此处<>中的内容即条件，是当前组件或其他组件里的def_config所定义的宏。当宏为1时，表示条件成立，执行相应的操作：引入某个组件等等。当宏为0，或者未定义时，则不执行相应的操作。

非条件

depends:
  - comp1: "v1.0 ? <!COND1>"
source_file:
  - src/xx.c ? <!COND2>
libs:
  - lib1.a ? <!COND3>

支持使用!做逻辑非操作。一个未定义的宏，如果前面加了!，则表示条件成立。

与条件

depends:
  - comp1: "v1.0 ? <COND1, COND4, !COND5>"
source_file:
  - src/xx.c ? <COND2, COND6>
libs:
  - lib1.a ? <COND3, !COND7>

支持使用,号分隔多个条件，做逻辑与操作，即所有条件都满足，才执行相应的操作。其中每个条件可以加!号，做逻辑非操作。

或条件

depends:
  - comp1: "v1.0 ? <COND1>"
  - comp1: "v1.0 ? <COND4>"
  - comp1: "v1.0 ? <!COND5>"
source_file:
  - src/xx.c ? <COND2>
  - src/xx.c ? <COND6>
libs:
  - lib1.a ? <COND3>
  - lib1.a ? <!COND7>

没有显式使用逻辑或操作的方式。可以参考上面的例子中，将需要或的条件拆成单独一行。