doc: develop: manifests: external: add arduino core #97726
Conversation
| .. code-block:: bash | ||
|
|
||
| git clone https://github.com/arduino/ArduinoCore-API # Any location | ||
| ln -s /<your>/<location>/ArduinoCore-API/api cores/arduino/. |
There was a problem hiding this comment.
the destination is assuming folks are in the module's folder, which is very unlikely the case.
There was a problem hiding this comment.
Can we just make the arduino core api repo an optional west project? Or maybe make both arduino core api and arduino zephyr project part of a group (disabled by default).
There was a problem hiding this comment.
Yeah no, this would not be added to the main Zephyr repo. But having the Arduino API as a zephyr module to simplify it's provisioning in people's workspace is a good idea for sure
There was a problem hiding this comment.
having the Arduino API as a zephyr module to simplify it's provisioning in people's workspace is a good idea for sure
@kartben @Ayush1325 sorry I am not following this conversation too well, What's the conclusion on this one?
Should I add the arduino core zephyr to zephyr/west.yml ?
There was a problem hiding this comment.
my suggestion was to contribute a zephyr/module.yml to https://github.com/arduino/ArduinoCore-API so that it could then be pulled as a module alongside "arduino-core-zephyr" ; this way simplifying the experience for folks who would not have to git clone and crerate symbolic links?
There was a problem hiding this comment.
my suggestion was to contribute a zephyr/module.yml to https://github.com/arduino/ArduinoCore-API so that it could then be pulled as a module alongside "arduino-core-zephyr" ; this way simplifying the experience for folks who would not have to git clone and crerate symbolic links?
What do you mean by pulled alongside arduion-core-zephyr?
Even if the ArduinoCore-API is a zephyr module, do we add it to the normal zephyr west.yaml? Or do we expect users to add the module manually to west.yaml?
There was a problem hiding this comment.
Or do we expect users to add the module manually to west.yaml?
yes, it's the whole point of this PR to document how users can add arduinocore-zephyr manually to their workspace, similar to all the others external modules documented hee https://docs.zephyrproject.org/latest/develop/manifest/index.html#external-projects-modules
There was a problem hiding this comment.
Got it, I missed that it will be an external module. Then it makes sense.
DhruvaG2000
force-pushed
the
arduino-api-doc
branch
2 times, most recently
from
4d9735b to
81d384c
Compare
DhruvaG2000
force-pushed
the
arduino-api-doc
branch
2 times, most recently
from
e43b494 to
09b3789
Compare
DhruvaG2000
changed the title
DhruvaG2000
force-pushed
the
arduino-api-doc
branch
2 times, most recently
from
982677b to
7676c2f
Compare
| #. Complete the core setup by linking the API folder from the ArduinoCore-API repository into | ||
| the arduinocore-zephyr folder: | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| git clone https://github.com/arduino/ArduinoCore-API # Any location | ||
| cd /<path>/<to>/<zephyrproject>/modules/lib/arduinocore-zephyr | ||
| ln -s /<your>/<location>/arduinocore-zephyr/api cores/arduino/. |
There was a problem hiding this comment.
Is this supposed the be the "manual steps" mentioned in the previous bullet point? If yes it probably needs to be a sub-bullet or a .. note or something since otherwise it's not clear users who've run the install script can skip this
What's more, it's supposed to be instructions for non Linux users and yet it uses ln -s which won't be available to windows users?
There was a problem hiding this comment.
What's more, it's supposed to be instructions for non Linux users and yet it uses ln -s which won't be available to windows users
I haven't really tried using Arduino Core Zephyr on windows, I meant these steps for people with non standard paths/ environments. I will try to reword all of it to reduce ambiguity
There was a problem hiding this comment.
@kartben can you take a look at the note I added now, does it make sense?
Thanks for all the reviews so far!
Add documentation for the Arduino Core API for zephyr which sits as an external module as of today. Signed-off-by: Dhruva Gole <d-gole@ti.com>
DhruvaG2000
force-pushed
the
arduino-api-doc
branch
from
7676c2f to
c8db58a
Compare
|
5 participants
Add documentation for the Arduino Core API for zephyr which sits as an external module as of today.