IRNAS / irnas-east-software

East is a command line meta-tool, useful for creating, managing, and deploying Zephyr or nRF Connect SDK projects.
MIT License
10 stars 1 forks source link

Add documentation about east configuration #30

Closed MarkoSagadin closed 1 year ago

MarkoSagadin commented 2 years ago

Description

This PR adds a document that describes how East can be configured to specify build types and release procedures.

I plan to write a general help command so this document will be available from the command-line, but for now it will be just in the docs folder.

Areas of interest

Read the file in the docs folder, I want to know if:

After-review steps

MarkoSagadin commented 2 years ago

Current dependencies on/for this PR:

This comment was auto-generated by Graphite.

TjazVracko commented 2 years ago

@MarkoSagadin I have made some edits, fixes and suggestions.

I also recommend you use east and west always in lowercase.

new.txt

MarkoSagadin commented 2 years ago

This was mentioned by @TjazVracko: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/zephyr/hardware/porting/board_porting.html#multiple-board-revisions

East should deduct a list of board revisions from cmake file that has VALID_REVISION argument.

MarkoSagadin commented 2 years ago

I also recommend you use east and west always in lowercase.

Makes sense, I will change that.

TjazVracko commented 2 years ago

@MarkoSagadin

  1. why is the folder named confs and not conf ?
  2. How will you handle child_image/mcuboot.conf and child_image/spm.conf
  3. Think about the case when mcuboot should be configured differently for the debug build than the release build. Will this be supported?
vid553 commented 2 years ago

Document looks good. For the begginer devs I would just add links to NCS / Zephyr docs about using Kconfig files and such.

MarkoSagadin commented 2 years ago
  1. why is the folder named confs and not conf ?
  2. How will you handle child_image/mcuboot.conf and child_image/spm.conf
  3. Think about the case when mcuboot should be configured differently for the debug build than the release build. Will this be supported?
  1. I will rename confs into conf
  2. I won't, for now we use the default behaviour, which is child_image folder
  3. For now no, as we think that this is edge case.

Document looks good. For the begginer devs I would just add links to NCS / Zephyr docs about using Kconfig files and such.

Will add!

MarkoSagadin commented 2 years ago

@vid553 @TjazVracko Check again latest changes