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

Update docs.md: Add note on mender_machine_type breaking the build #2321

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

Conversation

Granjow
Copy link
Contributor

@Granjow Granjow commented Feb 19, 2024

External Contributor Checklist

🚨 Please review the guidelines for contributing to this repository.

  • Make sure that all commits follow the conventional commit specification for the Mender project.

The majority of our contributions are fixes, which means your commit should have
the form below:

fix: <SHORT DESCRIPTION OF FIX>

<OPTIONAL LONGER DESCRIPTION>

Changelog: <USER-FRIENDLY-CHANGE-DESCRIPTION> or <None>
Ticket: <TICKET NUMBER> or <None>
  • Make sure that all commits are signed with git --signoff. Also note that the signoff author must match the author of the commit.

Description

See title.

Changelog: Improve MENDER_MACHINE_TYPE documentation

Signed-off-by: Simon A. Eugster <[email protected]>
@mender-test-bot
Copy link

Merging these commits will result in the following changelog entries:

Changelogs

mender-docs (patch-3)

New changes in mender-docs since hosted:

  • Improve MENDER_MACHINE_TYPE documentation

@@ -188,6 +188,10 @@ variable is only relevant when building a complete partitioned image (any suffix
ending in `img`). Once flashed with this image, the device type will persist
across subsequent updates.

Note that changing the `MENDER_DEVICE_TYPE` requires changing the `IMAGE_NAME`
and `IMAGE_LINK_NAME` when generating the initramfs fails; see
[this GitHub issue](https://github.com/OE4T/tegra-demo-distro/discussions/95#discussioncomment-687382).
Copy link
Member

Choose a reason for hiding this comment

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

Thanks for the info! However, I think this belongs in the troubleshooting section, not in the variable description.

I haven't looked deeply at this problem, but isn't it really kernel.bbclass which should fixed to refer to IMAGE_NAME and IMAGE_LINK_NAME properly, instead of relying on them to be set to specific values? Otherwise they are kind of pointless, if they can't be set to anything besides the default. I guess it's independent from this doc fix though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants