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

Swap documentation from native_posix to native_sim #65057

Merged
merged 4 commits into from
Nov 14, 2023

Conversation

aescolar
Copy link
Member

@aescolar aescolar commented Nov 10, 2023

Swap documentation from native_posix to native_sim

During this release native_sim is replacing native_posix
as the main host test/development platform.

Therefore:

  • Instead of basing the native_sim documentation in native_posix's one, let's do it the other way around.
  • Replace reference to native_posix with native_sim in boards/posix/doc/
  • Introduction and beyond getting started guide: Replace references to native_posix w native_sim

Doc preview in: https://builds.zephyrproject.io/zephyr/pr/65057/docs/index.html


The 1st commit is actually quite trivial even though it seems big. 99% of the lines are just moved from boards/posix/native_posix/doc/index.rst to boards/posix/native_sim/doc/index.rst.
In the rest: "native_posix" was replaced with "native_sim", links renamed, or other very trivial changes done.

Here you can see a diff main boards/posix/native_posix/doc/index.rst vs
this PRs boards/posix/native_sim/doc/index.rst :
https://www.diffchecker.com/VRk8cMVS/


This is part of a series to update all documentation and samples changing the preferred native platform from native_posix to native_sim

…e_sim

During this release native_sim is replacing native_posix
as the main host test/development platform.

Therefore, instead of basing the native_sim documentation
in native_posix's one, let's do it the other way around.

This commit mostly moves documentation from the native_posix
page into the native_sim one, changing the board and renaming
labels.

Signed-off-by: Alberto Escolar Piedras <[email protected]>
Let's replace the references to native_posix with native_sim,

Background: during this release native_sim is replacing
native_posix as the main host test/development platform.

Signed-off-by: Alberto Escolar Piedras <[email protected]>
Let's replace the references to native_posix with native_sim,
in the introduction and beyond the getting started guide.

Background: during this release native_sim is replacing
native_posix as the main host test/development platform.

Signed-off-by: Alberto Escolar Piedras <[email protected]>
@aescolar aescolar marked this pull request as ready for review November 10, 2023 12:40
@aescolar aescolar requested a review from nashif as a code owner November 10, 2023 12:40
@aescolar aescolar requested review from kartben, cvinayak, carlescufi and kruithofa and removed request for nashif November 10, 2023 12:41
@zephyrbot zephyrbot added area: Documentation platform: nRF BSIM Nordic Semiconductors, nRF BabbleSim area: native port Host native arch port (native_sim) labels Nov 10, 2023
@zephyrbot zephyrbot requested a review from nashif November 10, 2023 12:41
@aescolar aescolar assigned kartben and unassigned aescolar Nov 13, 2023
@aescolar
Copy link
Member Author

@kartben as maintainer of this area I'm happy with the changes :D
You are the docs maintainer together with @carlescufi so your blessing would be welcome

carlescufi
carlescufi previously approved these changes Nov 14, 2023
Copy link
Member

@carlescufi carlescufi left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for the extra clarification on "POSIX OS" vs Linux.

@carlescufi
Copy link
Member

@kartben could you take a look?

kruithofa
kruithofa previously approved these changes Nov 14, 2023
boards/posix/native_posix/doc/index.rst Outdated Show resolved Hide resolved
boards/posix/native_sim/doc/index.rst Outdated Show resolved Hide resolved
boards/posix/native_sim/doc/index.rst Outdated Show resolved Hide resolved
boards/posix/native_sim/doc/index.rst Outdated Show resolved Hide resolved
boards/posix/native_sim/doc/index.rst Outdated Show resolved Hide resolved
boards/posix/native_sim/doc/index.rst Show resolved Hide resolved
boards/posix/native_sim/doc/index.rst Outdated Show resolved Hide resolved
boards/posix/native_sim/doc/index.rst Outdated Show resolved Hide resolved
boards/posix/native_sim/doc/index.rst Outdated Show resolved Hide resolved
boards/posix/native_sim/doc/index.rst Outdated Show resolved Hide resolved
@aescolar aescolar dismissed stale reviews from kruithofa and carlescufi via 9ea3809 November 14, 2023 11:56
@aescolar aescolar requested a review from kartben November 14, 2023 11:57
@aescolar
Copy link
Member Author

@kartben all done. Note that as the previous commit was mostly just doing a move from one board doc to the other, and these are extra polish on previous content, I did them as an extra commit on top.

Copy link
Collaborator

@kartben kartben left a comment

Choose a reason for hiding this comment

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

great, thanks! Just spotted one last misindented block, sorry. +1 otherwise

boards/posix/native_sim/doc/index.rst Outdated Show resolved Hide resolved
boards/posix/native_sim/doc/index.rst Outdated Show resolved Hide resolved
@aescolar aescolar requested a review from kartben November 14, 2023 12:18
Polish the native_sim documentation a bit.

Signed-off-by: Alberto Escolar Piedras <[email protected]>
@aescolar
Copy link
Member Author

thanks @kartben :)

@carlescufi carlescufi merged commit 86db699 into zephyrproject-rtos:main Nov 14, 2023
16 checks passed
@aescolar aescolar deleted the natsim_docs_swap branch November 14, 2023 13:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Documentation area: native port Host native arch port (native_sim) platform: nRF BSIM Nordic Semiconductors, nRF BabbleSim
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants