Skip to content

Commit

Permalink
Added the follwping PRs to the documentation (/Developer-Guide_Build-…
Browse files Browse the repository at this point in the history
  • Loading branch information
didierjoomun committed May 18, 2024
1 parent 565837d commit de4b480
Showing 1 changed file with 61 additions and 1 deletion.
62 changes: 61 additions & 1 deletion docs/Developer-Guide_Build-Options.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,67 @@
:warning: DO NOT USE! Obsolete documentation, new documentation in progress..
# Build options

### dts-check

Validate dts files and improve board & patch development overall

This option validates the dts/dtb file for the selected board against the device tree bindings, and outputs the validation logs to the user. It can be used when adding a new board, developing or improving a dts file.

Usage:
```bash
./compile.sh dts-check BOARD=nanopi-r5c BRANCH=edge
```
### inventory-boards

Outputs a one board per-line CSV inventory of boards.

Sets `TARGETS_FILE` to something that doesn't exist, so the `default-targets.yaml` is used (so same list for everyone, save for userpatched-boards)

Usage:
```bash
./compile.sh inventory-boards
```
Outputs /info/boards-inventory.csv

### kernel-dtb

Builds only DTB, and output full preprocessed dts source

Outputs preprocessed DTS source for board in question to `output/`
also outputs same preprocessed DTS source, ran through `dtc` with input and output DTS formats for "normalized" comparisions

Usage:
```bash
./compile.sh kernel-dtb BOARD=xxxxx BRANCH=edge
```

### rewrite-uboot-patches

Prepares git, applies patches to git, and re-writes them back from git
same as kernel, it does git archeology for mbox-less patches, etc.

- uboot-patches-to-git alias is also added, but my guess is rewrite is more useful.
- refactor a common config function for both kernel and uboot.

Usage:
```bash
./compile.sh rewrite-uboot-patches BOARD=xxxx BRANCH=edge
```

### targets

Generates output/git_sources.json file that will contain url, branch and commit hash combo.

The easiest way to generate file for all devices is to run `./compile.sh targets`. Then at the time of release we will copy the output/info/git_sources.json file to config/sources/git_sources.json. Once the file is copied, the hash information from the file will be used to fetch resources for git repositories where branches are specified instead of tags or commits.

Usage:
```bash
./compile.sh targets
```

# Build options (DEPRECATED)

:warning: DO NOT USE! Obsolete documentation, new documentation in progress..

These parameters are meant to be applied to the `./compile.sh` command. They are **all** optional. They can also be added to your [build configuration file](/Developer-Guide_Build-Preparation/#providing-build-configuration) to save time. Default values are marked **bold** if applicable.

## Main options
Expand Down

0 comments on commit de4b480

Please sign in to comment.