Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

hwmv2: doc: update board porting guide to match new hardware model #68792

Merged

Conversation

tejlmand
Copy link
Collaborator

@tejlmand tejlmand commented Feb 9, 2024

Update board porting guide to the design changes in the new hw model.

New section added:

  • board.yml file description

Updated sections:

  • Board on SoCs example table updated to new format and extra examples
    added.
  • Board directory description and its files
  • Writing devicetree file section updated to match new lookup patterns
  • Writing Kconfig file section updated to match new lookup patterns
  • Board revision handling updated

In getting started guide a note has been added with short description
of the new board and board identifier scheme.


Doc related to SoC porting is in the making and will follow soon.

@tejlmand
Copy link
Collaborator Author

Ping @nashif @erwango

@tejlmand tejlmand force-pushed the wip/hwmv2_doc_update branch from d168f7b to 463b192 Compare February 26, 2024 15:48
@tejlmand
Copy link
Collaborator Author

@kartben there is a compliance failure regarding:

doc/hardware/porting/board_porting.rst:477: space before tab in indent.

there are several occurrences in this and other files in Zephyr repo today.

In this case it happens because code blocks should start with spaces, but Kconfig and dts uses tabs as indentation for the example.
I've followed existing pattern of this, which is also used in other files in zephyr repo.

Should we change all tabs to space, or keep the mix ?
I don't see this directly specified in docs guidelines, https://docs.zephyrproject.org/latest/contribute/documentation/guidelines.html#

Update board porting guide to the design changes in the new hw model.

New section added:
- board.yml file description

Updated sections:
- Board on SoCs example table updated to new format and extra examples
  added.
- Board directory description and its files
- Writing devicetree file section updated to match new lookup patterns
- Writing Kconfig file section updated to match new lookup patterns
- Board revision handling updated

In getting started guide a note has been added with short description
of the new board and board identifier scheme.

Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
@tejlmand tejlmand force-pushed the wip/hwmv2_doc_update branch from 463b192 to 1be9924 Compare February 27, 2024 08:13
@tejlmand
Copy link
Collaborator Author

Should we change all tabs to space, or keep the mix ?

all tabs changed to spaces for now.

@nordicjm nordicjm merged commit dbc18a2 into zephyrproject-rtos:collab-hwm Feb 27, 2024
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.