diff --git a/apidoc/ostree-sections.txt b/apidoc/ostree-sections.txt index 0ec1cfd3..440fe0c3 100644 --- a/apidoc/ostree-sections.txt +++ b/apidoc/ostree-sections.txt @@ -598,6 +598,7 @@ ostree_repo_pull_from_remotes_async ostree_repo_pull_from_remotes_finish ostree_repo_resolve_keyring_for_collection OSTREE_REPO_METADATA_REF +OSTREE_META_KEY_DEPLOY_COLLECTION_ID
diff --git a/src/libostree/ostree-repo.h b/src/libostree/ostree-repo.h index 11b7927e..6159fc24 100644 --- a/src/libostree/ostree-repo.h +++ b/src/libostree/ostree-repo.h @@ -1397,6 +1397,29 @@ gboolean ostree_repo_regenerate_summary (OstreeRepo *self, */ #define OSTREE_REPO_METADATA_REF "ostree-metadata" +/** + * OSTREE_META_KEY_DEPLOY_COLLECTION_ID: + * + * GVariant type `s`. This key can be used in the repo metadata which is stored + * in OSTREE_REPO_METADATA_REF as well as in the summary. The semantics of this + * are that the remote repository wants clients to update their remote config + * to add this collection ID (clients can't do P2P operations involving a + * remote without a collection ID configured on it, even if one is configured + * on the server side). Clients must never change or remove a collection ID + * already set in their remote config. + * + * Currently, OSTree does not implement changing a remote config based on this + * key, but it may do so in a later release, and until then clients such as + * Flatpak may implement it. + * + * This is a replacement for the similar metadata key implemented by flatpak, + * `xa.collection-id`, which is now deprecated as clients which supported it had + * bugs with their P2P implementations. + * + * Since: 2018.9 + */ +#define OSTREE_META_KEY_DEPLOY_COLLECTION_ID "ostree.deploy-collection-id" + G_END_DECLS