shaba/ostree
1
0
Fork 0
mirror of https://github.com/ostreedev/ostree.git synced 2024-12-22 17:35:55 +03:00
Code Issues Projects Releases Wiki Activity
4d0e3a66c5
ostree/apidoc/ostree-sections.txt

730 lines
19 KiB
Plaintext
Raw Normal View History

doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
<SECTION>
docs: Get API docs working again This changes around a few things that didn't work for me: * Section names seem to be ostree-* instead of libostree-* * Also XML files are ostree-* (they didn't show up at all) - gtk-doc doesn't seem to parse const _OSTREE_PUBLIC correctly * pull documentation is now on the actual functions rather than stubs * Update gitignore with some more files And there some changes to make gtk-doc give fewer warnings (not finished) Closes: #327 Approved by: cgwalters
2016-06-05 01:16:05 +03:00
<FILE>ostree-async-progress</FILE>
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
OstreeAsyncProgress
ostree_async_progress_new
ostree_async_progress_new_and_connect
libostree: Add ostree_async_progress_copy_state() This allows copying the state from one OstreeAsyncProgress object to another, atomically, without invoking the callback. This is needed in libflatpak, in order to chain OstreeAsyncProgress objects so that you can still receive progress updates when iterating a different GMainContext than the one that the OstreeAsyncProgress object was created under. See https://github.com/flatpak/flatpak/pull/3211 for the application of this API.
2019-11-05 00:21:36 +03:00
ostree_async_progress_copy_state
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_async_progress_get_status
libostree: Add multiple getter/setter support to OstreeAsyncProgress OstreeAsyncProgress is thread-safe: it can have keys changed by one thread while another is getting the same keys (modulo some locking contention). However, the thread safety is done at the function call level: if some code calls an OstreeAsyncProgress getter several times, the key fetches are not atomic with respect to each other. In the case of contention on the lock, this can result in consumers of OstreeAsyncProgress data seeing an inconsistent state between the properties they query, which could result in progress reporting inaccuracies. In the uncontested case, this results in the OstreeAsyncProgress lock being locked and unlocked many times more than necessary. Try to improve this by adding new API, which supports getting and setting multiple keys atomically: • ostree_async_progress_get() • ostree_async_progress_set() The new API uses GVariants and varargs: keys are passed as a GVariantType string followed by arguments as for g_variant_new() or g_variant_get(), followed by the next key, etc. Signed-off-by: Philip Withnall <withnall@endlessm.com> Closes: #819 Approved by: cgwalters
2017-04-28 18:18:55 +03:00
ostree_async_progress_get
libostree: Rework OstreeAsyncProgress to use GVariants internally OstreeAsyncProgress currently does some contortions to try and avoid allocating space for guints and guint64s (on 64-bit platforms), but this means it uses two GHashTables. A GHashTable allocates 8 buckets even when empty. Given that the largest usage of OstreeAsyncProgress in libostree puts 13 uints and 5 uint64s in it, this optimisation does not save significant (if any) memory. Instead, change OstreeAsyncProgress to store values internally as GVariants, and expose this with some new API: • ostree_async_progress_get_variant() • ostree_async_progress_set_variant() Each GVariant is allocated on the heap. As they are immutable, they are thread-safe once returned by a getter. The existing API continues to work as before, except in the case where a key is set/got as both a uint and a uint64 — there will now be a collision (and a GVariant type checking failure) whereas previously there was no collision. Nothing in OSTree uses OstreeAsyncProgress this way though. The new API can be used to share more complex data via the progress API. Signed-off-by: Philip Withnall <withnall@endlessm.com> Closes: #819 Approved by: cgwalters
2017-04-28 18:06:40 +03:00
ostree_async_progress_get_variant
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_async_progress_get_uint
ostree_async_progress_get_uint64
ostree_async_progress_set_status
libostree: Add multiple getter/setter support to OstreeAsyncProgress OstreeAsyncProgress is thread-safe: it can have keys changed by one thread while another is getting the same keys (modulo some locking contention). However, the thread safety is done at the function call level: if some code calls an OstreeAsyncProgress getter several times, the key fetches are not atomic with respect to each other. In the case of contention on the lock, this can result in consumers of OstreeAsyncProgress data seeing an inconsistent state between the properties they query, which could result in progress reporting inaccuracies. In the uncontested case, this results in the OstreeAsyncProgress lock being locked and unlocked many times more than necessary. Try to improve this by adding new API, which supports getting and setting multiple keys atomically: • ostree_async_progress_get() • ostree_async_progress_set() The new API uses GVariants and varargs: keys are passed as a GVariantType string followed by arguments as for g_variant_new() or g_variant_get(), followed by the next key, etc. Signed-off-by: Philip Withnall <withnall@endlessm.com> Closes: #819 Approved by: cgwalters
2017-04-28 18:18:55 +03:00
ostree_async_progress_set
libostree: Rework OstreeAsyncProgress to use GVariants internally OstreeAsyncProgress currently does some contortions to try and avoid allocating space for guints and guint64s (on 64-bit platforms), but this means it uses two GHashTables. A GHashTable allocates 8 buckets even when empty. Given that the largest usage of OstreeAsyncProgress in libostree puts 13 uints and 5 uint64s in it, this optimisation does not save significant (if any) memory. Instead, change OstreeAsyncProgress to store values internally as GVariants, and expose this with some new API: • ostree_async_progress_get_variant() • ostree_async_progress_set_variant() Each GVariant is allocated on the heap. As they are immutable, they are thread-safe once returned by a getter. The existing API continues to work as before, except in the case where a key is set/got as both a uint and a uint64 — there will now be a collision (and a GVariant type checking failure) whereas previously there was no collision. Nothing in OSTree uses OstreeAsyncProgress this way though. The new API can be used to share more complex data via the progress API. Signed-off-by: Philip Withnall <withnall@endlessm.com> Closes: #819 Approved by: cgwalters
2017-04-28 18:06:40 +03:00
ostree_async_progress_set_variant
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_async_progress_set_uint
ostree_async_progress_set_uint64
ostree_async_progress_finish
<SUBSECTION Standard>
OSTREE_ASYNC_PROGRESS
OSTREE_IS_ASYNC_PROGRESS
OSTREE_TYPE_ASYNC_PROGRESS
OSTREE_ASYNC_PROGRESS_CLASS
OSTREE_IS_ASYNC_PROGRESS_CLASS
OSTREE_ASYNC_PROGRESS_GET_CLASS
OstreeAsyncProgressClass
ostree_async_progress_get_type
</SECTION>
<SECTION>
docs: Get API docs working again This changes around a few things that didn't work for me: * Section names seem to be ostree-* instead of libostree-* * Also XML files are ostree-* (they didn't show up at all) - gtk-doc doesn't seem to parse const _OSTREE_PUBLIC correctly * pull documentation is now on the actual functions rather than stubs * Update gitignore with some more files And there some changes to make gtk-doc give fewer warnings (not finished) Closes: #327 Approved by: cgwalters
2016-06-05 01:16:05 +03:00
<FILE>ostree-bootconfig-parser</FILE>
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
OstreeBootconfigParser
ostree_bootconfig_parser_new
ostree_bootconfig_parser_clone
ostree_bootconfig_parser_parse
Rename test-abi to test-symbols, start verifying symbols are documented We keep forgetting to update `apidoc/ostree-sections.txt`, so let's start enforcing it. Of course it turns out we had some bugs here like symbols marked as public but never implemented, etc. Those are fixed in the prior commits. Closes: #263 Approved by: giuseppe
2016-04-15 22:49:05 +03:00
ostree_bootconfig_parser_parse_at
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_bootconfig_parser_write
Rename test-abi to test-symbols, start verifying symbols are documented We keep forgetting to update `apidoc/ostree-sections.txt`, so let's start enforcing it. Of course it turns out we had some bugs here like symbols marked as public but never implemented, etc. Those are fixed in the prior commits. Closes: #263 Approved by: giuseppe
2016-04-15 22:49:05 +03:00
ostree_bootconfig_parser_write_at
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_bootconfig_parser_set
ostree_bootconfig_parser_get
<SUBSECTION Standard>
OSTREE_BOOTCONFIG_PARSER
OSTREE_IS_BOOTCONFIG_PARSER
OSTREE_TYPE_BOOTCONFIG_PARSER
ostree_bootconfig_parser_get_type
</SECTION>
<SECTION>
docs: Get API docs working again This changes around a few things that didn't work for me: * Section names seem to be ostree-* instead of libostree-* * Also XML files are ostree-* (they didn't show up at all) - gtk-doc doesn't seem to parse const _OSTREE_PUBLIC correctly * pull documentation is now on the actual functions rather than stubs * Update gitignore with some more files And there some changes to make gtk-doc give fewer warnings (not finished) Closes: #327 Approved by: cgwalters
2016-06-05 01:16:05 +03:00
<FILE>ostree-chain-input-stream</FILE>
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
OstreeChainInputStream
ostree_chain_input_stream_new
<SUBSECTION Standard>
OSTREE_CHAIN_INPUT_STREAM
OSTREE_IS_CHAIN_INPUT_STREAM
OSTREE_TYPE_CHAIN_INPUT_STREAM
OSTREE_CHAIN_INPUT_STREAM_CLASS
OSTREE_IS_CHAIN_INPUT_STREAM_CLASS
OSTREE_CHAIN_INPUT_STREAM_GET_CLASS
OstreeChainInputStreamClass
OstreeChainInputStreamPrivate
ostree_chain_input_stream_get_type
</SECTION>
<SECTION>
docs: Get API docs working again This changes around a few things that didn't work for me: * Section names seem to be ostree-* instead of libostree-* * Also XML files are ostree-* (they didn't show up at all) - gtk-doc doesn't seem to parse const _OSTREE_PUBLIC correctly * pull documentation is now on the actual functions rather than stubs * Update gitignore with some more files And there some changes to make gtk-doc give fewer warnings (not finished) Closes: #327 Approved by: cgwalters
2016-06-05 01:16:05 +03:00
<FILE>ostree-checksum-input-stream</FILE>
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
OstreeChecksumInputStream
ostree_checksum_input_stream_new
<SUBSECTION Standard>
OSTREE_CHECKSUM_INPUT_STREAM
OSTREE_IS_CHECKSUM_INPUT_STREAM
OSTREE_TYPE_CHECKSUM_INPUT_STREAM
OSTREE_CHECKSUM_INPUT_STREAM_CLASS
OSTREE_IS_CHECKSUM_INPUT_STREAM_CLASS
OSTREE_CHECKSUM_INPUT_STREAM_GET_CLASS
OstreeChecksumInputStreamClass
OstreeChecksumInputStreamPrivate
ostree_checksum_input_stream_get_type
</SECTION>
Fix a few gtk-doc warnings Just continuing to chip away at this. Closes: #788 Approved by: jlebon
2017-04-12 04:54:14 +03:00
<SECTION>
<FILE>ostree-version</FILE>
OSTREE_CHECK_VERSION
OSTREE_YEAR_VERSION
OSTREE_RELEASE_VERSION
OSTREE_VERSION
OSTREE_VERSION_S
OSTREE_VERSION_HEX
</SECTION>
Add gtk-doc support Yes, it's really me. Colin Walters. Writing documentation. You don't need to do a DNA test.
2013-08-17 06:54:35 +04:00
<SECTION>
docs: Get API docs working again This changes around a few things that didn't work for me: * Section names seem to be ostree-* instead of libostree-* * Also XML files are ostree-* (they didn't show up at all) - gtk-doc doesn't seem to parse const _OSTREE_PUBLIC correctly * pull documentation is now on the actual functions rather than stubs * Update gitignore with some more files And there some changes to make gtk-doc give fewer warnings (not finished) Closes: #327 Approved by: cgwalters
2016-06-05 01:16:05 +03:00
<FILE>ostree-core</FILE>
Add gtk-doc support Yes, it's really me. Colin Walters. Writing documentation. You don't need to do a DNA test.
2013-08-17 06:54:35 +04:00
OSTREE_MAX_METADATA_SIZE
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
OSTREE_MAX_METADATA_WARN_SIZE
Add gtk-doc support Yes, it's really me. Colin Walters. Writing documentation. You don't need to do a DNA test.
2013-08-17 06:54:35 +04:00
OstreeObjectType
OSTREE_OBJECT_TYPE_IS_META
OSTREE_OBJECT_TYPE_LAST
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
OSTREE_DIRMETA_GVARIANT_STRING
Add gtk-doc support Yes, it's really me. Colin Walters. Writing documentation. You don't need to do a DNA test.
2013-08-17 06:54:35 +04:00
OSTREE_DIRMETA_GVARIANT_FORMAT
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
OSTREE_FILEMETA_GVARIANT_STRING
OSTREE_FILEMETA_GVARIANT_FORMAT
OSTREE_TREE_GVARIANT_STRING
Add gtk-doc support Yes, it's really me. Colin Walters. Writing documentation. You don't need to do a DNA test.
2013-08-17 06:54:35 +04:00
OSTREE_TREE_GVARIANT_FORMAT
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
OSTREE_COMMIT_GVARIANT_STRING
Add gtk-doc support Yes, it's really me. Colin Walters. Writing documentation. You don't need to do a DNA test.
2013-08-17 06:54:35 +04:00
OSTREE_COMMIT_GVARIANT_FORMAT
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
OSTREE_SUMMARY_GVARIANT_STRING
OSTREE_SUMMARY_GVARIANT_FORMAT
Add gtk-doc support Yes, it's really me. Colin Walters. Writing documentation. You don't need to do a DNA test.
2013-08-17 06:54:35 +04:00
ostree_metadata_variant_type
ostree_validate_checksum_string
ostree_checksum_to_bytes
ostree_checksum_to_bytes_v
libostree: More gtk-doc updates for ostree-core
2013-08-17 18:54:00 +04:00
ostree_checksum_from_bytes
ostree_checksum_from_bytes_v
ostree_checksum_inplace_from_bytes
ostree_checksum_inplace_to_bytes
ostree_checksum_bytes_peek
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_checksum_bytes_peek_validate
core: Add allocating b64 checksum functions The checksum_b64_inplace variants can't be used in bindings. Provide versions that allocate and return the output rather than working on a passed in buffer. These can then be used in GI bindings to get the ostree modified base64 encodings. Closes: #398 Approved by: cgwalters
2016-07-14 19:09:12 +03:00
ostree_checksum_b64_from_bytes
ostree_checksum_b64_to_bytes
Rename test-abi to test-symbols, start verifying symbols are documented We keep forgetting to update `apidoc/ostree-sections.txt`, so let's start enforcing it. Of course it turns out we had some bugs here like symbols marked as public but never implemented, etc. Those are fixed in the prior commits. Closes: #263 Approved by: giuseppe
2016-04-15 22:49:05 +03:00
ostree_checksum_b64_inplace_from_bytes
ostree_checksum_b64_inplace_to_bytes
libostree: More gtk-doc updates for ostree-core
2013-08-17 18:54:00 +04:00
ostree_cmp_checksum_bytes
ostree_validate_rev
lib/core: Add ostree_validate_remote_name() for remote names There are a few places in the code where ad-hoc validation was being performed. Might as well formalise it a bit more. Signed-off-by: Philip Withnall <withnall@endlessm.com> Closes: #948 Approved by: cgwalters
2017-06-14 14:28:52 +03:00
ostree_validate_remote_name
libostree: More gtk-doc updates for ostree-core
2013-08-17 18:54:00 +04:00
ostree_parse_refspec
ostree_object_type_to_string
ostree_object_type_from_string
ostree_hash_object_name
ostree_object_name_serialize
ostree_object_name_deserialize
ostree_object_to_string
ostree_object_from_string
ostree_content_stream_parse
ostree_content_file_parse
Rename test-abi to test-symbols, start verifying symbols are documented We keep forgetting to update `apidoc/ostree-sections.txt`, so let's start enforcing it. Of course it turns out we had some bugs here like symbols marked as public but never implemented, etc. Those are fixed in the prior commits. Closes: #263 Approved by: giuseppe
2016-04-15 22:49:05 +03:00
ostree_content_file_parse_at
core: Add a function creating an archive-z2 content stream It is quite similar to the already existing ostree_raw_file_to_content_stream function, so I factored the common part to a separate function. The difference is that we cannot report the size of the resulting stream. Can be useful for serving a "bare" repository as a faked "archive-z2" repository. Closes: #308 Approved by: cgwalters
2016-05-23 14:28:04 +03:00
ostree_raw_file_to_archive_z2_stream
libostree: Allow compression level to be set for archive-z2 stream Add a ostree_raw_file_to_archive_z2_stream_with_options() variant of ostree_raw_file_to_archive_z2_stream(), to allow a compression-level option to be passed in and passed through to zlib. This is useful when building archive-z2 files on the fly for transmission over a non-bandwidth-limited channel, such as a local network. In this case, CPU time is more valuable than bandwidth, so we want a low compression level. Signed-off-by: Philip Withnall <withnall@endlessm.com> Closes: #721 Approved by: cgwalters
2017-03-06 20:48:36 +03:00
ostree_raw_file_to_archive_z2_stream_with_options
libostree: More gtk-doc updates for ostree-core
2013-08-17 18:54:00 +04:00
ostree_raw_file_to_content_stream
lib/core: Add a "break hardlink" API This imports the code from rpm-ostree: https://github.com/projectatomic/rpm-ostree/blob/9ff9f6c997d914cb7d97d6b59d8045ba64a1882c/src/libpriv/rpmostree-util.c#L742 I plan to use this for rofiles-fuse to implement copyup: https://github.com/ostreedev/ostree/issues/1377 But it's just obviously generally useful for projects using libostree I think. Closes: #1378 Approved by: jlebon
2017-12-14 19:10:35 +03:00
ostree_break_hardlink
libostree: More gtk-doc updates for ostree-core
2013-08-17 18:54:00 +04:00
ostree_checksum_file_from_input
ostree_checksum_file
lib/core: add ostree_checksum_file_at API This is like `ostree_checksum_file` but fd-relative. This will be used by https://github.com/ostreedev/ostree/pull/1258. AFAICT, we actually didn't have any tests that check the `checksum` CLI. Add a basic one here to test the old code as well as the new code. Closes: #1263 Approved by: cgwalters
2017-10-11 17:52:02 +03:00
ostree_checksum_file_at
libostree: More gtk-doc updates for ostree-core
2013-08-17 18:54:00 +04:00
ostree_checksum_file_async
ostree_checksum_file_async_finish
ostree_create_directory_metadata
ostree_validate_structureof_objtype
ostree_validate_structureof_csum_v
ostree_validate_structureof_checksum_string
ostree_validate_structureof_file_mode
ostree_validate_structureof_commit
ostree_validate_structureof_dirtree
ostree_validate_structureof_dirmeta
ostree_commit_get_parent
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_commit_get_timestamp
core: Add API (and standard concept for) content checksum There are a few cases for knowing whether a commit has identical content to another commit. Some people want to do a "promotion workflow", where the content of a commit on a tesitng branch is then "promoted" to a production branch with `ostree commit --tree=ref`. Another use case I just hit in rpm-ostree deals with [jigdo](https://github.com/projectatomic/rpm-ostree/issues/1081) where we're importing RPMs on both the client and server, and will be using the content checksum, since the client/server cases inject different metadata into the commit object. Closes: https://github.com/ostreedev/ostree/issues/1315 Closes: #1449 Approved by: jlebon
2018-02-09 00:33:18 +03:00
ostree_commit_get_content_checksum
core: Add ostree_commit_get_object_sizes API This function parses the object listing in the `ostree.sizes` metadata and returns an array of `OstreeCommitSizesEntry` structures. Unfortunately, for reasons I don't understand, the linker wants to resolve `_ostree_read_varuint64` from `ostree-core.c` even though it's not used by `test-checksum.c` at all.
2020-01-21 05:54:00 +03:00
ostree_commit_get_object_sizes
core: Add OstreeCommitSizesEntry type This will be used when reading out entries in the `ostree.sizes` metadata. Each entry corresponds to an object in the metadata array.
2019-12-19 22:50:46 +03:00
OstreeCommitSizesEntry
ostree_commit_sizes_entry_new
ostree_commit_sizes_entry_copy
ostree_commit_sizes_entry_free
core: Add runtime ostree_check_version() [Previously](https://github.com/ostreedev/ostree/pull/728) we added compile-time checking for versions, but there are use cases for runtime checking as well, because in a number of API calls we use `GVariant` as an API extension mechanism. Closes: #735 Approved by: jlebon
2017-03-13 16:45:51 +03:00
ostree_check_version
core: Add OstreeCommitSizesEntry type This will be used when reading out entries in the `ostree.sizes` metadata. Each entry corresponds to an object in the metadata array.
2019-12-19 22:50:46 +03:00
<SUBSECTION Standard>
ostree_commit_sizes_entry_get_type
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
</SECTION>
<SECTION>
docs: Get API docs working again This changes around a few things that didn't work for me: * Section names seem to be ostree-* instead of libostree-* * Also XML files are ostree-* (they didn't show up at all) - gtk-doc doesn't seem to parse const _OSTREE_PUBLIC correctly * pull documentation is now on the actual functions rather than stubs * Update gitignore with some more files And there some changes to make gtk-doc give fewer warnings (not finished) Closes: #327 Approved by: cgwalters
2016-06-05 01:16:05 +03:00
<FILE>ostree-deployment</FILE>
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
OstreeDeployment
ostree_deployment_hash
ostree_deployment_equal
ostree_deployment_new
ostree_deployment_get_index
ostree_deployment_get_osname
ostree_deployment_get_deployserial
ostree_deployment_get_csum
ostree_deployment_get_bootcsum
ostree_deployment_get_bootserial
ostree_deployment_get_bootconfig
ostree_deployment_get_origin
Rename test-abi to test-symbols, start verifying symbols are documented We keep forgetting to update `apidoc/ostree-sections.txt`, so let's start enforcing it. Of course it turns out we had some bugs here like symbols marked as public but never implemented, etc. Those are fixed in the prior commits. Closes: #263 Approved by: giuseppe
2016-04-15 22:49:05 +03:00
ostree_deployment_get_origin_relpath
ostree_deployment_get_unlocked
sysroot: Add concept of deployment "pinning" 📌 Example user story: Jane rebases her OS to a new major version N, and wants to keep around N-1 even after a few upgrades for a while so she can easily roll back. I plan to add `rpm-ostree rebase --pin` to opt-in to this for example. Builds on the new `libostree-transient` group to store pinning state there. Closes: https://github.com/ostreedev/ostree/issues/1460 Closes: #1464 Approved by: jlebon
2018-02-23 20:46:32 +03:00
ostree_deployment_is_pinned
Add concept of "staged" deployment Add API to write a deployment state to `/run/ostree/staged-deployment`, along with a systemd service which runs at shutdown time. This is a big change to the ostree model for hosts, but it closes a longstanding set of bugs; many, many people have hit the "losing changes in /etc" problem. It also avoids the other problem of racing with programs that modify `/etc` such as LVM backups: https://bugzilla.redhat.com/show_bug.cgi?id=1365297 We need this in particular to go to a full-on model for automatically updated host systems where (like a dual-partition model) everything is fully prepared and the reboot can be taken asynchronously. Closes: https://github.com/ostreedev/ostree/issues/545 Closes: #1503 Approved by: jlebon
2018-02-22 23:27:59 +03:00
ostree_deployment_is_staged
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_deployment_set_index
ostree_deployment_set_bootserial
ostree_deployment_set_bootconfig
ostree_deployment_set_origin
sysroot: Add API to clean up transient keys in origin files The `origin/unlocked` and `origin/override-commit` keys are examples of state that's really transient; we don't want to maintain them across upgrades. Right now there are bits for this in both `ostree admin upgrade` as well as in rpm-ostree. This new API will slightly clean up both cases, but it's really prep for adding a concept of deployment "pinning" that will live in the new `libostree-transient` group. Closes: #1464 Approved by: jlebon
2018-02-23 22:23:38 +03:00
ostree_deployment_origin_remove_transient_state
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_deployment_clone
Rename test-abi to test-symbols, start verifying symbols are documented We keep forgetting to update `apidoc/ostree-sections.txt`, so let's start enforcing it. Of course it turns out we had some bugs here like symbols marked as public but never implemented, etc. Those are fixed in the prior commits. Closes: #263 Approved by: giuseppe
2016-04-15 22:49:05 +03:00
ostree_deployment_unlocked_state_to_string
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
<SUBSECTION Standard>
OSTREE_DEPLOYMENT
OSTREE_IS_DEPLOYMENT
OSTREE_TYPE_DEPLOYMENT
ostree_deployment_get_type
</SECTION>
<SECTION>
docs: Get API docs working again This changes around a few things that didn't work for me: * Section names seem to be ostree-* instead of libostree-* * Also XML files are ostree-* (they didn't show up at all) - gtk-doc doesn't seem to parse const _OSTREE_PUBLIC correctly * pull documentation is now on the actual functions rather than stubs * Update gitignore with some more files And there some changes to make gtk-doc give fewer warnings (not finished) Closes: #327 Approved by: cgwalters
2016-06-05 01:16:05 +03:00
<FILE>ostree-diff</FILE>
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
OstreeDiffFlags
OstreeDiffItem
ostree_diff_item_ref
ostree_diff_item_unref
ostree_diff_dirs
diff: Add ostree_diff_dirs_with_options(), expose via cmdline The first options are owner_uid/owner_gid, which makes it possible to use diff on local files where --owner-uid/gid have been passed to commit. Closes: #740 Approved by: cgwalters
2017-02-08 23:59:38 +03:00
ostree_diff_dirs_with_options
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_diff_print
<SUBSECTION Standard>
ostree_diff_item_get_type
</SECTION>
gpg: Add OstreeGpgVerifyResult Wrappers a referenced gpgme_verify_result_t so detailed verify results can be examined independently of executing a verify operation. _ostree_gpg_verifier_check_signature() now returns this object instead of a single valid/invalid boolean, but the idea is for OstreeRepo to also return this object for commit signature verification so it can be utilized at the CLI layer (and possibly by other programs).
2015-03-04 20:44:47 +03:00
<SECTION>
docs: Get API docs working again This changes around a few things that didn't work for me: * Section names seem to be ostree-* instead of libostree-* * Also XML files are ostree-* (they didn't show up at all) - gtk-doc doesn't seem to parse const _OSTREE_PUBLIC correctly * pull documentation is now on the actual functions rather than stubs * Update gitignore with some more files And there some changes to make gtk-doc give fewer warnings (not finished) Closes: #327 Approved by: cgwalters
2016-06-05 01:16:05 +03:00
<FILE>ostree-gpg-verify-result</FILE>
lib/gpg-verify: Add an OstreeGpgError error domain Add a new error domain for GPG signing/verification errors, and use it throughout libostree for describing verification errors. This replaces various uses of G_IO_ERROR_FAILED, and one instance of G_IO_ERROR_NOT_FOUND (for which some code in ot-builtin-show.c had to be changed to ensure it was still handled correctly). The use of a separate error domain allows failures in GPG operations to be handled separately from network failures (where the summary file could not be found to be downloaded, for example) or timeouts. Signed-off-by: Philip Withnall <withnall@endlessm.com> Closes: #1064 Closes: #1071 Approved by: mbarnes
2017-08-09 16:35:53 +03:00
OstreeGpgError
gpg: Add OstreeGpgVerifyResult Wrappers a referenced gpgme_verify_result_t so detailed verify results can be examined independently of executing a verify operation. _ostree_gpg_verifier_check_signature() now returns this object instead of a single valid/invalid boolean, but the idea is for OstreeRepo to also return this object for commit signature verification so it can be utilized at the CLI layer (and possibly by other programs).
2015-03-04 20:44:47 +03:00
OstreeGpgVerifyResult
OstreeGpgSignatureAttr
ostree_gpg_verify_result_count_all
ostree_gpg_verify_result_count_valid
ostree_gpg_verify_result_lookup
ostree_gpg_verify_result_get
ostree_gpg_verify_result_get_all
gpg: Add ostree_gpg_verify_result_describe() Internalizes the signature output of "ostree show" so it can be reused elsewhere.
2015-03-20 19:07:03 +03:00
OstreeGpgSignatureFormatFlags
ostree_gpg_verify_result_describe
gpg: Add ostree_gpg_verify_result_describe_variant() Needed for printing signature details in places where OstreeGpgVerifyResult cannot go.
2015-05-06 00:41:13 +03:00
ostree_gpg_verify_result_describe_variant
repo: Factor out the check of gpg result to a separate function I plan to add a function for verifying any data which may return the error about lack of trusted signatures, so let's avoid the redundancy and put the check in the separate function. Closes: #310 Approved by: cgwalters
2016-05-26 12:48:21 +03:00
ostree_gpg_verify_result_require_valid_signature
gpg: Add OstreeGpgVerifyResult Wrappers a referenced gpgme_verify_result_t so detailed verify results can be examined independently of executing a verify operation. _ostree_gpg_verifier_check_signature() now returns this object instead of a single valid/invalid boolean, but the idea is for OstreeRepo to also return this object for commit signature verification so it can be utilized at the CLI layer (and possibly by other programs).
2015-03-04 20:44:47 +03:00
<SUBSECTION Standard>
OSTREE_GPG_VERIFY_RESULT
OSTREE_IS_GPG_VERIFY_RESULT
OSTREE_TYPE_GPG_VERIFY_RESULT
ostree_gpg_verify_result_get_type
lib/gpg-verify: Add an OstreeGpgError error domain Add a new error domain for GPG signing/verification errors, and use it throughout libostree for describing verification errors. This replaces various uses of G_IO_ERROR_FAILED, and one instance of G_IO_ERROR_NOT_FOUND (for which some code in ot-builtin-show.c had to be changed to ensure it was still handled correctly). The use of a separate error domain allows failures in GPG operations to be handled separately from network failures (where the summary file could not be found to be downloaded, for example) or timeouts. Signed-off-by: Philip Withnall <withnall@endlessm.com> Closes: #1064 Closes: #1071 Approved by: mbarnes
2017-08-09 16:35:53 +03:00
OSTREE_GPG_ERROR
ostree_gpg_error_quark
gpg: Add OstreeGpgVerifyResult Wrappers a referenced gpgme_verify_result_t so detailed verify results can be examined independently of executing a verify operation. _ostree_gpg_verifier_check_signature() now returns this object instead of a single valid/invalid boolean, but the idea is for OstreeRepo to also return this object for commit signature verification so it can be utilized at the CLI layer (and possibly by other programs).
2015-03-04 20:44:47 +03:00
</SECTION>
docs: Get API docs working again This changes around a few things that didn't work for me: * Section names seem to be ostree-* instead of libostree-* * Also XML files are ostree-* (they didn't show up at all) - gtk-doc doesn't seem to parse const _OSTREE_PUBLIC correctly * pull documentation is now on the actual functions rather than stubs * Update gitignore with some more files And there some changes to make gtk-doc give fewer warnings (not finished) Closes: #327 Approved by: cgwalters
2016-06-05 01:16:05 +03:00
<FILE>ostree-lzma-compressor</FILE>
<SUBSECTION Standard>
OSTREE_IS_LZMA_COMPRESSOR
OSTREE_IS_LZMA_COMPRESSOR_CLASS
OSTREE_LZMA_COMPRESSOR
OSTREE_LZMA_COMPRESSOR_CLASS
OSTREE_LZMA_COMPRESSOR_GET_CLASS
OSTREE_TYPE_LZMA_COMPRESSOR
OstreeLzmaCompressor
OstreeLzmaCompressorClass
</SECTION>
<SECTION>
<FILE>ostree-lzma-decompressor</FILE>
<SUBSECTION Standard>
OSTREE_IS_LZMA_DECOMPRESSOR
OSTREE_IS_LZMA_DECOMPRESSOR_CLASS
OSTREE_LZMA_DECOMPRESSOR
OSTREE_LZMA_DECOMPRESSOR_CLASS
OSTREE_LZMA_DECOMPRESSOR_GET_CLASS
OSTREE_TYPE_LZMA_DECOMPRESSOR
OstreeLzmaDecompressor
OstreeLzmaDecompressorClass
</SECTION>
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
<SECTION>
docs: Get API docs working again This changes around a few things that didn't work for me: * Section names seem to be ostree-* instead of libostree-* * Also XML files are ostree-* (they didn't show up at all) - gtk-doc doesn't seem to parse const _OSTREE_PUBLIC correctly * pull documentation is now on the actual functions rather than stubs * Update gitignore with some more files And there some changes to make gtk-doc give fewer warnings (not finished) Closes: #327 Approved by: cgwalters
2016-06-05 01:16:05 +03:00
<FILE>ostree-mutable-tree</FILE>
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
OstreeMutableTree
ostree_mutable_tree_new
ostree repo commit: Speed up composing trees with `--tree=ref` Running `ostree commit --tree=ref=a --tree=dir=b` involves reading the whole of a into an `OstreeMutableTree` before composing `b` on top. This is inefficient if a is a complete rootfs and b is just touching one file. We process O(size of a + size of b) directories rather than O(number of touched dirs). This commit makes `ostree commit` more efficient at composing multiple directories together. With `ostree_mutable_tree_fill_empty_from_dirtree` we create a lazy `OstreeMutableTree` which only reads the underlying information from disk when needed. We don't need to read all the subdirectories just to get the checksum of a tree already checked into the repo. This provides great speedups when composing a rootfs out of multiple other rootfs as we do in our build system. We compose multiple containers together with: ostree commit --tree=ref=base-rootfs --tree=ref=container1 --tree=ref=container2 and it is much faster now. As a test I ran time ostree --repo=... commit --orphan --tree=ref=big-rootfs --tree=dir=modified_etc Where modified_etc contained a modified sudoers file under /etc. I used `strace` to count syscalls and I seperatly took timing measurements. To test with a cold cache I ran sync && echo 3 | sudo tee /proc/sys/vm/drop_caches Results: | | Before | After | | -------------------- | ------ | ----- | | Time (cold cache) | 8.1s | 0.12s | | Time (warm cache) | 3.7s | 0.08s | | `openat` calls | 53589 | 246 | | `fgetxattr` calls | 78916 | 0 | I'm not sure if this will have some negative interaction with the `_ostree_repo_commit_modifier_apply` which is short-circuited here. I think it was disabled for `--tree=ref=` anyway, but I'm not certain. All the tests pass anyway. I originally implemented this in terms of the `OstreeRepoFile` APIs, but it was *way* less efficient, opening and reading many files unnecessarily. Closes: #1643 Approved by: cgwalters
2018-06-22 17:28:49 +03:00
ostree_mutable_tree_new_from_checksum
ostree_mutable_tree_check_error
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_mutable_tree_set_metadata_checksum
ostree_mutable_tree_get_metadata_checksum
ostree_mutable_tree_set_contents_checksum
ostree_mutable_tree_get_contents_checksum
ostree_mutable_tree_replace_file
OstreeMutableTree: add _remove method There is no API method to remove a file or subdirectory from a MutableTree besides directly manipulating the GHashTable returned by _get_files or _get_subdirs. This isn't possible from an introspection binding that transforms the returned GHashTable, and may also leave the tree checksum in an invalid state. Introduce a new method so that removing files or subdirectories is safe, and possible from bindings. Closes: #1724 Approved by: jlebon
2018-09-18 17:46:24 +03:00
ostree_mutable_tree_remove
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_mutable_tree_ensure_dir
ostree_mutable_tree_lookup
ostree_mutable_tree_ensure_parent_dirs
ostree_mutable_tree_walk
ostree_mutable_tree_get_subdirs
ostree_mutable_tree_get_files
ostree repo commit: Speed up composing trees with `--tree=ref` Running `ostree commit --tree=ref=a --tree=dir=b` involves reading the whole of a into an `OstreeMutableTree` before composing `b` on top. This is inefficient if a is a complete rootfs and b is just touching one file. We process O(size of a + size of b) directories rather than O(number of touched dirs). This commit makes `ostree commit` more efficient at composing multiple directories together. With `ostree_mutable_tree_fill_empty_from_dirtree` we create a lazy `OstreeMutableTree` which only reads the underlying information from disk when needed. We don't need to read all the subdirectories just to get the checksum of a tree already checked into the repo. This provides great speedups when composing a rootfs out of multiple other rootfs as we do in our build system. We compose multiple containers together with: ostree commit --tree=ref=base-rootfs --tree=ref=container1 --tree=ref=container2 and it is much faster now. As a test I ran time ostree --repo=... commit --orphan --tree=ref=big-rootfs --tree=dir=modified_etc Where modified_etc contained a modified sudoers file under /etc. I used `strace` to count syscalls and I seperatly took timing measurements. To test with a cold cache I ran sync && echo 3 | sudo tee /proc/sys/vm/drop_caches Results: | | Before | After | | -------------------- | ------ | ----- | | Time (cold cache) | 8.1s | 0.12s | | Time (warm cache) | 3.7s | 0.08s | | `openat` calls | 53589 | 246 | | `fgetxattr` calls | 78916 | 0 | I'm not sure if this will have some negative interaction with the `_ostree_repo_commit_modifier_apply` which is short-circuited here. I think it was disabled for `--tree=ref=` anyway, but I'm not certain. All the tests pass anyway. I originally implemented this in terms of the `OstreeRepoFile` APIs, but it was *way* less efficient, opening and reading many files unnecessarily. Closes: #1643 Approved by: cgwalters
2018-06-22 17:28:49 +03:00
ostree_mutable_tree_fill_empty_from_dirtree
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
<SUBSECTION Standard>
OSTREE_MUTABLE_TREE
OSTREE_IS_MUTABLE_TREE
OSTREE_TYPE_MUTABLE_TREE
OSTREE_MUTABLE_TREE_CLASS
OSTREE_IS_MUTABLE_TREE_CLASS
OSTREE_MUTABLE_TREE_GET_CLASS
OstreeMutableTreeClass
ostree_mutable_tree_get_type
Add gtk-doc support Yes, it's really me. Colin Walters. Writing documentation. You don't need to do a DNA test.
2013-08-17 06:54:35 +04:00
</SECTION>
libostree: Add gtk-doc section for ostree-repo.c
2013-08-17 21:22:58 +04:00
<SECTION>
docs: Get API docs working again This changes around a few things that didn't work for me: * Section names seem to be ostree-* instead of libostree-* * Also XML files are ostree-* (they didn't show up at all) - gtk-doc doesn't seem to parse const _OSTREE_PUBLIC correctly * pull documentation is now on the actual functions rather than stubs * Update gitignore with some more files And there some changes to make gtk-doc give fewer warnings (not finished) Closes: #327 Approved by: cgwalters
2016-06-05 01:16:05 +03:00
<FILE>ostree-repo</FILE>
lib/repo: Add apidoc for repo properties However, they weren't showing up in the output HTML and I have no idea why; I looked at what we're doing and it looks close enough to what's going on in `GDBusConnection` that I was using as a reference. I'm not going to spend a lot of time to debug it right now. Closes: #1140 Approved by: jlebon
2017-09-06 17:24:56 +03:00
<TITLE>OstreeRepo</TITLE>
doc: Add OstreeMutableTree, other minor doc updates
2013-09-13 07:53:13 +04:00
OstreeRepo
libostree: Add gtk-doc section for ostree-repo.c
2013-08-17 21:22:58 +04:00
OstreeRepoMode
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_repo_mode_from_string
repo: Introduce ostree_repo_open_at() and ostree_repo_create_at() This essentially completes our fd-relative conversion. While here, I cleaned up the semantics of `ostree_repo_create()` and `ostree_repo_create_at()` to be more atomic - basically various scripts were testing for the `objects` subdirectory, so let's formalize that. Closes: #820 Approved by: jlebon
2017-04-28 22:51:32 +03:00
ostree_repo_open_at
libostree: Add gtk-doc section for ostree-repo.c
2013-08-17 21:22:58 +04:00
ostree_repo_new
repo: Add a "sysroot-path" property Adds ostree_repo_new_for_sysroot_path() to specify a system root path. OstreeRepo otherwise uses _ostree_get_default_sysroot_path().
2015-07-14 00:12:18 +03:00
ostree_repo_new_for_sysroot_path
Update docs
2013-09-06 00:38:06 +04:00
ostree_repo_new_default
ostree_repo_open
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_repo_set_disable_fsync
sysroot: Don't individually fsync dirs in checkout, rely on syncfs Originally, a lot of the `fsync()` calls here were added for the wrong reason - I was chasing a bug that ended up being the extlinux bootloader not parsing 64 bit ext4 filesystems. But since it looked like corruption, I tried adding a lot more `fsync()` calls. All we should have to do is use `syncfs()`. If that doesn't work, it's a kernel bug. I'm making this change because skipping the individual fsyncs can be a major performance win - it's easier for the FS to optimize, we do more in parallel, etc. https://bugzilla.gnome.org/show_bug.cgi?id=757117
2016-01-13 18:15:21 +03:00
ostree_repo_get_disable_fsync
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_repo_is_system
Add ostree_repo_is_writable()
2015-01-19 04:27:53 +03:00
ostree_repo_is_writable
repo: Introduce ostree_repo_open_at() and ostree_repo_create_at() This essentially completes our fd-relative conversion. While here, I cleaned up the semantics of `ostree_repo_create()` and `ostree_repo_create_at()` to be more atomic - basically various scripts were testing for the `objects` subdirectory, so let's formalize that. Closes: #820 Approved by: jlebon
2017-04-28 22:51:32 +03:00
ostree_repo_create_at
Update docs
2013-09-06 00:38:06 +04:00
ostree_repo_create
Release 2019.2 Also add `ostree_repo_get_bootloader` to the public API, which was missed when it was initially merged. Closes: #1844 Approved by: rfairley
2019-04-24 23:12:31 +03:00
ostree_repo_get_bootloader
libostree: Add gtk-doc section for ostree-repo.c
2013-08-17 21:22:58 +04:00
ostree_repo_get_path
ostree_repo_get_mode
lib/repo: Add an API to get min-free-space-* reserved bytes https://phabricator.endlessm.com/T23694 Closes: #1715 Approved by: cgwalters
2018-08-31 17:20:29 +03:00
ostree_repo_get_min_free_space_bytes
libostree: Add gtk-doc section for ostree-repo.c
2013-08-17 21:22:58 +04:00
ostree_repo_get_config
Rename test-abi to test-symbols, start verifying symbols are documented We keep forgetting to update `apidoc/ostree-sections.txt`, so let's start enforcing it. Of course it turns out we had some bugs here like symbols marked as public but never implemented, etc. Those are fixed in the prior commits. Closes: #263 Approved by: giuseppe
2016-04-15 22:49:05 +03:00
ostree_repo_get_dfd
Rename core.repo-finders to core.default-repo-finders This renames a config key to make its semantics more obvious. Despite what the commit message says, it only applies when a set of repo finders is not specified (either on the command line or in a library API call). This also renames the corresponding ostree_repo_get function. We can do this since it hasn't been released yet. Closes: #1763 Approved by: pwithnall
2018-10-23 01:11:39 +03:00
ostree_repo_get_default_repo_finders
lib/repo: Add ostree_repo_hash() and tests Add a hash function for OstreeRepo instances, which relies on the repo being open, and hence being able to hash the device and inode of its root directory. Add unit tests for this and ostree_repo_equal(). Signed-off-by: Philip Withnall <withnall@endlessm.com> https://github.com/ostreedev/ostree/issues/1191 Closes: #1205 Approved by: cgwalters
2017-09-21 22:22:09 +03:00
ostree_repo_hash
lib/repo: Add ostree_repo_equal() for comparing repos This will compare their root directory inodes to see if they are the same repository on disk. A convenience method for the users of the public API who can’t access OstreeRepo.inode. Signed-off-by: Philip Withnall <withnall@endlessm.com> Closes: #1179 Approved by: cgwalters
2017-09-15 17:26:22 +03:00
ostree_repo_equal
libostree: Add gtk-doc section for ostree-repo.c
2013-08-17 21:22:58 +04:00
ostree_repo_copy_config
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_repo_remote_add
ostree_repo_remote_delete
OstreeRepoRemoteChange
ostree_repo_remote_change
Add ostree_repo_remote_list() Lists available remote names.
2014-12-16 18:29:09 +03:00
ostree_repo_remote_list
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_repo_remote_get_url
repo: Add ostree_repo_remote_get_gpg_verify() Trivial function, but it does at least centralize the default value.
2015-04-15 21:14:55 +03:00
ostree_repo_remote_get_gpg_verify
repo: new function ostree_repo_remote_get_gpg_verify_summary It allows to specify whether GPG verification for the summary file is enabled for a specific repository. Signed-off-by: Giuseppe Scrivano <gscrivan@redhat.com>
2015-06-03 11:18:03 +03:00
ostree_repo_remote_get_gpg_verify_summary
repo: Add ostree_repo_remote_gpg_import() Imports one or more GPG keys from a source stream or from the user's personal keyring into a remote-specific keyring. The keys to import can optionally be restricted by a list of key IDs. The imported keys are used to conduct GPG verification when pulling from the given remote.
2015-04-28 20:26:00 +03:00
ostree_repo_remote_gpg_import
repo: Add ostree_repo_remote_fetch_summary() Reusable method for fetching a summary file and signatures.
2015-06-07 20:41:04 +03:00
ostree_repo_remote_fetch_summary
repo: Allow using options for fetching summary This adds a _with_options variant of the ostree_repo_remote_fetch_summary function, so we can tell the fetcher to use a specific URL instead taking it from the remote config. Closes: #290 Approved by: cgwalters
2016-05-10 13:45:49 +03:00
ostree_repo_remote_fetch_summary_with_options
lib: Add ostree_repo_reload_config() For a long time we've cached the remote configs in the repo, which mostly makes sense for the `repo/config` file, but less sense for `/etc/ostree/remotes.d`, because we want to support admins interactively editing them. One can delete the repo instance and create a new one, but that's a bit ugly. Let's introduce an API for this so rpm-ostree can reload remotes after admins/scripts edit them in `/etc`. We also might as well reload any other entries in the config. Structurually now, `ostree_repo_open()` deals with file descriptors, and then calls `ostree_repo_reload_config()`. Except for the uncompressed cache, which is the only thing that deals with FDs that can be configured. But we want to delete that anyways. No tests, since...we don't have a daemon in this codebase, don't want to shave that yak just today. Closes: #662 Approved by: jlebon
2017-01-30 09:43:37 +03:00
ostree_repo_reload_config
Rename test-abi to test-symbols, start verifying symbols are documented We keep forgetting to update `apidoc/ostree-sections.txt`, so let's start enforcing it. Of course it turns out we had some bugs here like symbols marked as public but never implemented, etc. Those are fixed in the prior commits. Closes: #263 Approved by: giuseppe
2016-04-15 22:49:05 +03:00
ostree_repo_get_remote_boolean_option
ostree_repo_get_remote_list_option
ostree_repo_get_remote_option
libostree: Add gtk-doc section for ostree-repo.c
2013-08-17 21:22:58 +04:00
ostree_repo_get_parent
ostree_repo_write_config
repo: Move the transaction stats to a separate struct This is much easier for callers to handle, and simplifies the API a lot. https://bugzilla.gnome.org/show_bug.cgi?id=707644
2013-09-06 00:48:40 +04:00
OstreeRepoTransactionStats
repo: Move the scanning hardlinks optimization out of prepare_transaction This is just a terrible API to have. Make the scanning a separate method, and document it as an optimization.
2013-09-07 02:51:54 +04:00
ostree_repo_scan_hardlinks
libostree: Add gtk-doc section for ostree-repo.c
2013-08-17 21:22:58 +04:00
ostree_repo_prepare_transaction
ostree_repo_commit_transaction
ostree_repo_abort_transaction
Move ref writing to be transaction-based Rather than having separate write_ref calls, make clients start a transaction, add some refs, and then commit it. While this doesn't make it 100% atomic, it makes it easier for us to use an atomic model, and it means we don't do as much I/O updating the summary file and such. https://bugzilla.gnome.org/show_bug.cgi?id=707644
2013-09-06 01:25:26 +04:00
ostree_repo_transaction_set_refspec
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_repo_transaction_set_ref
ostree_repo_set_ref_immediate
lib/repo: Add API to create and list ref aliases There are multiple use cases where we'd like to alias refs. First, having a "stable" alias which gets swapped across major versions: https://pagure.io/atomic-wg/issue/228 Another case is when a ref is obsoleted; <https://pagure.io/atomic-wg/issue/303> This second one could be done with endoflife rebase, but I think this case is better on the server side, as we might later change our minds and do actual releases there. I initially just added some test cases for symlinks in the `refs/heads` dir to ensure this actually works (and it did), but I think it's worth having APIs. Closes: #1033 Approved by: jlebon
2017-07-28 04:22:48 +03:00
ostree_repo_set_alias_ref_immediate
Rename test-abi to test-symbols, start verifying symbols are documented We keep forgetting to update `apidoc/ostree-sections.txt`, so let's start enforcing it. Of course it turns out we had some bugs here like symbols marked as public but never implemented, etc. Those are fixed in the prior commits. Closes: #263 Approved by: giuseppe
2016-04-15 22:49:05 +03:00
ostree_repo_set_cache_dir
ostree_repo_sign_delta
libostree: Add gtk-doc section for ostree-repo.c
2013-08-17 21:22:58 +04:00
ostree_repo_has_object
lib/repo: Add an API to mark a commit as partial For the [rpm-ostree jigdo ♲📦](https://github.com/projectatomic/rpm-ostree/issues/1081) work. We're basically doing "pull" via a non-libostree mechanism, and this should be fully supported. As I mentioned earlier we should try to have `ostree-repo-pull.c` only use public APIs; this gets us closer to that. Closes: #1376 Approved by: jlebon
2017-12-14 17:48:26 +03:00
ostree_repo_mark_commit_partial
fsck: Implement a partial commit reason bitmask After the corruption has been fixed with "ostree fsck -a --delete", a second run of the "ostree fsck" command will print X partial commits not verified and exit with a zero. The zero exit code makes it hard to detect if a repair operation needs to be run. When ever fsck creates a partial commit it should add a reason for the partial commit to the state file found in state/<hash>.commitpartial. This will allow a future execution of the fsck to still return an error indicating that the repository is still in the damaged state, awaiting repair. Additional reason codes could be added in the future for why a partial commit exists. Text from: https://github.com/ostreedev/ostree/pull/1880 ==== cgwalters commented: To restate, the core issue is that it's valid to have partial commits for reasons other than fsck pruned bad objects, and libostree doesn't have a way to distinguish. Another option perhaps is to write e.g. fsck-partial into the statefile state/<hash>.commitpartial which would mean "partial, and expected to exist but was pruned by fsck" and fsck would continue to error out until the commit was re-pulled. Right now the partial stamp file is empty, so it'd be fully compatible to write a rationale into it. ==== Signed-off-by: Jason Wessel <jason.wessel@windriver.com> Closes: #1910 Approved by: cgwalters
2019-07-10 21:47:27 +03:00
ostree_repo_mark_commit_partial_reason
repo: Rename "stage" to "write" in the API An earlier version of this API acted like git in that some objects would be staged in a temporary directory which would be then committed in one go by moving files around. The API doesn't match most users expectations though, as while the stage is nice as a high-level API it isn't really suited for low-level APIs. While the stage was removed, the APIs were never renamed. Rename them now so that they match expectations. https://bugzilla.gnome.org/show_bug.cgi?id=707644
2013-09-06 00:36:44 +04:00
ostree_repo_write_metadata
ostree_repo_write_metadata_async
ostree_repo_write_metadata_finish
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_repo_write_content
repo: Rename "stage" to "write" in the API An earlier version of this API acted like git in that some objects would be staged in a temporary directory which would be then committed in one go by moving files around. The API doesn't match most users expectations though, as while the stage is nice as a high-level API it isn't really suited for low-level APIs. While the stage was removed, the APIs were never renamed. Rename them now so that they match expectations. https://bugzilla.gnome.org/show_bug.cgi?id=707644
2013-09-06 00:36:44 +04:00
ostree_repo_write_metadata_trusted
libostree: Add API to write metadata as stream And use it in pull-local. The goal here is to kill users of ostree_repo_load_variant(), and move a bit more towards hiding the variants.
2013-09-19 02:44:57 +04:00
ostree_repo_write_metadata_stream_trusted
repo: Rename "stage" to "write" in the API An earlier version of this API acted like git in that some objects would be staged in a temporary directory which would be then committed in one go by moving files around. The API doesn't match most users expectations though, as while the stage is nice as a high-level API it isn't really suited for low-level APIs. While the stage was removed, the APIs were never renamed. Rename them now so that they match expectations. https://bugzilla.gnome.org/show_bug.cgi?id=707644
2013-09-06 00:36:44 +04:00
ostree_repo_write_content_trusted
ostree_repo_write_content_async
ostree_repo_write_content_finish
libostree: Add gtk-doc section for ostree-repo.c
2013-08-17 21:22:58 +04:00
ostree_repo_resolve_rev
apidoc: Add missing enums to sections file So they and their values show up in the documentation. Closes: #812 Approved by: cgwalters
2017-04-26 14:03:42 +03:00
OstreeRepoResolveRevExtFlags
refs: resolve conflict between local/remote repos Add the functionality to use the same name for refs in local and remote repos. This helps users keep track of local refs of remote origin, much like local and remote git branches. Previously, when a local ref is specified, resolve_refspec would fall back to searching through remote repos if the ref is not found locally. This function now takes an extra flag to specify whether it should search through remote repos. Additionally, ostree_repo_resove_rev_ext was added to call resolve_refspec with fallback_remote being false, so refs --create would no longer complain when trying to create a local ref of the same name as a remote one. Fix remote repo parsing not being handled correctly on refs --create. Closes: #363 Approved by: jlebon
2016-06-23 19:11:50 +03:00
ostree_repo_resolve_rev_ext
libostree: Add gtk-doc section for ostree-repo.c
2013-08-17 21:22:58 +04:00
ostree_repo_list_refs
apidoc: Add missing enums to sections file So they and their values show up in the documentation. Closes: #812 Approved by: cgwalters
2017-04-26 14:03:42 +03:00
OstreeRepoListRefsExtFlags
ostree-repo: new public function `ostree_repo_list_refs_ext` It accepts a `flags` argument to control its behavior. Differently from `ostree_repo_list_refs`, the `refspec_prefix` is not removed from the results. Signed-off-by: Giuseppe Scrivano <gscrivan@redhat.com>
2016-03-02 11:58:38 +03:00
ostree_repo_list_refs_ext
libostree: new API ostree_repo_remote_list_refs The new API permits to query a remote repository summary file and retrieve the list of available refs. Signed-off-by: Giuseppe Scrivano <gscrivan@redhat.com>
2015-07-22 13:16:51 +03:00
ostree_repo_remote_list_refs
libostree: Add gtk-doc section for ostree-repo.c
2013-08-17 21:22:58 +04:00
ostree_repo_load_variant
apidoc: Add missing enums to sections file So they and their values show up in the documentation. Closes: #812 Approved by: cgwalters
2017-04-26 14:03:42 +03:00
OstreeRepoCommitState
Teach fsck about partial commits An OSTree user noticed that `ostree fsck` would produce `missing object` errors in the case of interrupted pulls. It's possible to do e.g. `ostree pull --subpath=/usr/share/rpm ...`, which gets you just that portion of the commit. The use case for this was being able to see what changes would appear in an update before actually downloading all of it. (I think this would be better covered by static deltas, but those aren't final yet, and `--subpath` predates it) Further, `.commitpartial` is used as a successor to the `transaction` symlink for more precise knowledge in the case where a pull was interrupted that we needed to resume scanning. So it makes sense for `ostree fsck` to be aware of it.
2015-04-06 21:19:08 +03:00
ostree_repo_load_commit
libostree: Add gtk-doc section for ostree-repo.c
2013-08-17 21:22:58 +04:00
ostree_repo_load_variant_if_exists
ostree_repo_load_file
ostree_repo_load_object_stream
ostree_repo_query_object_storage_size
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_repo_import_object_from
pull: Add OSTREE_REPO_PULL_FLAGS_UNTRUSTED flag If this is set we verify all objects we pull, even for local remotes, and we avoid hard-linking into local source repos. https://bugzilla.gnome.org/show_bug.cgi?id=764125 Closes: #221 Approved by: cgwalters
2016-03-23 13:47:44 +03:00
ostree_repo_import_object_from_with_trust
Rename test-abi to test-symbols, start verifying symbols are documented We keep forgetting to update `apidoc/ostree-sections.txt`, so let's start enforcing it. Of course it turns out we had some bugs here like symbols marked as public but never implemented, etc. Those are fixed in the prior commits. Closes: #263 Approved by: giuseppe
2016-04-15 22:49:05 +03:00
ostree_repo_import_archive_to_mtree
ostree_repo_export_tree_to_archive
libostree: Add gtk-doc section for ostree-repo.c
2013-08-17 21:22:58 +04:00
ostree_repo_delete_object
Add public API for fsck, use it before loading metadata A while ago I did `truncate -s 0 /path/to/repo/00/123.commit`, and expected a checksum error, but I actually got a validation error due to us loading the commit into a variant and trying to parse out the parent checksum, etc. I first started by changing the `load_and_fsck_one_object()` function to checksum before loading, but the problem is that we do a traverse of all objects first. Fixing this is going to require an `OSTREE_REPO_COMMIT_TRAVER_FLAG_FSCK` or something. In the meantime at least though, let's add a public API to fsck a single object which *does* checksum cleanly before parsing the object, and change the `fsck` command to use it. We then change the fsck binary to do this while iterating over the refs and finding the commit object. This way we'll at least get a checksum first for commit objects, even if not dirtree/dirmeta. Closes: #1364 Approved by: jlebon
2017-12-05 22:27:15 +03:00
ostree_repo_fsck_object
libostree: Add gtk-doc section for ostree-repo.c
2013-08-17 21:22:58 +04:00
OstreeRepoCommitFilterResult
OstreeRepoCommitFilter
OstreeRepoCommitModifier
doc: Add OstreeMutableTree, other minor doc updates
2013-09-13 07:53:13 +04:00
OstreeRepoCommitModifierFlags
libostree: Add gtk-doc section for ostree-repo.c
2013-08-17 21:22:58 +04:00
ostree_repo_commit_modifier_new
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
OstreeRepoCommitModifierXattrCallback
ostree_repo_commit_modifier_set_xattr_callback
ostree_repo_commit_modifier_set_sepolicy
repo/commit: Add support for --selinux-policy-from-base The [dev-overlay](https://github.com/coreos/coreos-assembler/blob/332c6ab3b91778d904224c3c960d9cc4739d60bd/src/cmd-dev-overlay) script shipped in coreos-assembler mostly exists to deal with the nontrivial logic around SELinux policy. Let's make the use case of "commit some binaries overlaying a base tree, using the base's selinux policy" just require a magical `--selinux-policy-from-base` argument to `ostree commit`. A new C API was added to implement this in the case of `--tree=ref`; when the base directory is already checked out, we can just reuse the existing logic that `--selinux-policy` was using. Requires: https://github.com/ostreedev/ostree/pull/2039
2020-03-21 17:48:24 +03:00
ostree_repo_commit_modifier_set_sepolicy_from_commit
repo: Add APIs for devino optimization between checkout -> commit A fast way to generate new OSTree content using an existing tree is to checkout (as hard links), add/replace files, then call `ostree_repo_scan_hardlinks()`, then commit. But `ostree_repo_scan_hardlinks()` scans the entire repo, which can be slow if you have a lot of content. All we really need is a mapping of (device,inode) -> checksum just for the objects we checked out, then use that mapping for commits. This patch adds API so that callers can create a mapping via `ostree_repo_devino_cache_new()`, then pass it to `ostree_repo_checkout_tree_at()` which will populate it, and then `ostree_repo_write_directory_to_mtree()` can consume it. I plan to use this in rpm-ostree for package layering work. Notes: - The old `ostree_repo_scan_hardlinks()` API still works. - I tweaked the cache to be a set with the checksum colocated with the key, to avoid a separate malloc block per entry. https://github.com/GNOME/ostree/pull/167
2016-01-05 17:13:54 +03:00
ostree_repo_commit_modifier_set_devino_cache
libostree: Add gtk-doc section for ostree-repo.c
2013-08-17 21:22:58 +04:00
ostree_repo_commit_modifier_ref
ostree_repo_commit_modifier_unref
repo: Add APIs for devino optimization between checkout -> commit A fast way to generate new OSTree content using an existing tree is to checkout (as hard links), add/replace files, then call `ostree_repo_scan_hardlinks()`, then commit. But `ostree_repo_scan_hardlinks()` scans the entire repo, which can be slow if you have a lot of content. All we really need is a mapping of (device,inode) -> checksum just for the objects we checked out, then use that mapping for commits. This patch adds API so that callers can create a mapping via `ostree_repo_devino_cache_new()`, then pass it to `ostree_repo_checkout_tree_at()` which will populate it, and then `ostree_repo_write_directory_to_mtree()` can consume it. I plan to use this in rpm-ostree for package layering work. Notes: - The old `ostree_repo_scan_hardlinks()` API still works. - I tweaked the cache to be a set with the checksum colocated with the key, to avoid a separate malloc block per entry. https://github.com/GNOME/ostree/pull/167
2016-01-05 17:13:54 +03:00
ostree_repo_devino_cache_new
ostree_repo_devino_cache_ref
ostree_repo_devino_cache_unref
Rename test-abi to test-symbols, start verifying symbols are documented We keep forgetting to update `apidoc/ostree-sections.txt`, so let's start enforcing it. Of course it turns out we had some bugs here like symbols marked as public but never implemented, etc. Those are fixed in the prior commits. Closes: #263 Approved by: giuseppe
2016-04-15 22:49:05 +03:00
ostree_repo_devino_cache_get_type
repo: Rename "stage" to "write" in the API An earlier version of this API acted like git in that some objects would be staged in a temporary directory which would be then committed in one go by moving files around. The API doesn't match most users expectations though, as while the stage is nice as a high-level API it isn't really suited for low-level APIs. While the stage was removed, the APIs were never renamed. Rename them now so that they match expectations. https://bugzilla.gnome.org/show_bug.cgi?id=707644
2013-09-06 00:36:44 +04:00
ostree_repo_write_directory_to_mtree
repo: Expose dfd-relative mtree writes as public API For use in rpm-ostree. We already had all of the internals for this.
2016-01-05 01:51:56 +03:00
ostree_repo_write_dfd_to_mtree
repo: Rename "stage" to "write" in the API An earlier version of this API acted like git in that some objects would be staged in a temporary directory which would be then committed in one go by moving files around. The API doesn't match most users expectations though, as while the stage is nice as a high-level API it isn't really suited for low-level APIs. While the stage was removed, the APIs were never renamed. Rename them now so that they match expectations. https://bugzilla.gnome.org/show_bug.cgi?id=707644
2013-09-06 00:36:44 +04:00
ostree_repo_write_archive_to_mtree
lib/commit: Added new ostree_repo_write_archive_to_mtree_from_fd() Similar to ostree_repo_write_archive_to_mtree(), but takes a file descriptor to read the archive from instead of mandating a file path. Usefull for importing archives into an OSTree repo over a socket or from standard input in command line tools. Closes: #1862 Approved by: jlebon
2019-05-21 16:01:09 +03:00
ostree_repo_write_archive_to_mtree_from_fd
repo: Rename "stage" to "write" in the API An earlier version of this API acted like git in that some objects would be staged in a temporary directory which would be then committed in one go by moving files around. The API doesn't match most users expectations though, as while the stage is nice as a high-level API it isn't really suited for low-level APIs. While the stage was removed, the APIs were never renamed. Rename them now so that they match expectations. https://bugzilla.gnome.org/show_bug.cgi?id=707644
2013-09-06 00:36:44 +04:00
ostree_repo_write_mtree
ostree_repo_write_commit
libostree: add new API ostree_repo_write_commit_with_time It extends ostree_repo_write_commit as it permits to override the commit timestamp. Signed-off-by: Giuseppe Scrivano <gscrivan@redhat.com>
2015-11-09 13:16:55 +03:00
ostree_repo_write_commit_with_time
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_repo_read_commit_detached_metadata
ostree_repo_write_commit_detached_metadata
repo: Add wrapper function for setting devino cache on checkout opts I was trying to use this with pygobject for an OCI+ostree project, and pygobject rejected simply assigning to the field (understandably, since it can't bind the lifetime together). Add a wrapper function, which is still unsafe, but hides that unsafety where most people shouldn't find it. And if they do...well, sorry, Rust wasn't invented when ostree was started. Closes: #1295 Approved by: pwithnall
2017-10-19 17:25:59 +03:00
OstreeRepoCheckoutAtOptions
ostree_repo_checkout_at_options_set_devino
libostree: Add gtk-doc section for ostree-repo.c
2013-08-17 21:22:58 +04:00
OstreeRepoCheckoutMode
OstreeRepoCheckoutOverwriteMode
libostree: Check out directories depth-first in serial, switch to sync API The way we recurse into subdirectories in parallel makes it far too easy to hit up against the arbitrary Linux fd limit of 1024. Since the fix here is about dropping parallelism, let's just go all the way for now and make a plain old synchronous API =( This does simplify both internal callers which wanted a sync API anyways. https://bugzilla.gnome.org/show_bug.cgi?id=706380
2013-08-21 03:10:09 +04:00
ostree_repo_checkout_tree
ostree_repo_checkout_tree_at: New API for checkouts rpm-ostree currently uses ostree_repo_checkout_tree(), which as a side effect will use the uncompressed objects cache by default. This is rather annoying if you're using rpm-ostree on a server-side repository, because if you then rsync the repo, you'll be syncing out the uncompressed objects unless you exclude them. We added the ability to disable the uncompressed cache in the repository config to fix this, but it's better to allow application control over this. The uncompressed cache will in some future version become opt in as well. This new API further: - Drops the `GFile` usage in favor of `openat` APIs - Improves ergonomics by avoiding callers having to query the source `GFileInfo` (and carry around a copy of `OSTREE_GIO_FAST_QUERYINFO`) - Has a more extensible options structure Per the comment, I rather crudely have the `ostree checkout` builtin call both APIs to ensure some testing coverage. However, I'd like to in the future have easier-to-set-up testing code that calls `libtest.sh` to set up dummy data.
2015-04-07 01:29:01 +03:00
ostree_repo_checkout_tree_at
libostree: new function ostree_repo_checkout_at Provide a gobject introspection safe version for `ostree_repo_checkout_tree_at'. Signed-off-by: Giuseppe Scrivano <gscrivan@redhat.com> Closes: #417 Approved by: cgwalters
2016-07-27 11:38:36 +03:00
ostree_repo_checkout_at
libostree: Add gtk-doc section for ostree-repo.c
2013-08-17 21:22:58 +04:00
ostree_repo_checkout_gc
ostree_repo_read_commit
OstreeRepoListObjectsFlags
OSTREE_REPO_LIST_OBJECTS_VARIANT_TYPE
ostree_repo_list_objects
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_repo_list_commit_objects_starting_with
ostree_repo_list_static_delta_names
OstreeStaticDeltaGenerateOpt
ostree_repo_static_delta_generate
ostree_repo_static_delta_execute_offline
libostree: Add gtk-doc section for ostree-repo.c
2013-08-17 21:22:58 +04:00
ostree_repo_traverse_new_reachable
lib/repo: Add ostree_repo_traverse_commit_union_with_parents This is a version of ostree_repo_traverse_commit_union that also remembers where the objects came from, by recording the parent relationships in a hashtable. This can be used to later find which commits each object was from, which we want to use in fsck. Closes: #1533 Approved by: cgwalters
2018-04-06 16:37:45 +03:00
ostree_repo_traverse_new_parents
ostree_repo_traverse_parents_get_commits
libostree: Add gtk-doc section for ostree-repo.c
2013-08-17 21:22:58 +04:00
ostree_repo_traverse_commit
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_repo_traverse_commit_union
lib/repo: Add ostree_repo_traverse_commit_union_with_parents This is a version of ostree_repo_traverse_commit_union that also remembers where the objects came from, by recording the parent relationships in a hashtable. This can be used to later find which commits each object was from, which we want to use in fsck. Closes: #1533 Approved by: cgwalters
2018-04-06 16:37:45 +03:00
ostree_repo_traverse_commit_union_with_parents
Rename test-abi to test-symbols, start verifying symbols are documented We keep forgetting to update `apidoc/ostree-sections.txt`, so let's start enforcing it. Of course it turns out we had some bugs here like symbols marked as public but never implemented, etc. Those are fixed in the prior commits. Closes: #263 Approved by: giuseppe
2016-04-15 22:49:05 +03:00
ostree_repo_commit_traverse_iter_cleanup
ostree_repo_commit_traverse_iter_clear
ostree_repo_commit_traverse_iter_get_dir
ostree_repo_commit_traverse_iter_get_file
apidoc: Add missing enums to sections file So they and their values show up in the documentation. Closes: #812 Approved by: cgwalters
2017-04-26 14:03:42 +03:00
OstreeRepoCommitTraverseFlags
Rename test-abi to test-symbols, start verifying symbols are documented We keep forgetting to update `apidoc/ostree-sections.txt`, so let's start enforcing it. Of course it turns out we had some bugs here like symbols marked as public but never implemented, etc. Those are fixed in the prior commits. Closes: #263 Approved by: giuseppe
2016-04-15 22:49:05 +03:00
ostree_repo_commit_traverse_iter_init_commit
ostree_repo_commit_traverse_iter_init_dirtree
apidoc: Add missing enums to sections file So they and their values show up in the documentation. Closes: #812 Approved by: cgwalters
2017-04-26 14:03:42 +03:00
OstreeRepoCommitIterResult
Rename test-abi to test-symbols, start verifying symbols are documented We keep forgetting to update `apidoc/ostree-sections.txt`, so let's start enforcing it. Of course it turns out we had some bugs here like symbols marked as public but never implemented, etc. Those are fixed in the prior commits. Closes: #263 Approved by: giuseppe
2016-04-15 22:49:05 +03:00
ostree_repo_commit_traverse_iter_next
libostree: Add gtk-doc section for ostree-repo.c
2013-08-17 21:22:58 +04:00
OstreeRepoPruneFlags
ostree_repo_prune
Rename test-abi to test-symbols, start verifying symbols are documented We keep forgetting to update `apidoc/ostree-sections.txt`, so let's start enforcing it. Of course it turns out we had some bugs here like symbols marked as public but never implemented, etc. Those are fixed in the prior commits. Closes: #263 Approved by: giuseppe
2016-04-15 22:49:05 +03:00
ostree_repo_prune_static_deltas
lib: Add a public helper method for pruning to find all ref'd commits Prep for reworking how we do sysroot cleanup. We're going to start doing more lowlevel pruning work there, and I wanted to avoid duplicating the ref enumeration. Closes: #1566 Approved by: jlebon
2018-04-30 17:31:33 +03:00
ostree_repo_traverse_reachable_refs
Add support for more selective pruning There are use cases for having a single repo with branches with different lifecycles; a simple example of what I was trying to do in CentOS Atomic Host work is have "stable" and "devel" branches, were we want to prune devel, but retain *all* of stable. This patch is split into two parts - first we add a low level "delete all objects not in this set" API, and change the current prune API to use this. Next, we move more logic into the "ostree prune" command. This paves the way for demonstrating how more sophisticated algorithms/logic could be developed outside of the ostree core. Also, the --keep-younger-than logic already lived in the commandline, so it makes sense to keep extending it there. Closes: https://github.com/ostreedev/ostree/issues/604 Closes: #646 Approved by: jlebon
2016-12-01 17:28:24 +03:00
ostree_repo_prune_from_reachable
libostree: Add gtk-doc section for ostree-repo.c
2013-08-17 21:22:58 +04:00
OstreeRepoPullFlags
ostree_repo_pull
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_repo_pull_one_dir
ostree_repo_pull_with_options
Add ostree_repo_pull_default_console_progress_changed() Replaces ot_common_pull_progress() in ostree binary, so it can be shared with rpm-ostree.
2014-12-18 18:06:47 +03:00
ostree_repo_pull_default_console_progress_changed
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_repo_sign_commit
ostree_repo_append_gpg_signature
Rename test-abi to test-symbols, start verifying symbols are documented We keep forgetting to update `apidoc/ostree-sections.txt`, so let's start enforcing it. Of course it turns out we had some bugs here like symbols marked as public but never implemented, etc. Those are fixed in the prior commits. Closes: #263 Approved by: giuseppe
2016-04-15 22:49:05 +03:00
ostree_repo_add_gpg_signature_summary
repo: Add functions for verifying any data in repository This can be useful for validating the 3rd party data that is put in the extensions directory and is signed with the same keys as commits or the summary file. Closes: #310 Approved by: cgwalters
2016-05-26 12:54:28 +03:00
ostree_repo_gpg_verify_data
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_repo_verify_commit
repo: Add ostree_repo_verify_commit_ext() Similar to ostree_repo_verify_commit(), but returns more verification details by way of an OstreeGpgVerifyResult object instead of a boolean.
2015-03-12 02:21:33 +03:00
ostree_repo_verify_commit_ext
lib: Add an API to GPG verify a commit given a remote Conceptually we've been moving towards having our GPG verification paths be per-remote. The code internally supports this, but we didn't expose an API to use it conveniently. This came up when trying to add a new `gpgkeypath` option, since right now rpm-ostree manually finds keyrings for the remote, and hence it wasn't looking at the keypath, and said "Unknown key" in status. Adding an API fixes this nicely. Closes: #576 Approved by: giuseppe
2016-11-16 19:50:43 +03:00
ostree_repo_verify_commit_for_remote
repo: Add ostree_repo_verify_summary() Verifies signatures on a summary -- both taken as GBytes inputs -- and returns an OstreeGpgVerifyResult.
2015-12-17 02:53:57 +03:00
ostree_repo_verify_summary
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_repo_regenerate_summary
<SUBSECTION Standard>
OSTREE_REPO
OSTREE_IS_REPO
OSTREE_TYPE_REPO
ostree_repo_get_type
ostree_repo_commit_modifier_get_type
ostree_repo_transaction_stats_get_type
libostree: Add gtk-doc section for ostree-repo.c
2013-08-17 21:22:58 +04:00
</SECTION>
doc: Add OstreeMutableTree, other minor doc updates
2013-09-13 07:53:13 +04:00
<SECTION>
docs: Get API docs working again This changes around a few things that didn't work for me: * Section names seem to be ostree-* instead of libostree-* * Also XML files are ostree-* (they didn't show up at all) - gtk-doc doesn't seem to parse const _OSTREE_PUBLIC correctly * pull documentation is now on the actual functions rather than stubs * Update gitignore with some more files And there some changes to make gtk-doc give fewer warnings (not finished) Closes: #327 Approved by: cgwalters
2016-06-05 01:16:05 +03:00
<FILE>ostree-repo-file</FILE>
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
OstreeRepoFile
ostree_repo_file_ensure_resolved
ostree_repo_file_get_xattrs
ostree_repo_file_get_repo
ostree_repo_file_get_root
ostree_repo_file_tree_set_metadata
ostree_repo_file_tree_get_contents_checksum
ostree_repo_file_tree_get_metadata_checksum
ostree_repo_file_tree_get_contents
ostree_repo_file_tree_get_metadata
ostree_repo_file_get_checksum
ostree_repo_file_tree_find_child
ostree_repo_file_tree_query_child
<SUBSECTION Standard>
OSTREE_REPO_FILE
OSTREE_IS_REPO_FILE
OSTREE_TYPE_REPO_FILE
OSTREE_REPO_FILE_CLASS
OSTREE_IS_REPO_FILE_CLASS
OSTREE_REPO_FILE_GET_CLASS
OstreeRepoFileClass
ostree_repo_file_get_type
</SECTION>
<SECTION>
docs: Get API docs working again This changes around a few things that didn't work for me: * Section names seem to be ostree-* instead of libostree-* * Also XML files are ostree-* (they didn't show up at all) - gtk-doc doesn't seem to parse const _OSTREE_PUBLIC correctly * pull documentation is now on the actual functions rather than stubs * Update gitignore with some more files And there some changes to make gtk-doc give fewer warnings (not finished) Closes: #327 Approved by: cgwalters
2016-06-05 01:16:05 +03:00
<FILE>ostree-sepolicy</FILE>
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
OstreeSePolicy
ostree_sepolicy_new
sepolicy: Add ostree_sepolicy_new_at() I'm porting other code away from `GFile`, and while we don't use this internally, it will let us do so at a later date. I'm averse to changing the code right now as we don't have good CI coverage of this. Closes: #746 Approved by: jlebon
2017-03-18 16:49:59 +03:00
ostree_sepolicy_new_at
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_sepolicy_get_path
ostree_sepolicy_get_name
ostree_sepolicy_get_label
Rename test-abi to test-symbols, start verifying symbols are documented We keep forgetting to update `apidoc/ostree-sections.txt`, so let's start enforcing it. Of course it turns out we had some bugs here like symbols marked as public but never implemented, etc. Those are fixed in the prior commits. Closes: #263 Approved by: giuseppe
2016-04-15 22:49:05 +03:00
ostree_sepolicy_get_csum
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
OstreeSePolicyRestoreconFlags
ostree_sepolicy_restorecon
Rename test-abi to test-symbols, start verifying symbols are documented We keep forgetting to update `apidoc/ostree-sections.txt`, so let's start enforcing it. Of course it turns out we had some bugs here like symbols marked as public but never implemented, etc. Those are fixed in the prior commits. Closes: #263 Approved by: giuseppe
2016-04-15 22:49:05 +03:00
ostree_sepolicy_setfscreatecon
ostree_sepolicy_fscreatecon_cleanup
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
<SUBSECTION Standard>
OSTREE_SEPOLICY
OSTREE_IS_SEPOLICY
OSTREE_TYPE_SEPOLICY
ostree_sepolicy_get_type
doc: Add OstreeMutableTree, other minor doc updates
2013-09-13 07:53:13 +04:00
</SECTION>
doc: Add some more OstreeSysroot docs
2013-09-16 06:44:25 +04:00
<SECTION>
docs: Get API docs working again This changes around a few things that didn't work for me: * Section names seem to be ostree-* instead of libostree-* * Also XML files are ostree-* (they didn't show up at all) - gtk-doc doesn't seem to parse const _OSTREE_PUBLIC correctly * pull documentation is now on the actual functions rather than stubs * Update gitignore with some more files And there some changes to make gtk-doc give fewer warnings (not finished) Closes: #327 Approved by: cgwalters
2016-06-05 01:16:05 +03:00
<FILE>ostree-sysroot</FILE>
doc: Add some more OstreeSysroot docs
2013-09-16 06:44:25 +04:00
OstreeSysroot
ostree_sysroot_new
ostree_sysroot_new_default
Support mounting /sysroot (and /boot) read-only We want to support extending the read-only state to cover `/sysroot` and `/boot`, since conceptually all of the data there should only be written via libostree. Or at least for `/boot` should *mostly* just be written by ostree. This change needs to be opt-in though to avoid breaking anyone. Add a `sysroot/readonly` key to the repository config which instructs `ostree-remount.service` to ensure `/sysroot` is read-only. This requires a bit of a dance because `/sysroot` is actually the same filesystem as `/`; so we make `/etc` a writable bind mount in this case. We also need to handle `/var` in the "OSTree default" case of a bind mount; the systemd generator now looks at the writability state of `/sysroot` and uses that to determine whether it should have the `var.mount` unit happen before or after `ostree-remount.service.` Also add an API to instruct the libostree shared library that the caller has created a new mount namespace. This way we can freely remount read-write. This approach extends upon in a much better way previous work we did to support remounting `/boot` read-write. Closes: https://github.com/ostreedev/ostree/issues/1265
2018-10-03 17:57:19 +03:00
ostree_sysroot_initialize
doc: Add some more OstreeSysroot docs
2013-09-16 06:44:25 +04:00
ostree_sysroot_get_path
sysroot: Clean up API Now that we have a real GObject for the sysroot, we have a convenient place to keep track of 4 pieces of state: * The current deployment list * The current bootversion * The current subbootversion * The current booted deployment (if any) Avoid requiring callers to pass all of this around and load it piecemeal; instead the new thing is ostree_sysroot_load().
2013-09-16 17:13:58 +04:00
ostree_sysroot_load
lib: Add ostree_sysroot_load_if_changed() API This will allow daemons like rpm-ostree to detect if there are any new deployments efficiently, in combination with using inotify. If there are any changes, rpm-ostree wants publish them on DBus. While we're here, add some changes to start doing unit C testing of the sysroot API.
2016-03-03 21:49:54 +03:00
ostree_sysroot_load_if_changed
sysroot: Add an API to lock If a system administrator happens to type `ostree admin upgrade` multiple times, currently that will lead to a potentially corrupted system. I originally attempted to do locking *internally* in `libostree`, but that didn't work out because currently a number of the commands perform multi-step operations that all need to be serialized. All of the current code in `ostree admin deploy` is an example. Therefore, allow callers to perform locking, as most of the higher level logic is presently implemented there. At some point, we can revisit having internal locking, but it will be difficult. A more likely approach would be similar to Java's approach with concurrency on iterators - a "fail fast" method.
2015-05-05 01:35:52 +03:00
ostree_sysroot_lock
sysroot: Add a try_lock() API The blocking locking API wasn't sufficient for use in the rpm-ostree daemon; it really wants to know if the lock is held, then continue to do other things (like service DBus requests), and get notification when the lock is available. We also add an async variant that can be called if the lock is not available. Implement a higher level "loop until lock is available" method in the `ostree admin` commandline.
2015-05-07 05:19:05 +03:00
ostree_sysroot_try_lock
ostree_sysroot_lock_async
ostree_sysroot_lock_finish
sysroot: Add an API to lock If a system administrator happens to type `ostree admin upgrade` multiple times, currently that will lead to a potentially corrupted system. I originally attempted to do locking *internally* in `libostree`, but that didn't work out because currently a number of the commands perform multi-step operations that all need to be serialized. All of the current code in `ostree admin deploy` is an example. Therefore, allow callers to perform locking, as most of the higher level logic is presently implemented there. At some point, we can revisit having internal locking, but it will be difficult. A more likely approach would be similar to Java's approach with concurrency on iterators - a "fail fast" method.
2015-05-05 01:35:52 +03:00
ostree_sysroot_unlock
Rename test-abi to test-symbols, start verifying symbols are documented We keep forgetting to update `apidoc/ostree-sections.txt`, so let's start enforcing it. Of course it turns out we had some bugs here like symbols marked as public but never implemented, etc. Those are fixed in the prior commits. Closes: #263 Approved by: giuseppe
2016-04-15 22:49:05 +03:00
ostree_sysroot_unload
Support mounting /sysroot (and /boot) read-only We want to support extending the read-only state to cover `/sysroot` and `/boot`, since conceptually all of the data there should only be written via libostree. Or at least for `/boot` should *mostly* just be written by ostree. This change needs to be opt-in though to avoid breaking anyone. Add a `sysroot/readonly` key to the repository config which instructs `ostree-remount.service` to ensure `/sysroot` is read-only. This requires a bit of a dance because `/sysroot` is actually the same filesystem as `/`; so we make `/etc` a writable bind mount in this case. We also need to handle `/var` in the "OSTree default" case of a bind mount; the systemd generator now looks at the writability state of `/sysroot` and uses that to determine whether it should have the `var.mount` unit happen before or after `ostree-remount.service.` Also add an API to instruct the libostree shared library that the caller has created a new mount namespace. This way we can freely remount read-write. This approach extends upon in a much better way previous work we did to support remounting `/boot` read-write. Closes: https://github.com/ostreedev/ostree/issues/1265
2018-10-03 17:57:19 +03:00
ostree_sysroot_set_mount_namespace_in_use
ostree_sysroot_is_booted
sysroot: Add ostree_sysroot_get_fd() This way external programs like rpm-ostree can do fd-relative operations on the deployment directories, like inspecting the RPM database. Closes: https://github.com/GNOME/ostree/pull/91
2015-04-17 16:13:31 +03:00
ostree_sysroot_get_fd
doc: Add some more OstreeSysroot docs
2013-09-16 06:44:25 +04:00
ostree_sysroot_ensure_initialized
sysroot: Clean up API Now that we have a real GObject for the sysroot, we have a convenient place to keep track of 4 pieces of state: * The current deployment list * The current bootversion * The current subbootversion * The current booted deployment (if any) Avoid requiring callers to pass all of this around and load it piecemeal; instead the new thing is ostree_sysroot_load().
2013-09-16 17:13:58 +04:00
ostree_sysroot_get_bootversion
ostree_sysroot_get_subbootversion
ostree_sysroot_get_deployments
ostree_sysroot_get_booted_deployment
doc: Add some more OstreeSysroot docs
2013-09-16 06:44:25 +04:00
ostree_sysroot_get_deployment_directory
Rename test-abi to test-symbols, start verifying symbols are documented We keep forgetting to update `apidoc/ostree-sections.txt`, so let's start enforcing it. Of course it turns out we had some bugs here like symbols marked as public but never implemented, etc. Those are fixed in the prior commits. Closes: #263 Approved by: giuseppe
2016-04-15 22:49:05 +03:00
ostree_sysroot_get_deployment_dirpath
doc: Add some more OstreeSysroot docs
2013-09-16 06:44:25 +04:00
ostree_sysroot_get_deployment_origin_path
ostree_sysroot_cleanup
sysroot: Add ostree_sysroot_prepare_cleanup() New public function works like ostree_sysroot_cleanup() EXCEPT FOR pruning the repository. Under the hood, add _ostree_sysroot_piecemeal_cleanup() which takes flags to better control what files are cleaned up. Both public cleanup functions are now wrappers for _ostree_sysroot_piecemeal_cleanup() with different flags.
2015-09-09 21:50:14 +03:00
ostree_sysroot_prepare_cleanup
lib/sysroot: Add wrapper API to prune system repository The initial motivation for this is that the "staging" code currently didn't rewrite the deployment refs, meaning that the staged commit could be pruned. Hence first, this new API ensures that deployments also hold a strong ref to their commit, without relying on the magical "deployment refs" that we inject. That has always been a weird artifact of the strict layering separation between OstreeSysroot and OstreeRepo. I also plan to change rpm-ostree to start using this API to hold references to base layers for client-side layering; it also today generates various refs. That said, if we still want to support multiple processes writing to a single repo (as happens on EndlessOS today) we still need to write refs; perhaps later we could add a concept of "generators" or something that create refs based on whatever logic? Another minor thing this fixes is that we had a printf inside the library; this propagates the pruned data to the higher level which can log however it likes. Closes: #1566 Approved by: jlebon
2018-04-30 18:19:17 +03:00
ostree_sysroot_cleanup_prune_repo
lib/sysroot: Add non-failable ostree_sysroot_repo() Having a failable accessor is annoying, since it's really common to reference both. Instead, open the repo once when we load the sysroot, and provide a non-failable accessor. This is also prep for `ostree_repo_open_at()`, which collapses the separation between `ostree_repo_new()` and `ostree_repo_open()`. Closes: #886 Approved by: jlebon
2017-05-26 02:38:52 +03:00
ostree_sysroot_repo
doc: Add some more OstreeSysroot docs
2013-09-16 06:44:25 +04:00
ostree_sysroot_get_repo
Add concept of "staged" deployment Add API to write a deployment state to `/run/ostree/staged-deployment`, along with a systemd service which runs at shutdown time. This is a big change to the ostree model for hosts, but it closes a longstanding set of bugs; many, many people have hit the "losing changes in /etc" problem. It also avoids the other problem of racing with programs that modify `/etc` such as LVM backups: https://bugzilla.redhat.com/show_bug.cgi?id=1365297 We need this in particular to go to a full-on model for automatically updated host systems where (like a dual-partition model) everything is fully prepared and the reboot can be taken asynchronously. Closes: https://github.com/ostreedev/ostree/issues/545 Closes: #1503 Approved by: jlebon
2018-02-22 23:27:59 +03:00
ostree_sysroot_get_staged_deployment
lib: Add ostree_sysroot_init_osname() API, bump mtime And change the command line to use it. rpm-ostree had a copy of this code, and thus there's a clear reason to have an API. While we're moving this into API, ensure the mtime on deploy is bumped after an osname is created, so that daemons like rpm-ostree can notice changes. (In reality, creating the directory should do this, but let's be double sure)
2016-03-03 19:39:33 +03:00
ostree_sysroot_init_osname
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_sysroot_deployment_set_kargs
Rename test-abi to test-symbols, start verifying symbols are documented We keep forgetting to update `apidoc/ostree-sections.txt`, so let's start enforcing it. Of course it turns out we had some bugs here like symbols marked as public but never implemented, etc. Those are fixed in the prior commits. Closes: #263 Approved by: giuseppe
2016-04-15 22:49:05 +03:00
ostree_sysroot_deployment_set_mutable
ostree_sysroot_deployment_unlock
sysroot: Add concept of deployment "pinning" 📌 Example user story: Jane rebases her OS to a new major version N, and wants to keep around N-1 even after a few upgrades for a while so she can easily roll back. I plan to add `rpm-ostree rebase --pin` to opt-in to this for example. Builds on the new `libostree-transient` group to store pinning state there. Closes: https://github.com/ostreedev/ostree/issues/1460 Closes: #1464 Approved by: jlebon
2018-02-23 20:46:32 +03:00
ostree_sysroot_deployment_set_pinned
doc: Add some more OstreeSysroot docs
2013-09-16 06:44:25 +04:00
ostree_sysroot_write_deployments
sysroot: Add ostree_sysroot_write_deployments_with_options() More sophisticated users of libostree like rpm-ostree need control over things like the system repository. Previously we introduced a "no cleanup" flag to `ostree_sysroot_simple_write_deployment()`, but that's a high level API that does filtering on its own. Since rpm-ostree needs more control, let's expose the bare essentials of the "sysroot commit" operation with an extensible options structure, where one of the options is whether or not to do post-transaction repository operations. Closes: #745 Approved by: jlebon
2017-03-20 17:19:04 +03:00
ostree_sysroot_write_deployments_with_options
Rename test-abi to test-symbols, start verifying symbols are documented We keep forgetting to update `apidoc/ostree-sections.txt`, so let's start enforcing it. Of course it turns out we had some bugs here like symbols marked as public but never implemented, etc. Those are fixed in the prior commits. Closes: #263 Approved by: giuseppe
2016-04-15 22:49:05 +03:00
ostree_sysroot_write_origin_file
Add concept of "staged" deployment Add API to write a deployment state to `/run/ostree/staged-deployment`, along with a systemd service which runs at shutdown time. This is a big change to the ostree model for hosts, but it closes a longstanding set of bugs; many, many people have hit the "losing changes in /etc" problem. It also avoids the other problem of racing with programs that modify `/etc` such as LVM backups: https://bugzilla.redhat.com/show_bug.cgi?id=1365297 We need this in particular to go to a full-on model for automatically updated host systems where (like a dual-partition model) everything is fully prepared and the reboot can be taken asynchronously. Closes: https://github.com/ostreedev/ostree/issues/545 Closes: #1503 Approved by: jlebon
2018-02-22 23:27:59 +03:00
ostree_sysroot_stage_tree
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_sysroot_deploy_tree
doc: Add some more OstreeSysroot docs
2013-09-16 06:44:25 +04:00
ostree_sysroot_get_merge_deployment
lib/sysroot: Add API to get pending/rollback for given stateroot This imports a function that is used in rpm-ostree, and it's also intended for use by https://github.com/advancedtelematic/aktualizr to display what deployment we're going to boot next after the reboot. Updated-by: Colin Walters <walters@verbum.org> Closes: #897 Approved by: OYTIS
2017-06-01 13:43:50 +03:00
ostree_sysroot_query_deployments_for
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_sysroot_origin_new_from_refspec
OstreeSysrootSimpleWriteDeploymentFlags
ostree_sysroot_simple_write_deployment
<SUBSECTION Standard>
OSTREE_SYSROOT
OSTREE_IS_SYSROOT
OSTREE_TYPE_SYSROOT
ostree_sysroot_get_type
doc: Add some more OstreeSysroot docs
2013-09-16 06:44:25 +04:00
</SECTION>
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
<SECTION>
docs: Get API docs working again This changes around a few things that didn't work for me: * Section names seem to be ostree-* instead of libostree-* * Also XML files are ostree-* (they didn't show up at all) - gtk-doc doesn't seem to parse const _OSTREE_PUBLIC correctly * pull documentation is now on the actual functions rather than stubs * Update gitignore with some more files And there some changes to make gtk-doc give fewer warnings (not finished) Closes: #327 Approved by: cgwalters
2016-06-05 01:16:05 +03:00
<FILE>ostree-sysroot-upgrader</FILE>
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
OstreeSysrootUpgrader
ostree_sysroot_upgrader_new
ostree_sysroot_upgrader_new_for_os
OstreeSysrootUpgraderFlags
ostree_sysroot_upgrader_new_for_os_with_flags
ostree_sysroot_upgrader_get_origin
upgrader: Add ostree_sysroot_upgrader_dup_origin() Convenience function returns a copy of the origin file, useful when modifying it.
2015-10-06 18:24:23 +03:00
ostree_sysroot_upgrader_dup_origin
doc: Update gtk-docs
2014-12-18 03:20:17 +03:00
ostree_sysroot_upgrader_set_origin
ostree_sysroot_upgrader_get_origin_description
ostree_sysroot_upgrader_check_timestamps
OstreeSysrootUpgraderPullFlags
ostree_sysroot_upgrader_pull
ostree_sysroot_upgrader_pull_one_dir
ostree_sysroot_upgrader_deploy
<SUBSECTION Standard>
OSTREE_SYSROOT_UPGRADER
OSTREE_IS_SYSROOT_UPGRADER
OSTREE_TYPE_SYSROOT_UPGRADER
ostree_sysroot_upgrader_get_type
ostree_sysroot_upgrader_flags_get_type
</SECTION>
Make P2P API public (no longer experimental) Currently the API that allows P2P operations (e.g. pulling an ostree ref from a LAN or USB source) is hidden behind the configure flag --enable-experimental-api. This commit makes the API public and makes that flag essentially a no-op (leaving it in place in case we want to use it again in the future). The P2P API has been tested over the last several months and proven to work. This means that since we're no longer using the "experimental" feature flag, P2P builds of Flatpak will fail when using versions of OSTree from this commit onwards, until Flatpak is patched in the near future. If you want to build Flatpak < 0.11.8 with P2P enabled and link against OSTree 2018.6, you'll have to patch Flatpak. However, since Flatpak won't yet have a hard dependency on OSTree 2018.6, it needs a new way to determine if the P2P API in OSTree is available, so this commit adds a "p2p" feature flag. This way the feature set is more semantically correct than if we had continued to use the "experimental" feature flag. In addition to making the P2P API public, this commit makes the P2P unit tests run by default, removes the f27-experimental CI instance that's no longer needed, changes a few man pages to reflect the changes, and updates the bash completion script to accept the new commands and options. Closes: #1596 Approved by: cgwalters
2018-05-23 01:55:14 +03:00
<SECTION>
<FILE>ostree-ref</FILE>
OstreeCollectionRef
ostree_collection_ref_new
ostree_collection_ref_dup
ostree_collection_ref_free
ostree_collection_ref_hash
ostree_collection_ref_equal
OstreeCollectionRefv
ostree_collection_ref_dupv
ostree_collection_ref_freev
<SUBSECTION Standard>
ostree_collection_ref_get_type
</SECTION>
<SECTION>
<FILE>ostree-remote</FILE>
OstreeRemote
ostree_remote_ref
ostree_remote_unref
ostree_remote_get_name
ostree_remote_get_url
<SUBSECTION Standard>
ostree_remote_get_type
</SECTION>
<SECTION>
<FILE>ostree-repo-experimental</FILE>
ostree_repo_find_remotes_async
ostree_repo_find_remotes_finish
ostree_repo_pull_from_remotes_async
ostree_repo_pull_from_remotes_finish
ostree_repo_resolve_keyring_for_collection
OSTREE_REPO_METADATA_REF
lib/repo: Define a metadata key, ostree.deploy-collection-id This commit defines a metadata key that tells clients to update their remote config to add a collection ID. This functionality is currently implemented in Flatpak for the key "xa.collection-id", but there are two good reasons for moving the key to OSTree: 1) Servers such as Flathub shouldn't set xa.collection-id in their metadata now or in the medium term future, because many users are still using old versions of Flatpak and OSTree[1] which would hit various bugs[2][3][4] on the P2P code paths that are enabled by collection IDs. Defining a new key means that only clients running recent (as-yet-unreleased) versions of Flatpak and OSTree will pay attention to it and deploy the collection ID, leaving the users on old versions unaffected. 2) OSTree is as "invested" in collection IDs as Flatpak, so there's no reason the key should be defined in Flatpak rather than here. According to Philip Withnall, the reason the key was put in Flatpak originally was that at the time there was uncertainty about tying OSTree to collection IDs. [1] https://ahayzen.com/direct/flathub.html#downloadsbyflatpakstacked [2] https://github.com/ostreedev/ostree/commit/e4e6d85ea [3] https://github.com/flatpak/flatpak/commit/5813639f [4] https://github.com/flatpak/flatpak/commit/5b21a5b7 Closes: #1726 Approved by: pwithnall
2018-09-20 00:59:47 +03:00
OSTREE_META_KEY_DEPLOY_COLLECTION_ID
Make P2P API public (no longer experimental) Currently the API that allows P2P operations (e.g. pulling an ostree ref from a LAN or USB source) is hidden behind the configure flag --enable-experimental-api. This commit makes the API public and makes that flag essentially a no-op (leaving it in place in case we want to use it again in the future). The P2P API has been tested over the last several months and proven to work. This means that since we're no longer using the "experimental" feature flag, P2P builds of Flatpak will fail when using versions of OSTree from this commit onwards, until Flatpak is patched in the near future. If you want to build Flatpak < 0.11.8 with P2P enabled and link against OSTree 2018.6, you'll have to patch Flatpak. However, since Flatpak won't yet have a hard dependency on OSTree 2018.6, it needs a new way to determine if the P2P API in OSTree is available, so this commit adds a "p2p" feature flag. This way the feature set is more semantically correct than if we had continued to use the "experimental" feature flag. In addition to making the P2P API public, this commit makes the P2P unit tests run by default, removes the f27-experimental CI instance that's no longer needed, changes a few man pages to reflect the changes, and updates the bash completion script to accept the new commands and options. Closes: #1596 Approved by: cgwalters
2018-05-23 01:55:14 +03:00
</SECTION>
<SECTION>
<FILE>ostree-repo-finder</FILE>
OstreeRepoFinder
ostree_repo_finder_resolve_async
ostree_repo_finder_resolve_finish
ostree_repo_finder_resolve_all_async
ostree_repo_finder_resolve_all_finish
OstreeRepoFinderResult
ostree_repo_finder_result_new
ostree_repo_finder_result_dup
ostree_repo_finder_result_free
ostree_repo_finder_result_compare
OstreeRepoFinderResultv
ostree_repo_finder_result_freev
<SUBSECTION Standard>
ostree_repo_finder_get_type
ostree_repo_finder_result_get_type
</SECTION>
<SECTION>
<FILE>ostree-repo-finder-avahi</FILE>
OstreeRepoFinderAvahi
ostree_repo_finder_avahi_new
ostree_repo_finder_avahi_start
ostree_repo_finder_avahi_stop
<SUBSECTION Standard>
ostree_repo_finder_avahi_get_type
</SECTION>
<SECTION>
<FILE>ostree-repo-finder-config</FILE>
OstreeRepoFinderConfig
ostree_repo_finder_config_new
<SUBSECTION Standard>
ostree_repo_finder_config_get_type
</SECTION>
<SECTION>
<FILE>ostree-repo-finder-mount</FILE>
OstreeRepoFinderMount
ostree_repo_finder_mount_new
<SUBSECTION Standard>
ostree_repo_finder_mount_get_type
</SECTION>
<SECTION>
<FILE>ostree-repo-finder-override</FILE>
OstreeRepoFinderOverride
ostree_repo_finder_override_new
ostree_repo_finder_override_add_uri
<SUBSECTION Standard>
ostree_repo_finder_override_get_type
</SECTION>
<SECTION>
<FILE>ostree-misc-experimental</FILE>
ostree_repo_get_collection_id
ostree_repo_set_collection_id
ostree_validate_collection_id
ostree_repo_list_collection_refs
ostree_repo_remote_list_collection_refs
ostree_repo_set_collection_ref_immediate
ostree_repo_transaction_set_collection_ref
ostree_repo_resolve_collection_ref
</SECTION>
lib/kargs: Make API public and upstream new rpm-ostree APIs This change makes public the current kargs API in src/libostree/ostree-kernel-args.c and adds documentations. Upstreams the new kargs API from rpm-ostree/src/libpriv/rpmostree-kargs-process.c Merges libostree_kernel_args_la_SOURCES to libostree_1_la_SOURCES in Makefile-libostree.am Upstreams tests/check/test-kargs.c from rpm-ostree. Closes: #1833 Closes: #1869 Approved by: jlebon
2019-05-28 21:02:54 +03:00
<SECTION>
<FILE>ostree-kernel-args</FILE>
OstreeKernelArgs
ostree_kernel_args_free
ostree_kernel_args_new
ostree_kernel_args_cleanup
ostree_kernel_args_replace_take
ostree_kernel_args_replace
ostree_kernel_args_replace_argv
ostree_kernel_args_append
ostree_kernel_args_append_argv
ostree_kernel_args_append_argv_filtered
ostree_kernel_args_new_replace
ostree_kernel_args_delete
ostree_kernel_args_delete_key_entry
ostree_kernel_args_append_proc_cmdline
ostree_kernel_args_parse_append
lib/kargs: add missing function to symbol-versioning table Signed-off-by: Rafael Fonseca <r4f4rfs@gmail.com> Closes: #1883 Approved by: jlebon
2019-07-02 14:26:25 +03:00
ostree_kernel_args_get_last_value
lib/kargs: Make API public and upstream new rpm-ostree APIs This change makes public the current kargs API in src/libostree/ostree-kernel-args.c and adds documentations. Upstreams the new kargs API from rpm-ostree/src/libpriv/rpmostree-kargs-process.c Merges libostree_kernel_args_la_SOURCES to libostree_1_la_SOURCES in Makefile-libostree.am Upstreams tests/check/test-kargs.c from rpm-ostree. Closes: #1833 Closes: #1869 Approved by: jlebon
2019-05-28 21:02:54 +03:00
ostree_kernel_args_from_string
ostree_kernel_args_to_strv
ostree_kernel_args_to_string
</SECTION>
lib/sign: initial implementation Added the initial version of signing interface allowing to allowing to sign and verify commits. Implemented initial signing modules: - dummy -- simple module allowing to sign/verify with ASCII string - ed25519 -- module allowing to sign/verify commit with ed25519 (EdDSA) signature scheme provided by libsodium library. Signed-off-by: Denis Pynkin <denis.pynkin@collabora.com>
2019-07-29 02:32:28 +03:00
<SECTION>
<FILE>ostree-sign</FILE>
OstreeSign
OstreeSignEd25519
ostree_sign_list_names
ostree_sign_commit
ostree_sign_commit_verify
ostree_sign_data
lib/sign: public API optimisation Removed from public `ostree_sign_detached_metadata_append` function. Renamed `metadata_verify` into `data_verify` to fit to real functionality. Signed-off-by: Denis Pynkin <denis.pynkin@collabora.com>
2019-10-07 02:59:15 +03:00
ostree_sign_data_verify
lib/sign: initial implementation Added the initial version of signing interface allowing to allowing to sign and verify commits. Implemented initial signing modules: - dummy -- simple module allowing to sign/verify with ASCII string - ed25519 -- module allowing to sign/verify commit with ed25519 (EdDSA) signature scheme provided by libsodium library. Signed-off-by: Denis Pynkin <denis.pynkin@collabora.com>
2019-07-29 02:32:28 +03:00
ostree_sign_get_by_name
ostree_sign_get_name
sign: API changes for public keys and CLI keys format API changes: - added function `ostree_sign_add_pk()` for multiple public keys using. - `ostree_sign_set_pk()` now substitutes all previously added keys. - added function `ostree_sign_load_pk()` allowed to load keys from file. - `ostree_sign_ed25519_load_pk()` able to load the raw keys list from file. - use base64 encoded public and private ed25519 keys for CLI and keys file. Signed-off-by: Denis Pynkin <denis.pynkin@collabora.com>
2019-08-09 22:07:57 +03:00
ostree_sign_add_pk
lib/sign: add ostree_seign_clear_keys function Add the function for implicit cleanup of all loaded keys. Signed-off-by: Denis Pynkin <denis.pynkin@collabora.com>
2019-10-27 22:45:48 +03:00
ostree_sign_clear_keys
lib/sign: initial implementation Added the initial version of signing interface allowing to allowing to sign and verify commits. Implemented initial signing modules: - dummy -- simple module allowing to sign/verify with ASCII string - ed25519 -- module allowing to sign/verify commit with ed25519 (EdDSA) signature scheme provided by libsodium library. Signed-off-by: Denis Pynkin <denis.pynkin@collabora.com>
2019-07-29 02:32:28 +03:00
ostree_sign_load_pk
ostree_sign_set_pk
ostree_sign_set_sk
lib/sign: new function for summary file signing Add function `ostree_sign_summary()` allowing to sign the summary file. Signed-off-by: Denis Pynkin <denis.pynkin@collabora.com>
2019-11-26 12:44:44 +03:00
ostree_sign_summary
lib/sign: initial implementation Added the initial version of signing interface allowing to allowing to sign and verify commits. Implemented initial signing modules: - dummy -- simple module allowing to sign/verify with ASCII string - ed25519 -- module allowing to sign/verify commit with ed25519 (EdDSA) signature scheme provided by libsodium library. Signed-off-by: Denis Pynkin <denis.pynkin@collabora.com>
2019-07-29 02:32:28 +03:00
<SUBSECTION Standard>
ostree_sign_get_type
ostree_sign_ed25519_get_type
</SECTION>
Reference in New Issue Copy Permalink