Skip to content

Commit

Permalink
Add links to QEMU section for flashing
Browse files Browse the repository at this point in the history
Links were added in two places:
- flashing instructions in admonition box which had previously only
  linked to supported boards
- x86 board page in a new "see also" admonition

QA steps: checked links, viewed rendered output to check for visual
errors.

This commit addresses FFTK-2618
This commit applies to FFTK-2619

Signed-off-by: Katrina Prosise <katrina.prosise@foundries.io>
  • Loading branch information
kprosise committed Jul 24, 2023
1 parent 911ecf1 commit 4e2f454
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 3 deletions.
6 changes: 4 additions & 2 deletions source/getting-started/flash-device/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,12 @@ After a successful build, FoundriesFactory produces build artifacts which can be
:align: center

.. note::
Most platforms require more than the ``lmp-base-console-image-<machine_name>.wic.gz`` artifact for flashing. The required artifacts are board specific and listed in respective pages under :ref:`ref-boards`. Targets publish all needed files for each platform under :guilabel:`Runs`.
Most platforms require more than the ``lmp-base-console-image-<machine_name>.wic.gz`` artifact for flashing.
The required artifacts are board specific and listed on respective pages under :ref:`ref-boards` or under :ref:`ref-qemu`.
Targets publish all needed files for each platform under :guilabel:`Runs`.

.. important::
When you create platform builds later on, the Factory image and artifacts may follow a slightly different naming pattern, such as ``lmp-factory-image-<machine_name>``.
When you create platform builds later on, the Factory image and artifacts may follow a slightly different naming pattern, such as ``lmp-factory-image-<machine_name>``.

.. _gs-flash-image:

Expand Down
5 changes: 4 additions & 1 deletion source/reference-manual/boards/x86.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@
x86
===

The instructions for any board based on x86 cores.
The instructions for boards based on x86 cores.

.. seealso::
Instructions on how to boot a :ref:`generic x86-64 image with QEMU <qemu-x86_64>`

.. toctree::
:maxdepth: 1
Expand Down
3 changes: 3 additions & 0 deletions source/reference-manual/qemu/x86_64.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. _qemu-x86_64:

Check failure on line 1 in source/reference-manual/qemu/x86_64.rst

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Fio-docs.Header-cap] 'x86_64': Use APA title case: https://apastyle.apa.org/style-grammar-guidelines/capitalization/title-case Raw Output: {"message": "[Fio-docs.Header-cap] 'x86_64': Use APA title case: https://apastyle.apa.org/style-grammar-guidelines/capitalization/title-case", "location": {"path": "source/reference-manual/qemu/x86_64.rst", "range": {"start": {"line": 1, "column": 10}}}, "severity": "ERROR"}


x86_64
======

Expand Down

0 comments on commit 4e2f454

Please sign in to comment.