[#453] Document how to make cross-compilation work with buildroot

[jerry-xie-000]

Notes for Reviewer

Refer to: #453.

Write the steps how to make cross-compilation work with buildroot.

Pre-Review Checklist for the PR Author

1. Add sensible notes for the reviewer
2. PR title is short, expressive and meaningful
3. Relevant issues are linked in the References section
4. Every source code file has a copyright header with SPDX-License-Identifier: Apache-2.0 OR MIT
5. Branch follows the naming format (iox2-123-introduce-posix-ipc-example)
6. Commits messages are according to this guideline
   • Commit messages have the issue ID ([#123] Add posix ipc example)
   • Commit author matches Eclipse Contributor Agreement (and ECA is signed)
7. Tests follow the best practice for testing
8. Changelog updated in the unreleased section including API breaking changes
9. Assign PR to reviewer
10. All checks have passed (except task-list-completed)

Checklist for the PR Reviewer

• Commits are properly organized and messages are according to the guideline
• Unit tests have been written for new behavior
• Public API is documented
• PR title describes the changes

Post-review Checklist for the PR Author

1. All open points are addressed and tracked via issues

References

Closes #453

[orecham]

Just a couple of nitpicks. You will also need to register an eclipse account and sign the ECA agreement since we are an eclipse project.

Markdown linting might also bite you, but you can run this script to help: ./internal/scripts/check_markdown_linting.sh --fix

Could you also please fill out the PR template and ensure the open items are addressed, e.g. the commit needs to be prefixed with the issue number for traceability: [#453] Document how to make cross-compilation work with buildroot

[elBoberido]

@jerry-xie-000 can you also change the commit message to [#435] How to make cross-compilation work with buildroot so that the commit can easily be linked to the respective issue.

[jerry-xie-000]

I register an eclipse account and sign the ECA agreement and include my github name, but eclipsefdn/eca still fail to find my github name.

[elBoberido]

I register an eclipse account and sign the ECA agreement and include my github name, but eclipsefdn/eca still fail to find my github name.

@jerry-xie-000 it might take a day to sync everything. If the check still fails after tomorrow, I'll get in contact with the Eclipse Foundation.

[elBoberido]

@jerry-xie-000 did the account, you signed the ECA with, use the same e-mail address like you used for the commits?

[jerry-xie-000]

Run internal/scripts/check_markdown_linting.sh， seems it's ok now.

$ internal/scripts/check_markdown_linting.sh 
Running Markdown lint in check mode...
Checking only changed Markdown files...
The following Markdown files will be checked:
FAQ.md
FAQ_ICEORYX_DEVS.md
README.md
doc/bazel/README.md
doc/cross-compile/buildroot.md
doc/how-to-create-an-iceoryx2-release.md
doc/release-notes/iceoryx2-unreleased.md
examples/README.md
examples/c/event_multiplexing/README.md
examples/cxx/event_multiplexing/README.md
examples/rust/event_multiplexing/README.md
-----------------------------------
\nRunning markdownlint to check for issues...
\nMarkdown lint check completed successfully.

Feel free to tell me other issues.

[orecham]

@jerry-xie-000 Looks good, just need to get that ECA check passing.

Have you had a chance to confirm the comment from @elBoberido:

@jerry-xie-000 did the account, you signed the ECA with, use the same e-mail address like you used for the commits?

Oh and you will need to reword the commits so that they all have the prefix [#453], according to the PR template. You could just squash them all and use the one commit message [#453] Document how to make cross-compilation work with buildroot

[jerry-xie-000]

@jerry-xie-000 Looks good, just need to get that ECA check passing.

Have you had a chance to confirm the comment from @elBoberido:

@jerry-xie-000 did the account, you signed the ECA with, use the same e-mail address like you used for the commits?

Yes, I singed in ECA and github with the same email address. The GitHub username in ECA setting page which is same like github: jerry-xie-000. But the ECA check still fail.

[elBoberido]

@jerry-xie-000 the ECA Validation Tool does not find jerry-xie-000. Your Eclipse user name should also not contain dashes but only alpha-numeric characters. Please try to log in and check the Eclipse user name.