From 4cbbbf2daa9e68fa9905ae3894f4fca54cb1eca6 Mon Sep 17 00:00:00 2001 From: Felix Krull Date: Fri, 16 Oct 2020 00:32:52 +0200 Subject: [PATCH] gir: update OSTree gir --- rust-bindings/rust/Makefile | 2 +- rust-bindings/rust/gir-files/OSTree-1.0.gir | 3298 +++++++++++-------- 2 files changed, 1841 insertions(+), 1459 deletions(-) diff --git a/rust-bindings/rust/Makefile b/rust-bindings/rust/Makefile index defd291c..324c0a11 100644 --- a/rust-bindings/rust/Makefile +++ b/rust-bindings/rust/Makefile @@ -1,7 +1,7 @@ GIR_REPO := https://github.com/gtk-rs/gir.git GIR_VERSION := 2d1ffab19eb5f9a2f0d7a294dbf07517dab4d989 OSTREE_REPO := https://github.com/ostreedev/ostree.git -OSTREE_VERSION := v2020.6 +OSTREE_VERSION := v2020.7 RUSTDOC_STRIPPER_VERSION := 0.1.13 all: gir diff --git a/rust-bindings/rust/gir-files/OSTree-1.0.gir b/rust-bindings/rust/gir-files/OSTree-1.0.gir index 27e35257..f90fe38c 100644 --- a/rust-bindings/rust/gir-files/OSTree-1.0.gir +++ b/rust-bindings/rust/gir-files/OSTree-1.0.gir @@ -578,14 +578,14 @@ Consult the source code in configure.ac (or the CLI `ostree --version`) for exam Copy of @self + line="46">Copy of @self Bootconfig to clone + line="44">Bootconfig to clone @@ -604,6 +604,28 @@ Consult the source code in configure.ac (or the CLI `ostree --version`) for exam + + + + Array of initrds or %NULL +if none are set. + + + + + + + Parser + + + + @@ -631,7 +653,7 @@ Consult the source code in configure.ac (or the CLI `ostree --version`) for exam throws="1"> Initialize a bootconfig from the given file. + line="61">Initialize a bootconfig from the given file. @@ -640,19 +662,19 @@ Consult the source code in configure.ac (or the CLI `ostree --version`) for exam Parser + line="63">Parser Directory fd + line="64">Directory fd File path + line="65">File path Cancellable + line="66">Cancellable @@ -683,6 +705,38 @@ Consult the source code in configure.ac (or the CLI `ostree --version`) for exam + + These are rendered as additional `initrd` keys in the final bootloader configs. The +base initrd is part of the primary keys. + + + + + + + Parser + + + + Array of overlay + initrds or %NULL to unset. + + + + + + @@ -1679,14 +1733,14 @@ that should have been under an explicit group. New deep copy of @self + line="193">New deep copy of @self Deployment + line="191">Deployment @@ -1696,20 +1750,20 @@ that should have been under an explicit group. %TRUE if deployments have the same osname, csum, and deployserial + line="241">%TRUE if deployments have the same osname, csum, and deployserial A deployment + line="238">A deployment A deployment + line="239">A deployment @@ -1811,21 +1865,21 @@ that should have been under an explicit group. c:identifier="ostree_deployment_get_origin_relpath"> Note this function only returns a *relative* path - if you want to + line="318">Note this function only returns a *relative* path - if you want to access, it, you must either use fd-relative api such as openat(), or concatenate it with the full ostree_sysroot_get_path(). Path to deployment root directory, relative to sysroot + line="326">Path to deployment root directory, relative to sysroot A deployment + line="320">A deployment @@ -1860,19 +1914,19 @@ or concatenate it with the full ostree_sysroot_get_path(). version="2018.3"> See ostree_sysroot_deployment_set_pinned(). + line="370">See ostree_sysroot_deployment_set_pinned(). `TRUE` if deployment will not be subject to GC + line="376">`TRUE` if deployment will not be subject to GC Deployment + line="372">Deployment @@ -1884,14 +1938,14 @@ or concatenate it with the full ostree_sysroot_get_path(). `TRUE` if deployment should be "finalized" at shutdown time + line="391">`TRUE` if deployment should be "finalized" at shutdown time Deployment + line="389">Deployment @@ -2805,7 +2859,7 @@ signature from trusted keyring, otherwise %FALSE - + @@ -3608,7 +3662,7 @@ exhaustion attacks. version="2018.9"> GVariant type `s`. This key can be used in the repo metadata which is stored + line="1459">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 @@ -3623,7 +3677,7 @@ 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. - + - + @@ -4240,7 +4294,7 @@ content, the other types are metadata. version="2018.6"> The name of a ref which is used to store metadata for the entire repository, + line="1436">The name of a ref which is used to store metadata for the entire repository, such as its expected update time (`ostree.summary.expires`), name, or new GPG keys. Metadata is stored on contentless commits in the ref, and hence is signed with the commits. @@ -4255,7 +4309,7 @@ collection ID (ostree_repo_set_collection_id()). Users of OSTree may place arbitrary metadata in commits on this ref, but the keys must be namespaced by product or developer. For example, `exampleos.end-of-life`. The `ostree.` prefix is reserved. - + glib:type-name="OstreeRepo" glib:get-type="ostree_repo_get_type"> - + - + Creates a new #OstreeRepo instance, taking the system root path explicitly instead of assuming "/". - + - + - + @@ -4517,7 +4571,7 @@ The @options dict may contain: line="1265">This combines ostree_repo_new() (but using fd-relative access) with ostree_repo_open(). Use this when you know you should be operating on an already extant repository. If you want to create one, use ostree_repo_create_at(). - + - + @@ -4591,7 +4645,7 @@ and @user_data is ignored. line="297">This hash table is a mapping from #GVariant which can be accessed via ostree_object_name_deserialize() to a #GVariant containing either a similar #GVariant or and array of them, listing the parents of the key. - + filename="ostree-repo-traverse.c" line="282">This hash table is a set of #GVariant which can be accessed via ostree_object_name_deserialize(). - + filename="ostree-repo-traverse.c" line="348">Gets all the commits that a certain object belongs to, as recorded by a parents table gotten from ostree_repo_traverse_commit_union_with_parents. - + discarded. You *must* invoke this if you have chosen not to invoke ostree_repo_commit_transaction(). Calling this function when not in a transaction will do nothing and return successfully. - + @@ -4685,7 +4739,7 @@ transaction will do nothing and return successfully. Add a GPG signature to a summary file. - + @@ -4730,7 +4784,7 @@ transaction will do nothing and return successfully. Append a GPG signature to a commit. - + @@ -4770,7 +4824,7 @@ transaction will do nothing and return successfully. throws="1"> Similar to ostree_repo_checkout_tree(), but uses directory-relative + line="1321">Similar to ostree_repo_checkout_tree(), but uses directory-relative paths for the destination, uses a new `OstreeRepoCheckoutAtOptions`, and takes a commit checksum and optional subpath pair, rather than requiring use of `GFile` APIs for the caller. @@ -4781,7 +4835,7 @@ use with GObject introspection. Note in addition that unlike ostree_repo_checkout_tree(), the default is not to use the repository-internal uncompressed objects cache. - + @@ -4789,7 +4843,7 @@ cache. Repo + line="1323">Repo allow-none="1"> Options + line="1324">Options Directory FD for destination + line="1325">Directory FD for destination Directory for destination + line="1326">Directory for destination Checksum for commit + line="1327">Checksum for commit allow-none="1"> Cancellable + line="1328">Cancellable @@ -4836,10 +4890,10 @@ cache. throws="1"> Call this after finishing a succession of checkout operations; it + line="1460">Call this after finishing a succession of checkout operations; it will delete any currently-unused uncompressed objects from the cache. - + @@ -4847,7 +4901,7 @@ cache. Repo + line="1462">Repo allow-none="1"> Cancellable + line="1463">Cancellable @@ -4866,11 +4920,11 @@ cache. throws="1"> Check out @source into @destination, which must live on the + line="1239">Check out @source into @destination, which must live on the physical filesystem. @source may be any subdirectory of a given commit. The @mode and @overwrite_mode allow control over how the files are checked out. - + @@ -4878,38 +4932,38 @@ files are checked out. Repo + line="1241">Repo Options controlling all files + line="1242">Options controlling all files Whether or not to overwrite files + line="1243">Whether or not to overwrite files Place tree here + line="1244">Place tree here Source tree + line="1245">Source tree Source info + line="1246">Source info allow-none="1"> Cancellable + line="1247">Cancellable @@ -4929,7 +4983,7 @@ files are checked out. throws="1"> Similar to ostree_repo_checkout_tree(), but uses directory-relative + line="1278">Similar to ostree_repo_checkout_tree(), but uses directory-relative paths for the destination, uses a new `OstreeRepoCheckoutAtOptions`, and takes a commit checksum and optional subpath pair, rather than requiring use of `GFile` APIs for the caller. @@ -4947,7 +5001,7 @@ This function is deprecated. Use ostree_repo_checkout_at() instead. Repo + line="1280">Repo allow-none="1"> Options + line="1281">Options Directory FD for destination + line="1282">Directory FD for destination Directory for destination + line="1283">Directory for destination Checksum for commit + line="1284">Checksum for commit allow-none="1"> Cancellable + line="1285">Cancellable @@ -5004,7 +5058,7 @@ have terminated before this function is invoked. Locking: Releases `shared` lock acquired by `ostree_repo_prepare_transaction()` Multithreading: This function is *not* MT safe; only one transaction can be active at a time. - + @@ -5040,7 +5094,7 @@ that happened during this transaction. - + - + @@ -5106,7 +5160,7 @@ this function on a repository initialized via ostree_repo_open_at(). line="4234">Remove the object of type @objtype with checksum @sha256 from the repository. An error of type %G_IO_ERROR_NOT_FOUND is thrown if the object does not exist. - + @@ -5146,7 +5200,7 @@ is thrown if the object does not exist. line="3508">Check whether two opened repositories are the same on disk: if their root directories are the same inode. If @a or @b are not open yet (due to ostree_repo_open() not being called on them yet), %FALSE will be returned. - + filename="ostree-repo-libarchive.c" line="1223">Import an archive file @archive into the repository, and write its file structure to @mtree. - + @@ -5225,7 +5279,7 @@ file structure to @mtree. version="2018.6"> Find reachable remote URIs which claim to provide any of the given named + line="4946">Find reachable remote URIs which claim to provide any of the given named @refs. This will search for configured remotes (#OstreeRepoFinderConfig), mounted volumes (#OstreeRepoFinderMount) and (if enabled at compile time) local network peers (#OstreeRepoFinderAvahi). In order to use a custom @@ -5265,7 +5319,7 @@ this is not guaranteed). GPG verification of commits will be used unconditionally. This will use the thread-default #GMainContext, but will not iterate it. - + @@ -5273,13 +5327,13 @@ This will use the thread-default #GMainContext, but will not iterate it. an #OstreeRepo + line="4948">an #OstreeRepo non-empty array of collection–ref pairs to find remotes for + line="4949">non-empty array of collection–ref pairs to find remotes for @@ -5290,13 +5344,13 @@ This will use the thread-default #GMainContext, but will not iterate it. allow-none="1"> a GVariant `a{sv}` with an extensible set of flags + line="4950">a GVariant `a{sv}` with an extensible set of flags non-empty array of + line="4951">non-empty array of #OstreeRepoFinder instances to use, or %NULL to use the system defaults @@ -5308,7 +5362,7 @@ This will use the thread-default #GMainContext, but will not iterate it. allow-none="1"> an #OstreeAsyncProgress to update with the operation’s + line="4953">an #OstreeAsyncProgress to update with the operation’s progress, or %NULL @@ -5318,7 +5372,7 @@ This will use the thread-default #GMainContext, but will not iterate it. allow-none="1"> a #GCancellable, or %NULL + line="4955">a #GCancellable, or %NULL closure="6"> asynchronous completion callback + line="4956">asynchronous completion callback allow-none="1"> data to pass to @callback + line="4957">data to pass to @callback @@ -5349,13 +5403,13 @@ This will use the thread-default #GMainContext, but will not iterate it. throws="1"> Finish an asynchronous pull operation started with + line="5743">Finish an asynchronous pull operation started with ostree_repo_find_remotes_async(). - + a potentially empty array + line="5752">a potentially empty array of #OstreeRepoFinderResults, followed by a %NULL terminator element; or %NULL on error @@ -5366,13 +5420,13 @@ ostree_repo_find_remotes_async(). an #OstreeRepo + line="5745">an #OstreeRepo the asynchronous result + line="5746">the asynchronous result @@ -5386,7 +5440,7 @@ ostree_repo_find_remotes_async(). line="4350">Verify consistency of the object; this performs checks only relevant to the immediate object itself, such as checksumming. This API call will not itself traverse metadata objects for example. - + @@ -5425,20 +5479,20 @@ traverse metadata objects for example. version="2019.2"> Get the bootloader configured. See the documentation for the + line="6244">Get the bootloader configured. See the documentation for the "sysroot.bootloader" config key. - + bootloader configuration for the sysroot + line="6251">bootloader configuration for the sysroot an #OstreeRepo + line="6246">an #OstreeRepo @@ -5448,25 +5502,25 @@ traverse metadata objects for example. version="2018.6"> Get the collection ID of this repository. See [collection IDs][collection-ids]. - + line="6172">Get the collection ID of this repository. See [collection IDs][collection-ids]. + collection ID for the repository + line="6178">collection ID for the repository an #OstreeRepo + line="6174">an #OstreeRepo - + version="2018.9"> Get the set of default repo finders configured. See the documentation for + line="6225">Get the set of default repo finders configured. See the documentation for the "core.default-repo-finders" config key. - + + line="6232"> %NULL-terminated array of strings. @@ -5500,7 +5554,7 @@ the "core.default-repo-finders" config key. an #OstreeRepo + line="6227">an #OstreeRepo @@ -5514,7 +5568,7 @@ the "core.default-repo-finders" config key. directly; for example, writing content into `repo/tmp` ensures it's on the same filesystem. Another case is detecting the mtime on the repository (to see whether a ref was written). - + For more information see ostree_repo_set_disable_fsync(). - + to the repo config and return that number in @out_reserved_bytes. See the documentation for the core.min-free-space-size and core.min-free-space-percent repo config options. - + - + @@ -5602,7 +5656,7 @@ core.min-free-space-percent repo config options. filename="ostree-repo.c" line="3568">Before this function can be used, ostree_repo_init() must have been called. - + line="3437">Note that since the introduction of ostree_repo_open_at(), this function may return a process-specific path in `/proc` if the repository was created using that API. In general, you should avoid use of this API. - + underneath that group, and returns it as a boolean. If the option is not set, @out_value will be set to @default_value. If an error is returned, @out_value will be set to %FALSE. - + underneath that group, and returns it as a zero terminated array of strings. If the option is not set, or if an error is returned, @out_value will be set to %NULL. - + `[remote "remotename"]`. This function returns a value named @option_name underneath that group, or @default_value if the remote exists but not the option name. If an error is returned, @out_value will be set to %NULL. - + The @remote_name parameter can be %NULL. In that case it will do the verifications using GPG keys in the keyrings of all remotes. - + filename="ostree-repo.c" line="4192">Set @out_have_object to %TRUE if @self contains the given object; %FALSE otherwise. - + - + filename="ostree-repo-libarchive.c" line="809">Import an archive file @archive into the repository, and write its file structure to @mtree. - + @@ -6028,7 +6082,7 @@ type and on the same filesystem, this will simply be a fast Unix hard link operation. Otherwise, a copy will be performed. - + @@ -6080,7 +6134,7 @@ repositories are of the same type and on the same filesystem, this will simply be a fast Unix hard link operation. Otherwise, a copy will be performed. - + @@ -6127,7 +6181,7 @@ Otherwise, a copy will be performed. - + filename="ostree-repo.c" line="1385">Returns whether the repository is writable by the current user. If the repository is not writable, the @error indicates why. - + - + This function synchronously enumerates all commit objects starting with @start, returning data in @out_commits. - + repository, returning data in @out_objects. @out_objects maps from keys returned by ostree_object_name_serialize() to #GVariant values of type %OSTREE_REPO_LIST_OBJECTS_VARIANT_TYPE. - + - + @@ -6412,7 +6466,7 @@ refspecs which have @refspec_prefix as a prefix. @out_all_refs will be returned as a mapping from refspecs (including the remote name) to checksums. Differently from ostree_repo_list_refs(), the @refspec_prefix will not be removed from the refspecs in the hash table. - + @@ -6468,9 +6522,9 @@ remote name) to checksums. Differently from ostree_repo_list_refs(), the throws="1"> This function synchronously enumerates all static deltas in the + line="80">This function synchronously enumerates all static deltas in the repository, returning its result in @out_deltas. - + @@ -6478,7 +6532,7 @@ repository, returning its result in @out_deltas. Repo + line="82">Repo transfer-ownership="container"> String name of deltas (checksum-checksum.delta) + line="83">String name of deltas (checksum-checksum.delta) @@ -6498,7 +6552,7 @@ repository, returning its result in @out_deltas. allow-none="1"> Cancellable + line="84">Cancellable @@ -6512,7 +6566,7 @@ repository, returning its result in @out_deltas. capable of returning extended state information. Currently the only extended state is %OSTREE_REPO_COMMIT_STATE_PARTIAL, which means that only a sub-path of the commit is available. - + @@ -6558,7 +6612,7 @@ means that only a sub-path of the commit is available. filename="ostree-repo.c" line="4031">Load content object, decomposing it into three parts: the actual content (for regular files), the metadata, and extended attributes. - + @@ -6629,7 +6683,7 @@ content (for regular files), the metadata, and extended attributes. filename="ostree-repo.c" line="4092">Load object as a stream; useful when copying objects between repositories. - + @@ -6688,7 +6742,7 @@ repositories. filename="ostree-repo.c" line="4499">Load the metadata object @sha256 of type @objtype, storing the result in @out_variant. - + @@ -6730,7 +6784,7 @@ result in @out_variant. line="4476">Attempt to load the metadata object @sha256 of type @objtype if it exists, storing the result in @out_variant. If it doesn't exist, %NULL is returned. - + @@ -6777,7 +6831,7 @@ pulls. This function is used by ostree_repo_pull_with_options(); you should use this if you are implementing a different type of transport. - + @@ -6815,7 +6869,7 @@ OSTREE_REPO_COMMIT_STATE_NORMAL. This will allow successive ostree fsck operations to exit properly with an error code if the repository has been truncated as a result of fsck trying to repair it. - + @@ -6847,7 +6901,7 @@ it. - + @@ -6885,7 +6939,7 @@ transaction. Locking: Acquires a `shared` lock; release via commit or abort Multithreading: This function is *not* MT safe; only one transaction can be active at a time. - + @@ -6938,7 +6992,7 @@ statistics on objects that would be deleted, without actually deleting them. Locking: exclusive - + @@ -7018,7 +7072,7 @@ The %OSTREE_REPO_PRUNE_FLAGS_NO_PRUNE flag may be specified to just determine statistics on objects that would be deleted, without actually deleting them. Locking: exclusive - + @@ -7083,7 +7137,7 @@ targeting that commit; otherwise any static delta of non existing commits are deleted. Locking: exclusive - + @@ -7134,7 +7188,7 @@ Warning: This API will iterate the thread default main context, which is a bug, but kept for compatibility reasons. If you want to avoid this, use g_main_context_push_thread_default() to push a new one around this call. - + @@ -7193,7 +7247,7 @@ one around this call. version="2018.6"> Pull refs from multiple remotes which have been found using + line="5791">Pull refs from multiple remotes which have been found using ostree_repo_find_remotes_async(). @results are expected to be in priority order, with the best remotes to pull @@ -7235,7 +7289,7 @@ The following @options are currently defined: not being pulled will be ignored and any ref without a keyring remote will be verified with the keyring of the remote being pulled from. Since: 2019.2 - + @@ -7243,13 +7297,13 @@ The following @options are currently defined: an #OstreeRepo + line="5793">an #OstreeRepo %NULL-terminated array of remotes to + line="5794">%NULL-terminated array of remotes to pull from, including the refs to pull from each @@ -7261,7 +7315,7 @@ The following @options are currently defined: allow-none="1"> A GVariant `a{sv}` with an extensible set of flags + line="5796">A GVariant `a{sv}` with an extensible set of flags an #OstreeAsyncProgress to update with the operation’s + line="5797">an #OstreeAsyncProgress to update with the operation’s progress, or %NULL @@ -7280,7 +7334,7 @@ The following @options are currently defined: allow-none="1"> a #GCancellable, or %NULL + line="5799">a #GCancellable, or %NULL asynchronous completion callback + line="5800">asynchronous completion callback data to pass to @callback + line="5801">data to pass to @callback @@ -7311,26 +7365,26 @@ The following @options are currently defined: throws="1"> Finish an asynchronous pull operation started with + line="6044">Finish an asynchronous pull operation started with ostree_repo_pull_from_remotes_async(). - + %TRUE on success, %FALSE otherwise + line="6053">%TRUE on success, %FALSE otherwise an #OstreeRepo + line="6046">an #OstreeRepo the asynchronous result + line="6047">the asynchronous result @@ -7342,7 +7396,7 @@ ostree_repo_pull_from_remotes_async(). filename="ostree-repo.c" line="4716">This is similar to ostree_repo_pull(), but only fetches a single subpath. - + @@ -7407,7 +7461,7 @@ subpath. throws="1"> Like ostree_repo_pull(), but supports an extensible set of flags. + line="3294">Like ostree_repo_pull(), but supports an extensible set of flags. The following are currently defined: * `refs` (`as`): Array of string refs @@ -7456,7 +7510,7 @@ The following are currently defined: specified, the `summary` will be downloaded from the remote. Since: 2020.5 * `summary-sig-bytes` (`ay`): Contents of the `summary.sig` file. If this is specified, `summary-bytes` must also be specified. Since: 2020.5 - + @@ -7464,19 +7518,19 @@ The following are currently defined: Repo + line="3296">Repo Name of remote or file:// url + line="3297">Name of remote or file:// url A GVariant a{sv} with an extensible set of flags. + line="3298">A GVariant a{sv} with an extensible set of flags. Progress + line="3299">Progress Cancellable + line="3300">Cancellable @@ -7506,7 +7560,7 @@ The following are currently defined: filename="ostree-repo.c" line="4440">Return the size in bytes of object with checksum @sha256, after any compression has been applied. - + @@ -7555,7 +7609,7 @@ compression has been applied. Load the content for @rev into @out_root. - + @@ -7609,7 +7663,7 @@ compression has been applied. line="3085">OSTree commits can have arbitrary metadata associated; this function retrieves them. If none exists, @out_metadata will be set to %NULL. - + @@ -7669,7 +7723,7 @@ and refs in %OSTREE_SUMMARY_COLLECTION_MAP are guaranteed to be in lexicographic order. Locking: exclusive - + @@ -7708,7 +7762,7 @@ Locking: exclusive filename="ostree-repo.c" line="3213">By default, an #OstreeRepo will cache the remote configuration and its own repo/config data. This API can be used to reload it. - + @@ -7742,7 +7796,7 @@ mapped as follows: * s: g_key_file_set_string() * b: g_key_file_set_boolean() * as: g_key_file_set_string_list() - + @@ -7793,7 +7847,7 @@ mapped as follows: line="1840">A combined function handling the equivalent of ostree_repo_remote_add(), ostree_repo_remote_delete(), with more options. - + @@ -7858,7 +7912,7 @@ options. filename="ostree-repo.c" line="1738">Delete the remote named @name. It is an error if the provided remote does not exist. - + @@ -7904,7 +7958,7 @@ Use ostree_repo_verify_summary() for that. Parse the summary data into a #GVariant using g_variant_new_from_bytes() with #OSTREE_SUMMARY_GVARIANT_FORMAT as the format string. - + throws="1"> Like ostree_repo_remote_fetch_summary(), but supports an extensible set of flags. + line="6069">Like ostree_repo_remote_fetch_summary(), but supports an extensible set of flags. The following are currently defined: - override-url (s): Fetch summary from this URL if remote specifies no metalink in options @@ -7974,24 +8028,24 @@ The following are currently defined: - n-network-retries (u): Number of times to retry each download on receiving a transient network error, such as a socket timeout; default is 5, 0 means return errors without retrying - + %TRUE on success, %FALSE on failure + line="6091">%TRUE on success, %FALSE on failure Self + line="6071">Self name of a remote + line="6072">name of a remote A GVariant a{sv} with an extensible set of flags + line="6073">A GVariant a{sv} with an extensible set of flags return location for raw summary data, or + line="6074">return location for raw summary data, or %NULL @@ -8023,7 +8077,7 @@ The following are currently defined: allow-none="1"> return location for raw summary + line="6076">return location for raw summary signature data, or %NULL @@ -8033,7 +8087,7 @@ The following are currently defined: allow-none="1"> a #GCancellable + line="6078">a #GCancellable @@ -8046,7 +8100,7 @@ The following are currently defined: line="2001">Return whether GPG verification is enabled for the remote named @name through @out_gpg_verify. It is an error if the provided remote does not exist. - + line="2035">Return whether GPG verification of the summary is enabled for the remote named @name through @out_gpg_verify_summary. It is an error if the provided remote does not exist. - + filename="ostree-repo.c" line="1958">Return the URL of the remote named @name through @out_url. It is an error if the provided remote does not exist. - + - + filename="ostree-repo.c" line="1907">List available remote names in an #OstreeRepo. Remote names are sorted alphabetically. If no remotes are available the function returns %NULL. - + - + @@ -8326,7 +8380,7 @@ No filtering is performed. - + @@ -8384,7 +8438,7 @@ returned. If you want to check only local refs, not remote or mirrored ones, use the flag %OSTREE_REPO_RESOLVE_REV_EXT_LOCAL_ONLY. This is analogous to using ostree_repo_resolve_rev_ext() but for collection-refs. - + - + line="447">Look up the given refspec, returning the checksum it references in the parameter @out_rev. Will fall back on remote directory if cannot find the given refspec in local. - + @@ -8545,7 +8599,7 @@ local ref is specified but not found. The flag %OSTREE_REPO_RESOLVE_REV_EXT_LOCAL_ONLY is implied so using it has no effect. - + @@ -8608,7 +8662,7 @@ before you call ostree_repo_write_directory_to_mtree() or similar. However, ostree_repo_devino_cache_new() is better as it avoids scanning all objects. Multithreading: This function is *not* MT safe. - + @@ -8637,7 +8691,7 @@ Multithreading: This function is *not* MT safe. Like ostree_repo_set_ref_immediate(), but creates an alias. - + @@ -8693,7 +8747,7 @@ Multithreading: This function is *not* MT safe. per-remote summary caches. Setting this manually is useful when doing operations on a system repo as a user because you don't have write permissions in the repo, where the cache is normally stored. - + @@ -8733,21 +8787,21 @@ write permissions in the repo, where the cache is normally stored. throws="1"> Set or clear the collection ID of this repository. See [collection IDs][collection-ids]. + line="6189">Set or clear the collection ID of this repository. See [collection IDs][collection-ids]. The update will be made in memory, but must be written out to the repository configuration on disk using ostree_repo_write_config(). - + %TRUE on success, %FALSE otherwise + line="6199">%TRUE on success, %FALSE otherwise an #OstreeRepo + line="6191">an #OstreeRepo allow-none="1"> new collection ID, or %NULL to unset it + line="6192">new collection ID, or %NULL to unset it @@ -8770,7 +8824,7 @@ configuration on disk using ostree_repo_write_config(). line="2337">This is like ostree_repo_transaction_set_collection_ref(), except it may be invoked outside of a transaction. This is presently safe for the case where we're creating or overwriting an existing ref. - + option should only be used by build system tools which are creating disposable virtual machines, or have higher level mechanisms for ensuring data consistency. - + @@ -8847,7 +8901,7 @@ invoked outside of a transaction. This is presently safe for the case where we're creating or overwriting an existing ref. Multithreading: This function is MT safe. - + @@ -8899,7 +8953,7 @@ Multithreading: This function is MT safe. Add a GPG signature to a commit. - + @@ -8949,7 +9003,7 @@ Multithreading: This function is MT safe. filename="ostree-repo.c" line="5133">This function is deprecated, sign the summary file instead. Add a GPG signature to a static delta. - + @@ -9000,11 +9054,11 @@ Add a GPG signature to a static delta. throws="1"> Given a directory representing an already-downloaded static delta + line="543">Given a directory representing an already-downloaded static delta on disk, apply it, generating a new commit. The directory must be named with the form "FROM-TO", where both are checksums, and it must contain a file named "superblock", along with at least one part. - + @@ -9012,19 +9066,19 @@ must contain a file named "superblock", along with at least one part. Repo + line="545">Repo Path to a directory containing static delta data, or directly to the superblock + line="546">Path to a directory containing static delta data, or directly to the superblock If %TRUE, assume data integrity + line="547">If %TRUE, assume data integrity allow-none="1"> Cancellable + line="548">Cancellable + + + + + + Given a directory representing an already-downloaded static delta +on disk, apply it, generating a new commit. +If sign is passed, the static delta signature is verified. +If sign-verify-deltas configuration option is set and static delta is signed, +signature verification will be mandatory before apply the static delta. +The directory must be named with the form "FROM-TO", where both are +checksums, and it must contain a file named "superblock", along with at least +one part. + + + + + + + Repo + + + + Path to a directory containing static delta data, or directly to the superblock + + + + Signature engine used to check superblock + + + + If %TRUE, assume data integrity + + + + Cancellable @@ -9043,7 +9151,7 @@ must contain a file named "superblock", along with at least one part. throws="1"> Generate a lookaside "static delta" from @from (%NULL means + line="1312">Generate a lookaside "static delta" from @from (%NULL means from-empty) which can generate the objects in @to. This delta is an optimization over fetching individual objects, and can be conveniently stored and applied offline. @@ -9059,8 +9167,10 @@ are known: - inline-parts: b: Put part data in header, to get a single file delta. Default FALSE. - verbose: b: Print diagnostic messages. Default FALSE. - endianness: b: Deltas use host byte order by default; this option allows choosing (G_BIG_ENDIAN or G_LITTLE_ENDIAN) - - filename: ay: Save delta superblock to this filename, and parts in the same directory. Default saves to repository. - + - filename: ay: Save delta superblock to this filename, and parts in the same directory. Default saves to repository. + - sign-name: ay: Signature type to use. + - sign-key-ids: as: Array of keys used to sign delta superblock. + @@ -9068,26 +9178,26 @@ are known: Repo + line="1314">Repo High level optimization choice + line="1315">High level optimization choice ASCII SHA256 checksum of origin, or %NULL + line="1316">ASCII SHA256 checksum of origin, or %NULL ASCII SHA256 checksum of target + line="1317">ASCII SHA256 checksum of target Optional metadata + line="1318">Optional metadata Parameters, see below + line="1319">Parameters, see below Cancellable + line="1320">Cancellable + + Verify static delta file signature. + + + TRUE if the signature of static delta file is valid using the +signature engine provided, FALSE otherwise. + + + + + Repo + + + + delta path + + + + Signature engine used to check superblock + + + + success message + + + + @@ -9136,7 +9288,7 @@ is instead aborted with ostree_repo_abort_transaction(), no changes will be made to the repository. Multithreading: Since v2017.15 this function is MT safe. - + @@ -9189,7 +9341,7 @@ will have been updated. Your application should take care to handle this case. Multithreading: Since v2017.15 this function is MT safe. - + @@ -9235,7 +9387,7 @@ Multithreading: Since v2017.15 this function is MT safe. arguments. Multithreading: Since v2017.15 this function is MT safe. - + @@ -9270,7 +9422,7 @@ Multithreading: Since v2017.15 this function is MT safe. filename="ostree-repo-traverse.c" line="665">Create a new set @out_reachable containing all objects reachable from @commit_checksum, traversing @maxdepth parent commits. - + @@ -9324,7 +9476,7 @@ from @commit_checksum, traversing @maxdepth parent commits. filename="ostree-repo-traverse.c" line="639">Update the set @inout_reachable containing all objects reachable from @commit_checksum, traversing @maxdepth parent commits. - + @@ -9380,7 +9532,7 @@ from @commit_checksum, traversing @maxdepth parent commits. Additionally this constructs a mapping from each object to the parents of the object, which can be used to track which commits an object belongs to. - + @@ -9441,7 +9593,7 @@ belongs to. line="307">Add all commit objects directly reachable via a ref to @reachable. Locking: shared - + @@ -9485,7 +9637,7 @@ Locking: shared filename="ostree-repo.c" line="5461">Check for a valid GPG signature on commit named by the ASCII checksum @commit_checksum. - + filename="ostree-repo.c" line="5499">Read GPG signature(s) on the commit named by the ASCII checksum @commit_checksum and return detailed results. - + line="5535">Read GPG signature(s) on the commit named by the ASCII checksum @commit_checksum and return detailed results, based on the keyring configured for @remote. - + filename="ostree-repo.c" line="5622">Verify @signatures for @summary data using GPG keys in the keyring for @remote_name, and return an #OstreeGpgVerifyResult. - + filename="ostree-repo-libarchive.c" line="937">Import an archive file @archive into the repository, and write its file structure to @mtree. - + @@ -9750,7 +9902,7 @@ file structure to @mtree. filename="ostree-repo-libarchive.c" line="972">Read an archive from @fd and import it into the repository, writing its file structure to @mtree. - + @@ -9807,7 +9959,7 @@ its file structure to @mtree. filename="ostree-repo-commit.c" line="2999">Write a commit metadata object, referencing @root_contents_checksum and @root_metadata_checksum. - + @@ -9888,7 +10040,7 @@ and @root_metadata_checksum. line="3133">Replace any existing metadata associated with commit referred to by @checksum with @metadata. If @metadata is %NULL, then existing data will be deleted. - + @@ -9932,7 +10084,7 @@ data will be deleted. filename="ostree-repo-commit.c" line="3031">Write a commit metadata object, referencing @root_contents_checksum and @root_metadata_checksum. - + @@ -10017,7 +10169,7 @@ and @root_metadata_checksum. Save @new_config in place of this repository's config file. - + @@ -10044,7 +10196,7 @@ and @root_metadata_checksum. line="2824">Store the content object streamed as @object_input, with total length @length. The actual checksum will be returned as @out_csum. - + @@ -10106,7 +10258,7 @@ be returned as @out_csum. filename="ostree-repo-commit.c" line="2922">Asynchronously store the content object @object. If provided, the checksum @expected_checksum will be verified. - + @@ -10175,7 +10327,7 @@ checksum @expected_checksum will be verified. Completes an invocation of ostree_repo_write_content_async(). - + @@ -10213,7 +10365,7 @@ length @length. The given @checksum will be treated as trusted. This function should be used when importing file objects from local disk, for example. - + @@ -10258,10 +10410,10 @@ disk, for example. throws="1"> Store as objects all contents of the directory referred to by @dfd + line="4088">Store as objects all contents of the directory referred to by @dfd and @path all children into the repository @self, overlaying the resulting filesystem hierarchy into @mtree. - + @@ -10269,25 +10421,25 @@ resulting filesystem hierarchy into @mtree. Repo + line="4090">Repo Directory file descriptor + line="4091">Directory file descriptor Path + line="4092">Path Overlay directory contents into this tree + line="4093">Overlay directory contents into this tree allow-none="1"> Optional modifier + line="4094">Optional modifier @@ -10306,7 +10458,7 @@ resulting filesystem hierarchy into @mtree. allow-none="1"> Cancellable + line="4095">Cancellable @@ -10316,9 +10468,9 @@ resulting filesystem hierarchy into @mtree. throws="1"> Store objects for @dir and all children into the repository @self, + line="4047">Store objects for @dir and all children into the repository @self, overlaying the resulting filesystem hierarchy into @mtree. - + @@ -10326,19 +10478,19 @@ overlaying the resulting filesystem hierarchy into @mtree. Repo + line="4049">Repo Path to a directory + line="4050">Path to a directory Overlay directory contents into this tree + line="4051">Overlay directory contents into this tree allow-none="1"> Optional modifier + line="4052">Optional modifier @@ -10357,7 +10509,7 @@ overlaying the resulting filesystem hierarchy into @mtree. allow-none="1"> Cancellable + line="4053">Cancellable @@ -10372,7 +10524,7 @@ as @out_csum. If @expected_checksum is not %NULL, verify it against the computed checksum. - + @@ -10434,7 +10586,7 @@ computed checksum. filename="ostree-repo-commit.c" line="2706">Asynchronously store the metadata object @variant. If provided, the checksum @expected_checksum will be verified. - + @@ -10503,7 +10655,7 @@ the checksum @expected_checksum will be verified. Complete a call to ostree_repo_write_metadata_async(). - + @@ -10540,7 +10692,7 @@ the checksum @expected_checksum will be verified. filename="ostree-repo-commit.c" line="2604">Store the metadata object @variant; the provided @checksum is trusted. - + @@ -10593,7 +10745,7 @@ trusted. filename="ostree-repo-commit.c" line="2641">Store the metadata object @variant; the provided @checksum is trusted. - + @@ -10638,10 +10790,10 @@ trusted. throws="1"> Write all metadata objects for @mtree to repo; the resulting + line="4138">Write all metadata objects for @mtree to repo; the resulting @out_file points to the %OSTREE_OBJECT_TYPE_DIR_TREE object that the @mtree represented. - + @@ -10649,13 +10801,13 @@ the @mtree represented. Repo + line="4140">Repo Mutable tree + line="4141">Mutable tree transfer-ownership="full"> An #OstreeRepoFile representing @mtree's root. + line="4142">An #OstreeRepoFile representing @mtree's root. allow-none="1"> Cancellable + line="4143">Cancellable @@ -10752,12 +10904,12 @@ is called. An extensible options structure controlling checkout. Ensure that + line="938">An extensible options structure controlling checkout. Ensure that you have entirely zeroed the structure, then set just the desired options. This is used by ostree_repo_checkout_at() which supercedes previous separate enumeration usage in ostree_repo_checkout_tree() and ostree_repo_checkout_tree_at(). - + @@ -10824,12 +10976,12 @@ ostree_repo_checkout_tree() and ostree_repo_checkout_tree_at(). version="2017.13"> This function simply assigns @cache to the `devino_to_csum_cache` member of + line="1404">This function simply assigns @cache to the `devino_to_csum_cache` member of @opts; it's only useful for introspection. Note that cache does *not* have its refcount incremented - the lifetime of @cache must be equal to or greater than that of @opts. - + @@ -10837,7 +10989,7 @@ Note that cache does *not* have its refcount incremented - the lifetime of Checkout options + line="1406">Checkout options @@ -10847,7 +10999,7 @@ Note that cache does *not* have its refcount incremented - the lifetime of allow-none="1"> Devino cache + line="1407">Devino cache @@ -10856,11 +11008,11 @@ Note that cache does *not* have its refcount incremented - the lifetime of - + #OstreeRepoCheckoutFilterResult saying whether or not to checkout this file + line="929">#OstreeRepoCheckoutFilterResult saying whether or not to checkout this file @@ -10868,13 +11020,13 @@ Note that cache does *not* have its refcount incremented - the lifetime of Repo + line="924">Repo Path to file + line="925">Path to file File information + line="926">File information User data + line="927">User data @@ -10901,37 +11053,37 @@ Note that cache does *not* have its refcount incremented - the lifetime of - + Do checkout this object + line="912">Do checkout this object Ignore this object + line="913">Ignore this object - + No special options + line="877">No special options Ignore uid/gid of files + line="878">Ignore uid/gid of files - + No special options + line="887">No special options When layering checkouts, unlink() and replace existing files, but do not modify existing directories (unless whiteouts are enabled, then directories are replaced) + line="888">When layering checkouts, unlink() and replace existing files, but do not modify existing directories (unless whiteouts are enabled, then directories are replaced) Only add new files/directories + line="889">Only add new files/directories Like UNION_FILES, but error if files are not identical (requires hardlink checkouts) + line="890">Like UNION_FILES, but error if files are not identical (requires hardlink checkouts) - + #OstreeRepoCommitFilterResult saying whether or not to commit this file + line="637">#OstreeRepoCommitFilterResult saying whether or not to commit this file @@ -11029,19 +11181,19 @@ ostree_repo_checkout_tree(). Repo + line="632">Repo Path to file + line="633">Path to file File information + line="634">File information closure="3"> User data + line="635">User data - + Do commit this object + line="622">Do commit this object Ignore this object + line="623">Ignore this object - + @@ -11101,21 +11253,21 @@ ostree_repo_checkout_tree(). c:symbol-prefix="repo_commit_modifier"> A structure allowing control over commits. - + line="664">A structure allowing control over commits. + - + A new commit modifier. + line="4226">A new commit modifier. Control options for filter + line="4221">Control options for filter @@ -11128,7 +11280,7 @@ ostree_repo_checkout_tree(). destroy="3"> Function that can inspect individual files + line="4222">Function that can inspect individual files allow-none="1"> User data + line="4223">User data scope="async"> A #GDestroyNotify + line="4224">A #GDestroyNotify - + @@ -11167,7 +11319,7 @@ ostree_repo_checkout_tree(). version="2017.13"> See the documentation for + line="4377">See the documentation for `ostree_repo_devino_cache_new()`. This function can then be used for later calls to `ostree_repo_write_directory_to_mtree()` to optimize commits. @@ -11177,7 +11329,7 @@ Note if your process has multiple writers, you should use separate This function will add a reference to @cache without copying - you should avoid further mutation of the cache. - + @@ -11185,14 +11337,14 @@ should avoid further mutation of the cache. Modifier + line="4379">Modifier A hash table caching device,inode to checksums + line="4380">A hash table caching device,inode to checksums @@ -11201,7 +11353,7 @@ should avoid further mutation of the cache. c:identifier="ostree_repo_commit_modifier_set_sepolicy"> If @policy is non-%NULL, use it to look up labels to use for + line="4299">If @policy is non-%NULL, use it to look up labels to use for "security.selinux" extended attributes. Note that any policy specified this way operates in addition to any @@ -11209,7 +11361,7 @@ extended attributes provided via ostree_repo_commit_modifier_set_xattr_callback(). However if both specify a value for "security.selinux", then the one from the policy wins. - + @@ -11217,7 +11369,7 @@ policy wins. An #OstreeRepoCommitModifier + line="4301">An #OstreeRepoCommitModifier @@ -11227,7 +11379,7 @@ policy wins. allow-none="1"> Policy to use for labeling + line="4302">Policy to use for labeling @@ -11238,10 +11390,10 @@ policy wins. throws="1"> In many cases, one wants to create a "derived" commit from base commit. + line="4321">In many cases, one wants to create a "derived" commit from base commit. SELinux policy labels are part of that base commit. This API allows one to easily set up SELinux labeling from a base commit. - + @@ -11249,20 +11401,20 @@ one to easily set up SELinux labeling from a base commit. Commit modifier + line="4323">Commit modifier OSTree repo containing @rev + line="4324">OSTree repo containing @rev Find SELinux policy from this base commit + line="4325">Find SELinux policy from this base commit c:identifier="ostree_repo_commit_modifier_set_xattr_callback"> If set, this function should return extended attributes to use for + line="4276">If set, this function should return extended attributes to use for the given path. This is useful for things like ACLs and SELinux, where a build system can label the files as it's committing to the repository. - + @@ -11289,7 +11441,7 @@ repository. An #OstreeRepoCommitModifier + line="4278">An #OstreeRepoCommitModifier @@ -11300,14 +11452,14 @@ repository. destroy="1"> Function to be invoked, should return extended attributes for path + line="4279">Function to be invoked, should return extended attributes for path Destroy notification + line="4280">Destroy notification allow-none="1"> Data for @callback: + line="4281">Data for @callback: - + @@ -11336,60 +11488,60 @@ repository. - + No special flags + line="646">No special flags Do not process extended attributes + line="647">Do not process extended attributes Generate size information. + line="648">Generate size information. Canonicalize permissions for bare-user-only mode. + line="649">Canonicalize permissions for bare-user-only mode. Emit an error if configured SELinux policy does not provide a label + line="650">Emit an error if configured SELinux policy does not provide a label Delete added files/directories after commit; Since: 2017.13 + line="651">Delete added files/directories after commit; Since: 2017.13 If a devino cache hit is found, skip modifier filters (non-directories only); Since: 2017.14 + line="652">If a devino cache hit is found, skip modifier filters (non-directories only); Since: 2017.14 - + @@ -11417,15 +11569,15 @@ repository. c:type="OstreeRepoCommitState"> Flags representing the state of a commit in the local repository, as returned + line="252">Flags representing the state of a commit in the local repository, as returned by ostree_repo_load_commit(). - + Commit is complete. This is the default. + line="254">Commit is complete. This is the default. (Since: 2017.14.) c:identifier="OSTREE_REPO_COMMIT_STATE_PARTIAL"> One or more objects are missing from the + line="256">One or more objects are missing from the local copy of the commit, but metadata is present. (Since: 2015.7.) c:identifier="OSTREE_REPO_COMMIT_STATE_FSCK_PARTIAL"> One or more objects are missing from the + line="258">One or more objects are missing from the local copy of the commit, due to an fsck --delete. (Since: 2019.4.) - + @@ -11455,7 +11607,7 @@ by ostree_repo_load_commit(). - + @@ -11471,7 +11623,7 @@ by ostree_repo_load_commit(). - + @@ -11489,7 +11641,7 @@ by ostree_repo_load_commit(). line="235">Return information on the current directory. This function may only be called if %OSTREE_REPO_COMMIT_ITER_RESULT_DIR was returned from ostree_repo_commit_traverse_iter_next(). - + @@ -11537,7 +11689,7 @@ from ostree_repo_commit_traverse_iter_next(). line="214">Return information on the current file. This function may only be called if %OSTREE_REPO_COMMIT_ITER_RESULT_FILE was returned from ostree_repo_commit_traverse_iter_next(). - + @@ -11575,7 +11727,7 @@ ostree_repo_commit_traverse_iter_next(). Initialize (in place) an iterator over the root of a commit object. - + @@ -11614,7 +11766,7 @@ ostree_repo_commit_traverse_iter_next(). Initialize (in place) an iterator over a directory tree. - + @@ -11664,7 +11816,7 @@ ostree_repo_commit_traverse_iter_get_file(). If %OSTREE_REPO_COMMIT_ITER_RESULT_ERROR is returned, it is a program error to call any further API on @iter except for ostree_repo_commit_traverse_iter_clear(). - + @@ -11690,7 +11842,7 @@ ostree_repo_commit_traverse_iter_clear(). - + @@ -11713,23 +11865,23 @@ ostree_repo_commit_traverse_iter_clear(). OSTree has support for pairing ostree_repo_checkout_tree_at() using + line="1441">OSTree has support for pairing ostree_repo_checkout_tree_at() using hardlinks in combination with a later ostree_repo_write_directory_to_mtree() using a (normally modified) directory. In order for OSTree to optimally detect just the new files, use this function and fill in the `devino_to_csum_cache` member of `OstreeRepoCheckoutAtOptions`, then call ostree_repo_commit_set_devino_cache(). - + Newly allocated cache + line="1452">Newly allocated cache - + @@ -11740,7 +11892,7 @@ ostree_repo_commit_set_devino_cache(). - + @@ -11756,10 +11908,10 @@ ostree_repo_commit_set_devino_cache(). introspectable="0"> An extensible options structure controlling archive creation. Ensure that + line="802">An extensible options structure controlling archive creation. Ensure that you have entirely zeroed the structure, then set just the desired options. This is used by ostree_repo_export_tree_to_archive(). - + @@ -12989,10 +13141,10 @@ to pull from, and hence needs to be ordered before the other. introspectable="0"> An extensible options structure controlling archive import. Ensure that + line="773">An extensible options structure controlling archive import. Ensure that you have entirely zeroed the structure, then set just the desired options. This is used by ostree_repo_import_archive_to_mtree(). - + @@ -13031,7 +13183,7 @@ options. This is used by ostree_repo_import_archive_to_mtree(). version="2017.11"> Possibly change a pathname while importing an archive. If %NULL is returned, + line="748">Possibly change a pathname while importing an archive. If %NULL is returned, then @src_path will be used unchanged. Otherwise, return a new pathname which will be freed via `g_free()`. @@ -13041,7 +13193,7 @@ types, first with outer directories, then their sub-files and directories. Note that enabling pathname translation will always override the setting for `use_ostree_convention`. - + @@ -13049,7 +13201,7 @@ Note that enabling pathname translation will always override the setting for Repo + line="750">Repo Stat buffer + line="751">Stat buffer Path in the archive + line="752">Path in the archive User data + line="753">User data - + List only loose (plain file) objects + line="1009">List only loose (plain file) objects List only packed (compacted into blobs) objects + line="1010">List only packed (compacted into blobs) objects List all objects + line="1011">List all objects Only list objects in this repo, not parents + line="1012">Only list objects in this repo, not parents - + No flags. + line="509">No flags. Only list aliases. Since: 2017.10 + line="510">Only list aliases. Since: 2017.10 Exclude remote refs. Since: 2017.11 + line="511">Exclude remote refs. Since: 2017.11 Exclude mirrored refs. Since: 2019.2 + line="512">Exclude mirrored refs. Since: 2019.2 @@ -13178,31 +13330,31 @@ possible modes. - + No special options for pruning + line="1188">No special options for pruning Don't actually delete objects + line="1189">Don't actually delete objects Do not traverse individual commit objects, only follow refs + line="1190">Do not traverse individual commit objects, only follow refs - + @@ -13229,105 +13381,105 @@ possible modes. - + No special options for pull + line="1247">No special options for pull Write out refs suitable for mirrors and fetch all refs if none requested + line="1248">Write out refs suitable for mirrors and fetch all refs if none requested Fetch only the commit metadata + line="1249">Fetch only the commit metadata Do verify checksums of local (filesystem-accessible) repositories (defaults on for HTTP) + line="1250">Do verify checksums of local (filesystem-accessible) repositories (defaults on for HTTP) Since 2017.7. Reject writes of content objects with modes outside of 0775. + line="1251">Since 2017.7. Reject writes of content objects with modes outside of 0775. Don't verify checksums of objects HTTP repositories (Since: 2017.12) + line="1252">Don't verify checksums of objects HTTP repositories (Since: 2017.12) The remote change operation. - + line="166">The remote change operation. + Add a remote + line="169">Add a remote Like above, but do nothing if the remote exists + line="170">Like above, but do nothing if the remote exists Delete a remote + line="171">Delete a remote Delete a remote, do nothing if the remote does not exist + line="172">Delete a remote, do nothing if the remote does not exist Add or replace a remote (Since: 2019.2) + line="173">Add or replace a remote (Since: 2019.2) - + No flags. + line="475">No flags. Exclude remote and mirrored refs. Since: 2019.2 + line="476">Exclude remote and mirrored refs. Since: 2019.2 c:symbol-prefix="repo_transaction_stats"> A list of statistics for each transaction that may be + line="272">A list of statistics for each transaction that may be interesting for reporting purposes. - + The total number of metadata objects + line="274">The total number of metadata objects in the repository after this transaction has completed. The number of metadata objects that + line="276">The number of metadata objects that were written to the repository in this transaction. The total number of content objects + line="278">The total number of content objects in the repository after this transaction has completed. The number of content objects that + line="280">The number of content objects that were written to the repository in this transaction. The amount of data added to the repository, + line="282">The amount of data added to the repository, in bytes, counting only content objects. @@ -13381,25 +13533,25 @@ in bytes, counting only content objects. reserved + line="284">reserved reserved + line="285">reserved reserved + line="286">reserved reserved + line="287">reserved @@ -15264,21 +15416,21 @@ Based on ostree_repo_add_gpg_signature_summary implementation. c:type="OstreeStaticDeltaGenerateOpt"> Parameters controlling optimization of static deltas. - + line="1049">Parameters controlling optimization of static deltas. + Optimize for speed of delta creation over space + line="1051">Optimize for speed of delta creation over space Optimize for delta size (may be very slow) + line="1052">Optimize for delta size (may be very slow) Create a new #OstreeSysroot object for the sysroot at @path. If @path is %NULL, + line="202">Create a new #OstreeSysroot object for the sysroot at @path. If @path is %NULL, the current visible root file system is used, equivalent to ostree_sysroot_new_default(). An accessor object for an system root located at @path + line="211">An accessor object for an system root located at @path @@ -15307,7 +15459,7 @@ ostree_sysroot_new_default(). allow-none="1"> Path to a system root directory, or %NULL to use the + line="204">Path to a system root directory, or %NULL to use the current visible root file system @@ -15319,7 +15471,7 @@ ostree_sysroot_new_default(). An accessor for the current visible root / filesystem + line="222">An accessor for the current visible root / filesystem @@ -15329,14 +15481,14 @@ ostree_sysroot_new_default(). Path to deployment origin file + line="1271">Path to deployment origin file A deployment path + line="1269">A deployment path @@ -15344,7 +15496,7 @@ ostree_sysroot_new_default(). Delete any state that resulted from a partially completed + line="543">Delete any state that resulted from a partially completed transaction, such as incomplete deployments. @@ -15354,7 +15506,7 @@ transaction, such as incomplete deployments. Sysroot + line="545">Sysroot allow-none="1"> Cancellable + line="546">Cancellable @@ -15374,7 +15526,7 @@ transaction, such as incomplete deployments. throws="1"> Prune the system repository. This is a thin wrapper + line="467">Prune the system repository. This is a thin wrapper around ostree_repo_prune_from_reachable(); the primary addition is that this function automatically gathers all deployed commits into the reachable set. @@ -15391,13 +15543,13 @@ Locking: exclusive Sysroot + line="469">Sysroot Flags controlling pruning + line="470">Flags controlling pruning transfer-ownership="full"> Number of objects found + line="471">Number of objects found transfer-ownership="full"> Number of objects deleted + line="472">Number of objects deleted transfer-ownership="full"> Storage size in bytes of objects deleted + line="473">Storage size in bytes of objects deleted allow-none="1"> Cancellable + line="474">Cancellable - Check out deployment tree with revision @revision, performing a 3 -way merge with @provided_merge_deployment for configuration. - -When booted into the sysroot, you should use the -ostree_sysroot_stage_tree() API instead. - - - - - - - Sysroot - - - - osname to use for merge deployment - - - - Checksum to add - - - - Origin to use for upgrades - - - - Use this deployment for merge path - - - - Use these as kernel arguments; if %NULL, inherit options from provided_merge_deployment - - - - - - The new deployment path - - - - Cancellable - - - - - - Entirely replace the kernel arguments of @deployment with the -values in @new_kargs. - - - - - - - Sysroot - - - - A deployment - - - - Replace deployment's kernel arguments - - - - - - Cancellable - - - - - - By default, deployment directories are not mutable. This function -will allow making them temporarily mutable, for example to allow -layering additional non-OSTree content. - - - - - - - Sysroot - - - - A deployment - - - - Whether or not deployment's files can be changed - - - - Cancellable - - - - - - By default, deployments may be subject to garbage collection. Typical uses of -libostree only retain at most 2 deployments. If @is_pinned is `TRUE`, a -metadata bit will be set causing libostree to avoid automatic GC of the -deployment. However, this is really an "advisory" note; it's still possible -for e.g. older versions of libostree unaware of pinning to GC the deployment. - -This function does nothing and returns successfully if the deployment -is already in the desired pinning state. It is an error to try to pin -the staged deployment (as it's not in the bootloader entries). - - - - - - - Sysroot - - - - A deployment - - - - Whether or not deployment will be automatically GC'd - - - - - - Configure the target deployment @deployment such that it -is writable. There are multiple modes, essentially differing -in whether or not any changes persist across reboot. - -The `OSTREE_DEPLOYMENT_UNLOCKED_HOTFIX` state is persistent -across reboots. - - - - - - - Sysroot - - - - Deployment - - - - Transition to this unlocked state - - - - Cancellable - - - - - - Ensure that @self is set up as a valid rootfs, by creating -/ostree/repo, among other things. - - - - - - - Sysroot - - - - Cancellable - - - - - - - - The currently booted deployment, or %NULL if none - - - - - Sysroot - - - - - - - - - - - - - - - - - - - Path to deployment root directory - - - - - Sysroot - - - - A deployment - - - - - - Note this function only returns a *relative* path - if you want -to access, it, you must either use fd-relative api such as openat(), -or concatenate it with the full ostree_sysroot_get_path(). - - - Path to deployment root directory, relative to sysroot - - - - - Repo - - - - A deployment - - - - - - - - Ordered list of deployments - - - - - - - Sysroot - - - - - - Access a file descriptor that refers to the root directory of this sysroot. -ostree_sysroot_initialize() (or ostree_sysroot_load()) must have been invoked -prior to calling this function. - - - A file descriptor valid for the lifetime of @self - - - - - Sysroot - - - - - - Find the deployment to use as a configuration merge source; this is -the first one in the current deployment list which matches osname. - - - Configuration merge deployment - - - - - Sysroot - - - - Operating system group - - - - - - - - Path to rootfs - - - - - - - - - - Retrieve the OSTree repository in sysroot @self. The repo is guaranteed to be open -(see ostree_repo_open()). - - - %TRUE on success, %FALSE otherwise - - - - - Sysroot - - - - Repository in sysroot @self - - - - Cancellable - - - - - - - - The currently staged deployment, or %NULL if none - - - - - Sysroot - - - - - - - - - - - - - - - - - Initialize the directory structure for an "osname", which is a -group of operating system deployments, with a shared `/var`. One -is required for generating a deployment. - - - - - - - Sysroot - - - - Name group of operating system checkouts - - - - Cancellable - - - - - - Subset of ostree_sysroot_load(); performs basic initialization. Notably, one -can invoke `ostree_sysroot_get_fd()` after calling this function. - -It is not necessary to call this function if ostree_sysroot_load() is -invoked. - - - - - - - sysroot - - - - - - Can only be invoked after `ostree_sysroot_initialize()`. - - - %TRUE iff the sysroot points to a booted deployment - - - - - Sysroot - - - - - - Load deployment list, bootversion, and subbootversion from the -rootfs @self. - - - - - - - Sysroot - - - - Cancellable - - - - - - - - - - - - #OstreeSysroot - - - - - - - Cancellable - - - - - - Acquire an exclusive multi-process write lock for @self. This call -blocks until the lock has been acquired. The lock is not -reentrant. - -Release the lock with ostree_sysroot_unlock(). The lock will also -be released if @self is deallocated. - - - - - - - Self - - - - - - An asynchronous version of ostree_sysroot_lock(). - - - - - - - Self - - - - Cancellable - - - - Callback - - - - User data - - - - - - Call when ostree_sysroot_lock_async() is ready. - - - - - - - Self - - - - Result - - - - - - - - A new config file which sets @refspec as an origin - - - - - Sysroot - - - - A refspec - - - - - - Like ostree_sysroot_cleanup() in that it cleans up incomplete deployments -and old boot versions, but does NOT prune the repository. - - - - - - - Sysroot - - - - Cancellable - - - - - - Find the pending and rollback deployments for @osname. Pass %NULL for @osname -to use the booted deployment's osname. By default, pending deployment is the -first deployment in the order that matches @osname, and @rollback will be the -next one after the booted deployment, or the deployment after the pending if -we're not looking at the booted deployment. - - - - - - - Sysroot - - - - "stateroot" name - - - - The pending deployment - - - - The rollback deployment - - - - - - This function is a variant of ostree_sysroot_get_repo() that cannot fail, and -returns a cached repository. Can only be called after ostree_sysroot_initialize() -or ostree_sysroot_load() has been invoked successfully. - - - The OSTree repository in sysroot @self. - - - - - Sysroot - - - - - - If this function is invoked, then libostree will assume that -a private Linux mount namespace has been created by the process. -The primary use case for this is to have e.g. /sysroot mounted -read-only by default. - -If this function has been called, then when a function which requires -writable access is invoked, libostree will automatically remount as writable -any mount points on which it operates. This currently is just `/sysroot` and -`/boot`. - -If you invoke this function, it must be before ostree_sysroot_load(); it may -be invoked before or after ostree_sysroot_initialize(). - - - - - - - - - - - - Prepend @new_deployment to the list of deployments, commit, and -cleanup. By default, all other deployments for the given @osname -except the merge deployment and the booted deployment will be -garbage collected. - -If %OSTREE_SYSROOT_SIMPLE_WRITE_DEPLOYMENT_FLAGS_RETAIN is -specified, then all current deployments will be kept. - -If %OSTREE_SYSROOT_SIMPLE_WRITE_DEPLOYMENT_FLAGS_RETAIN_PENDING is -specified, then pending deployments will be kept. - -If %OSTREE_SYSROOT_SIMPLE_WRITE_DEPLOYMENT_FLAGS_RETAIN_ROLLBACK is -specified, then rollback deployments will be kept. - -If %OSTREE_SYSROOT_SIMPLE_WRITE_DEPLOYMENT_FLAGS_NOT_DEFAULT is -specified, then instead of prepending, the new deployment will be -added right after the booted or merge deployment, instead of first. - -If %OSTREE_SYSROOT_SIMPLE_WRITE_DEPLOYMENT_FLAGS_NO_CLEAN is -specified, then no cleanup will be performed after adding the -deployment. Make sure to call ostree_sysroot_cleanup() sometime -later, instead. - - - - - - - Sysroot - - - - OS name - - - - Prepend this deployment to the list - - - - Use this deployment for configuration merge - - - - Flags controlling behavior - - - - Cancellable - - - - - Like ostree_sysroot_deploy_tree(), but "finalization" only occurs at OS -shutdown time. - + line="2954">Older version of ostree_sysroot_stage_tree_with_options(). + @@ -16482,7 +15632,7 @@ shutdown time. line="2959">Origin to use for upgrades - @@ -16522,12 +15672,1220 @@ shutdown time. + + Check out deployment tree with revision @revision, performing a 3 +way merge with @provided_merge_deployment for configuration. + +When booted into the sysroot, you should use the +ostree_sysroot_stage_tree() API instead. + + + + + + + Sysroot + + + + osname to use for merge deployment + + + + Checksum to add + + + + Origin to use for upgrades + + + + Use this deployment for merge path + + + + Options + + + + The new deployment path + + + + Cancellable + + + + + + Entirely replace the kernel arguments of @deployment with the +values in @new_kargs. + + + + + + + Sysroot + + + + A deployment + + + + Replace deployment's kernel arguments + + + + + + Cancellable + + + + + + By default, deployment directories are not mutable. This function +will allow making them temporarily mutable, for example to allow +layering additional non-OSTree content. + + + + + + + Sysroot + + + + A deployment + + + + Whether or not deployment's files can be changed + + + + Cancellable + + + + + + By default, deployments may be subject to garbage collection. Typical uses of +libostree only retain at most 2 deployments. If @is_pinned is `TRUE`, a +metadata bit will be set causing libostree to avoid automatic GC of the +deployment. However, this is really an "advisory" note; it's still possible +for e.g. older versions of libostree unaware of pinning to GC the deployment. + +This function does nothing and returns successfully if the deployment +is already in the desired pinning state. It is an error to try to pin +the staged deployment (as it's not in the bootloader entries). + + + + + + + Sysroot + + + + A deployment + + + + Whether or not deployment will be automatically GC'd + + + + + + Configure the target deployment @deployment such that it +is writable. There are multiple modes, essentially differing +in whether or not any changes persist across reboot. + +The `OSTREE_DEPLOYMENT_UNLOCKED_HOTFIX` state is persistent +across reboots. + + + + + + + Sysroot + + + + Deployment + + + + Transition to this unlocked state + + + + Cancellable + + + + + + Ensure that @self is set up as a valid rootfs, by creating +/ostree/repo, among other things. + + + + + + + Sysroot + + + + Cancellable + + + + + + + + The currently booted deployment, or %NULL if none + + + + + Sysroot + + + + + + + + + + + + + + + + + + + Path to deployment root directory + + + + + Sysroot + + + + A deployment + + + + + + Note this function only returns a *relative* path - if you want +to access, it, you must either use fd-relative api such as openat(), +or concatenate it with the full ostree_sysroot_get_path(). + + + Path to deployment root directory, relative to sysroot + + + + + Repo + + + + A deployment + + + + + + + + Ordered list of deployments + + + + + + + Sysroot + + + + + + Access a file descriptor that refers to the root directory of this sysroot. +ostree_sysroot_initialize() (or ostree_sysroot_load()) must have been invoked +prior to calling this function. + + + A file descriptor valid for the lifetime of @self + + + + + Sysroot + + + + + + Find the deployment to use as a configuration merge source; this is +the first one in the current deployment list which matches osname. + + + Configuration merge deployment + + + + + Sysroot + + + + Operating system group + + + + + + + + Path to rootfs + + + + + + + + + + Retrieve the OSTree repository in sysroot @self. The repo is guaranteed to be open +(see ostree_repo_open()). + + + %TRUE on success, %FALSE otherwise + + + + + Sysroot + + + + Repository in sysroot @self + + + + Cancellable + + + + + + + + The currently staged deployment, or %NULL if none + + + + + Sysroot + + + + + + + + + + + + + + + + + Initialize the directory structure for an "osname", which is a +group of operating system deployments, with a shared `/var`. One +is required for generating a deployment. + + + + + + + Sysroot + + + + Name group of operating system checkouts + + + + Cancellable + + + + + + Subset of ostree_sysroot_load(); performs basic initialization. Notably, one +can invoke `ostree_sysroot_get_fd()` after calling this function. + +It is not necessary to call this function if ostree_sysroot_load() is +invoked. + + + + + + + sysroot + + + + + + Can only be invoked after `ostree_sysroot_initialize()`. + + + %TRUE iff the sysroot points to a booted deployment + + + + + Sysroot + + + + + + Load deployment list, bootversion, and subbootversion from the +rootfs @self. + + + + + + + Sysroot + + + + Cancellable + + + + + + + + + + + + #OstreeSysroot + + + + + + + Cancellable + + + + + + Acquire an exclusive multi-process write lock for @self. This call +blocks until the lock has been acquired. The lock is not +reentrant. + +Release the lock with ostree_sysroot_unlock(). The lock will also +be released if @self is deallocated. + + + + + + + Self + + + + + + An asynchronous version of ostree_sysroot_lock(). + + + + + + + Self + + + + Cancellable + + + + Callback + + + + User data + + + + + + Call when ostree_sysroot_lock_async() is ready. + + + + + + + Self + + + + Result + + + + + + + + A new config file which sets @refspec as an origin + + + + + Sysroot + + + + A refspec + + + + + + Like ostree_sysroot_cleanup() in that it cleans up incomplete deployments +and old boot versions, but does NOT prune the repository. + + + + + + + Sysroot + + + + Cancellable + + + + + + Find the pending and rollback deployments for @osname. Pass %NULL for @osname +to use the booted deployment's osname. By default, pending deployment is the +first deployment in the order that matches @osname, and @rollback will be the +next one after the booted deployment, or the deployment after the pending if +we're not looking at the booted deployment. + + + + + + + Sysroot + + + + "stateroot" name + + + + The pending deployment + + + + The rollback deployment + + + + + + This function is a variant of ostree_sysroot_get_repo() that cannot fail, and +returns a cached repository. Can only be called after ostree_sysroot_initialize() +or ostree_sysroot_load() has been invoked successfully. + + + The OSTree repository in sysroot @self. + + + + + Sysroot + + + + + + If this function is invoked, then libostree will assume that +a private Linux mount namespace has been created by the process. +The primary use case for this is to have e.g. /sysroot mounted +read-only by default. + +If this function has been called, then when a function which requires +writable access is invoked, libostree will automatically remount as writable +any mount points on which it operates. This currently is just `/sysroot` and +`/boot`. + +If you invoke this function, it must be before ostree_sysroot_load(); it may +be invoked before or after ostree_sysroot_initialize(). + + + + + + + + + + + + Prepend @new_deployment to the list of deployments, commit, and +cleanup. By default, all other deployments for the given @osname +except the merge deployment and the booted deployment will be +garbage collected. + +If %OSTREE_SYSROOT_SIMPLE_WRITE_DEPLOYMENT_FLAGS_RETAIN is +specified, then all current deployments will be kept. + +If %OSTREE_SYSROOT_SIMPLE_WRITE_DEPLOYMENT_FLAGS_RETAIN_PENDING is +specified, then pending deployments will be kept. + +If %OSTREE_SYSROOT_SIMPLE_WRITE_DEPLOYMENT_FLAGS_RETAIN_ROLLBACK is +specified, then rollback deployments will be kept. + +If %OSTREE_SYSROOT_SIMPLE_WRITE_DEPLOYMENT_FLAGS_NOT_DEFAULT is +specified, then instead of prepending, the new deployment will be +added right after the booted or merge deployment, instead of first. + +If %OSTREE_SYSROOT_SIMPLE_WRITE_DEPLOYMENT_FLAGS_NO_CLEAN is +specified, then no cleanup will be performed after adding the +deployment. Make sure to call ostree_sysroot_cleanup() sometime +later, instead. + + + + + + + Sysroot + + + + OS name + + + + Prepend this deployment to the list + + + + Use this deployment for configuration merge + + + + Flags controlling behavior + + + + Cancellable + + + + + + Stage an overlay initrd to be used in an upcoming deployment. Returns a checksum which +can be passed to ostree_sysroot_deploy_tree_with_options() or +ostree_sysroot_stage_tree_with_options() via the `overlay_initrds` array option. + + + + + + + Sysroot + + + + File descriptor to overlay initrd + + + + Overlay initrd checksum + + + + Cancellable + + + + + + Older version of ostree_sysroot_stage_tree_with_options(). + + + + + + + Sysroot + + + + osname to use for merge deployment + + + + Checksum to add + + + + Origin to use for upgrades + + + + Use this deployment for merge path + + + + Use these as kernel arguments; if %NULL, inherit options from provided_merge_deployment + + + + + + The new deployment path + + + + Cancellable + + + + + + Like ostree_sysroot_deploy_tree(), but "finalization" only occurs at OS +shutdown time. + + + + + + + Sysroot + + + + osname to use for merge deployment + + + + Checksum to add + + + + Origin to use for upgrades + + + + Use this deployment for merge path + + + + Options + + + + The new deployment path + + + + Cancellable + + + + Try to acquire an exclusive multi-process write lock for @self. If + line="1525">Try to acquire an exclusive multi-process write lock for @self. If another process holds the lock, this function will return immediately, setting @out_acquired to %FALSE, and returning %TRUE (and no error). @@ -16542,7 +16900,7 @@ be released if @self is deallocated. Self + line="1527">Self transfer-ownership="full"> Whether or not the lock has been acquired + line="1528">Whether or not the lock has been acquired @@ -16559,7 +16917,7 @@ be released if @self is deallocated. Release any resources such as file descriptors referring to the + line="367">Release any resources such as file descriptors referring to the root directory of this sysroot. Normally, those resources are cleared by finalization, but in garbage collected languages that may not be predictable. @@ -16573,7 +16931,7 @@ This undoes the effect of `ostree_sysroot_load()`. Sysroot + line="369">Sysroot @@ -16581,7 +16939,7 @@ This undoes the effect of `ostree_sysroot_load()`. Clear the lock previously acquired with ostree_sysroot_lock(). It + line="1573">Clear the lock previously acquired with ostree_sysroot_lock(). It is safe to call this function if the lock has not been previously acquired. @@ -16592,7 +16950,7 @@ acquired. Self + line="1575">Self @@ -16602,7 +16960,7 @@ acquired. throws="1"> Older version of ostree_sysroot_write_deployments_with_options(). This + line="2282">Older version of ostree_sysroot_write_deployments_with_options(). This version will perform post-deployment cleanup by default. @@ -16612,13 +16970,13 @@ version will perform post-deployment cleanup by default. Sysroot + line="2284">Sysroot List of new deployments + line="2285">List of new deployments @@ -16629,7 +16987,7 @@ version will perform post-deployment cleanup by default. allow-none="1"> Cancellable + line="2286">Cancellable @@ -16640,7 +16998,7 @@ version will perform post-deployment cleanup by default. throws="1"> Assuming @new_deployments have already been deployed in place on disk via + line="2408">Assuming @new_deployments have already been deployed in place on disk via ostree_sysroot_deploy_tree(), atomically update bootloader configuration. By default, no post-transaction cleanup will be performed. You should invoke ostree_sysroot_cleanup() at some point after the transaction, or specify @@ -16654,13 +17012,13 @@ if for example you want to control pruning of the repository. Sysroot + line="2410">Sysroot List of new deployments + line="2411">List of new deployments @@ -16668,7 +17026,7 @@ if for example you want to control pruning of the repository. Options + line="2412">Options @@ -16678,7 +17036,7 @@ if for example you want to control pruning of the repository. allow-none="1"> Cancellable + line="2413">Cancellable @@ -16756,9 +17114,33 @@ Currently, the structured data is only available via the systemd journal. + + + + + + + + + + + + + + + + + + + + + + + + - + @@ -17310,7 +17692,7 @@ users who had been using zero before. - +