Skip to content

Commit f3434a5

Browse files
committed
docs(versioning): add details about commit_id
Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
1 parent d908824 commit f3434a5

3 files changed

Lines changed: 15 additions & 4 deletions

File tree

docs/BuildSystemLinux.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ While the file `commit_id.h` includes the commit ID of the Ocre Library.
2222
If this file is not present in the source tree, the file is generated during the build process and is stored in the build directory.
2323
If the file does not exist, and the source tree is not a valid git repository, the build will fail.
2424

25+
Check [Versioning](Versioning.md) documentation for more information.
26+
2527
#### Ocre build Configuration
2628

2729
The default Ocre build configuration is in the file `src/platform/posix/include/ocre/platform/config.h`.

docs/BuildSystemZephyr.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ We provide several points of integration with Zephyr:
1313
- Ocre West Project
1414
- Ocre Zephyr Module
1515
- Ocre Sample Applications
16-
- mini
17-
- demo
18-
- supervisor
16+
- mini
17+
- demo
18+
- supervisor
1919

2020
The general usage of these points of integration are described below.
2121

@@ -34,7 +34,7 @@ west init -l .
3434

3535
Here, `-l .` tells west to initialize the project using the manifest (`west.yml` in the current directory).
3636

37-
This will create a `.west` directory in `..` (i.e. side by side with the ocre-runtime directory). And when `west update` is run, Zephyr and its modules will also be checked out in `..`.
37+
This will create a `.west` directory in `..` (i.e. side by side with the ocre-runtime directory). And when `west update` is run, Zephyr and its modules will also be checked out in `..`.
3838

3939
This is the recommended way to work with the [Devcontainers](./Devcontainers.md).
4040

@@ -88,6 +88,8 @@ If the file does not exist, and the source tree is not a valid git repository, t
8888

8989
Note that these are unrelated to the Zephyr version and the Zephyr application version mechanism (i.e. throught he use of the VERSION file in the Zephyr application directory).
9090

91+
Check [Versioning](Versioning.md) documentation for more information.
92+
9193
#### Kconfig
9294

9395
There are several Kconfig options that can be used to configure Ocre.

docs/Versioning.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,13 @@ Generated every time into `commit_id.h` if the source tree is a valid git reposi
4343

4444
The format is `commit-hash[-dirty]`. This is generated by the build system using `git describe --always --abbrev=0 --dirty`, so it means the current commit hash and if there are any uncommitted changes in the working tree (as specificied by the optional `-dirty` suffix).
4545

46+
The `include/ocre/commit_id.h` includes the commit ID of the Ocre Library in Ocre Common library.
47+
If this file is not present in the source tree, the file is generated during the build process and is stored in the build directory.
48+
49+
If this file does not exist, and the source tree is not a valid git repository, the build will fail.
50+
51+
This file should never be created or modified by the user. When making the source distribution package of Ocre Runtime, this file will be generated in the source directory and the Git metatada will be removed.
52+
4653
### build_info
4754

4855
The host build information. Generated on every build system by the build system automatically.

0 commit comments

Comments
 (0)