Skip to content

boards: nxp: unify NXP board naming in board.yml #88368

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

butok
Copy link
Collaborator

@butok butok commented Apr 9, 2025

Unify full_name content in NXP board.yml to be consistent with the rest of NXP boards.

Copy link
Member

@decsny decsny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why is this change needed?

@@ -1,6 +1,6 @@
board:
name: imx8mp_evk
full_name: i.MX8MP EVK
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently the board name is the same with the information in nxp.com, so I don't think we need to update the name.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently the board name is the same with the information in nxp.com, so I don't think we need to update the name.

"-EVK" is written on board labels. Also it used for other NXP board naming.
Actually no matter for me, just to use the common approach.

@dbaluta
Copy link
Collaborator

dbaluta commented Apr 10, 2025

@butok I don't think this is necessary. A name is just a human readable form to identify the board. At least for i.MX8 boards I would prefer to keep them like that.

@butok
Copy link
Collaborator Author

butok commented Apr 10, 2025

The NXP board naming in Zephyr documentation is not uniform even within families. Various inconsistencies exist such as using hyphens or spaces, including revisions or not, and using core names or omitting them. See https://docs.zephyrproject.org/latest/boards/nxp/index.htm
The goal is to unify this naming convention.

The current Zephyr NXP documentation board naming chaos is caused by different variants used on board labels, website titles, board documentation, and using short and long naming forms.

"We need to decide if we want to fix this inconsistency at least in the Zephyr documentation."
It's not critical, so waiting for @dleach02 opinion.

Anyone is welcome to provide their own solution via a Pull Request, but it should be applicable to all NXP Zephyr boards.

Unify full_name content in NXP board.yml
to be consistent with the rest of NXP boards.

Signed-off-by: Andrej Butok <andrey.butok@nxp.com>
@butok butok force-pushed the unify_nxp_board_full_name branch from c8ac812 to 0914926 Compare April 14, 2025 11:51
@butok butok requested a review from manuargue April 14, 2025 13:42
@manuargue manuargue dismissed their stale review April 28, 2025 07:17

my concerns addressed, no changes for my area so dismissing my review

Copy link
Collaborator

@DerekSnell DerekSnell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would use these names to align with the board names on NXP.com:

@@ -1,6 +1,6 @@
board:
name: imx91_evk
full_name: i.MX91 EVK
full_name: i.MX91-EVK
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
full_name: i.MX91-EVK
full_name: i.MX91EVK

See https://www.nxp.com/design/design-center/development-boards-and-designs/i.MX91EVK

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not critical, but "i.MX91-EVK" is also used by nxp.com
image

@@ -1,6 +1,6 @@
board:
name: imx93_evk
full_name: i.MX93 EVK
full_name: i.MX93-EVK
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
full_name: i.MX93-EVK
full_name: i.MX93EVK

see https://www.nxp.com/design/design-center/development-boards-and-designs/i.MX93EVK

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or should it be "MCIMX93-EVK" ;) nxp.com:
image

Copy link

This pull request has been marked as stale because it has been open (more than) 60 days with no activity. Remove the stale label or add a comment saying that you would like to have the label removed otherwise this pull request will automatically be closed in 14 days. Note, that you can always re-open a closed pull request at any time.

@github-actions github-actions bot added the Stale label Jul 13, 2025
@dleach02 dleach02 removed the Stale label Jul 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
platform: NXP MPU platform: NXP Robotics NXP Robotics Module Platform Products platform: NXP S32 NXP Semiconductors, S32 platform: NXP NXP
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants