Skip to content

Commit

Permalink
rm: linux: update: add recommendation about update script
Browse files Browse the repository at this point in the history
Many customers are performing git merges/cherry picks that will not bring
the git tag information.

We rely on that for support, so update the docs accordingly.

Signed-off-by: Vanessa Maegima <vanessa.maegima@foundries.io>
  • Loading branch information
vanmaegima committed Jan 7, 2025
1 parent 84c667f commit e8eaec5
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion source/reference-manual/linux/linux-update.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@ Updating Your Factory
^^^^^^^^^^^^^^^^

We provide the helper script ``update-factory-manifest`` to update your Factory to a new LmP release.

.. important::
We highly recommend using our script to perform the LmP update rather than doing manual git operations.
Our script brings the `LmP tags <https://github.com/foundriesio/lmp-manifest/tags>`_ information, that are missed with git merges or cherry pick.

This script tries to update your manifest to the latest LmP version available:

.. code-block::
Expand All @@ -48,7 +53,7 @@ This script tries to update your manifest to the latest LmP version available:
$ git checkout <branch to update>
$ ../lmp-tools/scripts/update-factory-manifest
New upstream release(s) have been found.
Merging local code with upstream release: 91
Merging local code with upstream release: 95
Proceed ? (y/n): y
If no merge conflicts are found, it merges your changes and pushes the updated manifest to your Factory, triggering a new platform build.
Expand Down

0 comments on commit e8eaec5

Please sign in to comment.