Skip to content

Application development primer docs broken by west merge #12886

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

Closed
mbolivar opened this issue Jan 30, 2019 · 7 comments · Fixed by zephyrproject-rtos/west#182
Closed

Application development primer docs broken by west merge #12886

mbolivar opened this issue Jan 30, 2019 · 7 comments · Fixed by zephyrproject-rtos/west#182
Assignees
Labels
area: Documentation area: West West utility bug The issue is a bug, or the PR is fixing a bug priority: high High impact/importance bug
Milestone

Comments

@mbolivar
Copy link
Contributor

Describe the bug

The documentation recommends creating an application and build directory somewhere in the home directory. This is likely outside the west installation, so running commands like ninja flash or west flash in the build directory are unlikely to work.

To Reproduce

https://docs.zephyrproject.org/latest/application/application.html

Expected behavior

Docs should lead to working apps

Impact

Showstopper for v1.14; these docs must work

Screenshots or console output

E.g.:

"Create an application directory on your workstation computer, outside of the Zephyr base directory. Usually you’ll want to create it somewhere under your user’s home directory."

Environment (please complete the following information):

  • OS: N/A
  • Toolchain N/A
  • Commit SHA or Version used e.g. b73c9b3

Additional context
N/A

@mbolivar mbolivar added bug The issue is a bug, or the PR is fixing a bug area: Documentation labels Jan 30, 2019
@mbolivar mbolivar added this to the v1.14.0 milestone Jan 30, 2019
@mbolivar mbolivar added the priority: high High impact/importance bug label Jan 30, 2019
@carlescufi
Copy link
Member

Well that is actually a major problem I had not foreseen. Do we need to require all external apps to be inside the zephyr installation? Can we make ninja flash work based on ZEPHYR_BASE and $ZEPHYR_BASE..\.west instead?

@nashif
Copy link
Member

nashif commented Jan 30, 2019

i was surprised by this as well, discussed this briefly on #west yesterday.

@carlescufi carlescufi added the area: West West utility label Jan 30, 2019
@mbolivar
Copy link
Contributor Author

Can we make ninja flash work based on ZEPHYR_BASE and $ZEPHYR_BASE..\.west instead?

I don't like the idea of using ZEPHYR_BASE because that could point to the wrong tree if users use zephyr-env.sh.

The west issue is zephyrproject-rtos/west#175; please refer there for some discussion of the solutions.

@SebastianBoe
Copy link
Collaborator

I don't know about "west flash".

But for "ninja flash", I would assume that since the flashing-related code is in-tree we could have some kind of in-tree frontend to invoke it. (Assuming we aren't able to solve "west flash").

@mbolivar
Copy link
Contributor Author

mbolivar commented Feb 1, 2019

But for "ninja flash", I would assume that since the flashing-related code is in-tree we could have some kind of in-tree frontend to invoke it. (Assuming we aren't able to solve "west flash").

Yeah, you read my mind. I'm going to try that. Monorepo "default" flashing and debugging can then continue to work.

@mbolivar
Copy link
Contributor Author

mbolivar commented Feb 1, 2019

But for "ninja flash", I would assume that since the flashing-related code is in-tree we could have some kind of in-tree frontend to invoke it. (Assuming we aren't able to solve "west flash").

Yeah, you read my mind. I'm going to try that. Monorepo "default" flashing and debugging can then continue to work.

This turns out to be impossible. The extension commands rely too much on modules inside west, such as west.cmake. So we really can't build this in-tree frontend.

@SebastianBoe
Copy link
Collaborator

That's a shame.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Documentation area: West West utility bug The issue is a bug, or the PR is fixing a bug priority: high High impact/importance bug
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants