Skip to content

Commit

Permalink
add build option doc
Browse files Browse the repository at this point in the history
  • Loading branch information
meltingrabbit committed Mar 8, 2024
1 parent d79d330 commit d340023
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ C2A に関する説明の棲み分けは,次のようになっています.
1. [Overview](./general/overview.md)
1. [Requirements](./general/requirements.md)
1. [Release](./general/release.md)
1. [Build Options](./general/build_options.md)
1. [Coding Rule](./general/coding_rule.md)
1. [Coding Acronyms](./general/coding_acronyms.md)
1. Application Layer
Expand Down
23 changes: 23 additions & 0 deletions docs/general/build_options.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Build Options

## 概要
主なビルドオプション (Cmake Option) について説明する.
なお,ここに含まれているオプションは利用可能なオプションのうち,ごく一部であることに注意すること.


## [`/CMakeLists.txt`](/CMakeLists.txt)
### コンパイルオプション
TBA

### C2A Core 機能
#### `C2A_USE_ALL_CORE_APPS`
`ON` にすることで,全ての Core Application をビルドする.
その場合, `/src_user/applications/CMakeLists.txt` にビルドしたい Core Application を適宜追加すること.

https://github.com/arkedge/c2a-core/blob/459dbbf84d9587730f248ccbadb5a5745b28903d/examples/subobc/src/src_user/applications/CMakeLists.txt#L9-L13


### その他
#### `C2A_USE_STDINT_WRAPPER`
C89 ターゲットでビルドする際に `ON` にすることで,コンパイラが提供するものではなく,ユーザ定義の `stdint.h` を使う.
その場合, `src_user/library/stdint_impl.h` にユーザー定義の `stdint.h` を配置すること.

0 comments on commit d340023

Please sign in to comment.