Skip to content

Commit 1636826

Browse files
committed
tips-and-tricks: Document masking in more detail
Closes #576
1 parent 85471fd commit 1636826

File tree

1 file changed

+36
-4
lines changed

1 file changed

+36
-4
lines changed

docs/tips-and-tricks.rst

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,44 @@ Then you deploy the commit::
4444
.. note::
4545

4646
The example here uses ``sudo`` for system installations because, unlike normal updates, downgrades are considered a privileged action. If the application is installed per-user you would run it as that user.
47-
48-
If you have Flatpak 1.5.0 or later, you can also prevent the app from being
49-
included in updates (either manual or automatic)::
5047

51-
$ flatpak mask org.gnome.Recipes
48+
Masking
49+
--------
5250

51+
Flatpak 1.5.0 or later allows to mask a ref to prevent it from being
52+
automatically updated or installed.
53+
54+
If the Flatpak remote is configured in user location,
55+
``flatpak mask --user`` needs to be used otherwise it defaults to
56+
system location. ``flatpak remote-list`` can be used to find the
57+
location of the Flatpak remote.
58+
59+
To list the currently masked patterns::
60+
61+
# System
62+
$ flatpak mask
63+
64+
# User
65+
$ flatpak mask --user
66+
67+
To mask a ref pattern::
68+
69+
# System
70+
$ flatpak mask org.example.brokenapp
71+
72+
# User
73+
$ flatpak mask --user org.example.brokenapp
74+
75+
# Mask only the beta branch of the ref
76+
$ flatpak mask org.example.brokenapp//beta
77+
78+
To remove a masked pattern::
79+
80+
# System
81+
$ flatpak mask --remove org.example.brokenapp
82+
83+
# User
84+
$ flatpak mask --user --remove org.example.brokenapp
5385

5486
Bisecting regressions in application builds
5587
-------------------------------------------

0 commit comments

Comments
 (0)