Tutorial docs #283
Tutorial docs #283
Conversation
|
|
||
|
|
||
| Using the same directory structure for both bare-metal and buildroot | ||
| ----------------------------------------------------------------------- |
There was a problem hiding this comment.
Nit: Newline after this.
|
|
||
| .. include:: example-workloads/example-br/run.sh | ||
| :code: bash | ||
|
|
There was a problem hiding this comment.
Nit: Consistent newlines (use 2 or 1 between paragraphs)
| .. todo:: Add (or link to) more detailed examples of bare-metal and rocc workloads. | ||
|
|
||
|
|
||
| Using the same directory structure for both bare-metal and buildroot |
There was a problem hiding this comment.
Looking at the other tutorials here (https://firemarshal.readthedocs.io/en/latest/Tutorials/custom.html), it looks like we really just need to add one on BuildRoot and not baremetal. Even then, the Fedora tutorial describes much of what you want... so I think if the docs really want to get fixed I would do the following:
-
Re-order the "Custom Workloads" tutorials to be 1. BuildRoot Linux Hello World (w/ descriptions of parameters probably taken from the existing Fedora tutorial), 2. Baremetal Hello World 3. Fedora Hello World.
-
For sharing, I think the
test/bare.yamlworkload already implements the baremetal hello world... instead of copying that we should repurpose it for the tutorial (I think that workload compile could be simplified). OR we can symlink the example from the test area (or vice version).
| We are ready to build and install the workload for FireSim! | ||
|
|
||
| :: | ||
|
|
||
| ./marshal -v build example-workloads/example-br.json | ||
| ./marshal -v install example-workloads/example-br.json |
There was a problem hiding this comment.
I would add this as a .. note:: since FireMarshal is separate from FireSim in the documentation.
There was a problem hiding this comment.
This Makefile only works for baremetal not Linux since you are using the unknown-elf compiler.
No description provided.