ref: Document thread-safety

State that FlatpakRef objects are immutable and
can thus be used freely across threads.

Closes: #2141
Approved by: alexlarsson
This commit is contained in:
Matthias Clasen
2018-09-26 11:29:52 -04:00
committed by Atomic Bot
parent 8132978169
commit 24d70fee0a

View File

@@ -29,7 +29,7 @@
* @Title: FlatpakRef
* @Short_description: Application reference
*
* Currently flatpak manages two types of binary artifacts: applications, and
* Currently Flatpak manages two types of binary artifacts: applications, and
* runtimes. Applications contain a program that desktop users can run, while
* runtimes contain only libraries and data. An FlatpakRef object (or short: ref)
* can refer to either of these.
@@ -39,6 +39,8 @@
* flatpak_ref_parse() and flatpak_ref_format_ref() can be used to convert
* FlatpakRef objects into this string representation and back.
*
* FlatpakRef objects are immutable and can be passed freely between threads.
*
* To uniquely identify a particular version of an application or runtime, you
* need a commit.
*