Skip to content

Commit e52efab

Browse files
authored
Do not mix up external tools for updating and for packaging
Explicitely tell the difference between external tools for updating and for packaging
1 parent a0c63b4 commit e52efab

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

source/packaging-guide/optional/updates.rst

+8-8
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ Currently, there is only one backend available to update AppImages : `ZSync2 <ht
2626

2727

2828

29-
Using appimagetool
30-
^^^^^^^^^^^^^^^^^^
29+
If packaged with appimagetool
30+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3131

3232
Use :code:`appimagetool -u` to embed update information (as specified in the AppImageSpec) and generate the corresponding :code:`.zsync` file you can upload to the place mentioned in the update information.
3333

@@ -47,22 +47,22 @@ is called the *update information*.
4747
Please see https://github.com/AppImage/AppImageSpec/blob/master/draft.md#update-information for a description of allowable types of update information.
4848

4949

50-
Using linuxdeploy
51-
^^^^^^^^^^^^^^^^^
50+
If packaged with linuxdeploy
51+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5252

5353
:ref:`linuxdeploy's <ref-linuxdeploy>` `AppImage plugin <https://github.com/linuxdeploy/linuxdeploy-plugin-appimage>`__ supports an environment variable ``$UPDATE_INFORMATION`` (or short ``$UPD_INFO``) that can be used to set the update information manually.
5454

5555
Please see `the README <https://github.com/linuxdeploy/linuxdeploy-plugin-appimage#optional-variables>`__ for details.
5656

5757

58-
Using linuxdeployqt
59-
^^^^^^^^^^^^^^^^^^^
58+
If packaged with linuxdeployqt
59+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6060

6161
:code:`linuxdeployqt` uses :code:`appimagetool` internally. If it recognizes that it is running on Travis CI, then it automatically generates the matching update information.
6262

6363

64-
Using electron-builder
65-
^^^^^^^^^^^^^^^^^^^^^^
64+
If packaged with electron-builder
65+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6666

6767
:code:`electron-builder` promotes its own updater scheme rather than the update information described in this documentation, in order to have the same mechanism on Linux as is used on Windows. Unfortunately this means that AppImages generated by :code:`electron-builder` cannot be updated using the usual tools.
6868

0 commit comments

Comments
 (0)