diff --git a/doc/Makefile.am b/doc/Makefile.am index 734937f6..9e6dd158 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -65,7 +65,27 @@ CFILE_GLOB=$(top_srcdir)/src/libostree/*.c # Header files to ignore when scanning. # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h -IGNORE_HFILES= $(NULL) +IGNORE_HFILES= \ + bupsplit.h \ + ostree-bootloader.h \ + ostree-bootloader-grub2.h \ + ostree-bootloader-syslinux.h \ + ostree-bootloader-uboot.h \ + ostree-cmdprivate.h \ + ostree-core-private.h \ + ostree-fetcher.h \ + ostree-gpg-verifier.h \ + ostree-kernel-args.h \ + ostree-libarchive-input-stream.h \ + ostree-lzma-compressor.h \ + ostree-lzma-decompressor.h \ + ostree-metalink.h \ + ostree-repo-file-enumerator.h \ + ostree-repo-private.h \ + ostree-repo-static-delta-private.h \ + ostree-sysroot-private.h \ + ostree-tls-cert-interaction.h \ + $(NULL) # Images to copy into HTML directory. # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png diff --git a/doc/ostree-docs.xml b/doc/ostree-docs.xml index 642198a7..aba94727 100644 --- a/doc/ostree-docs.xml +++ b/doc/ostree-docs.xml @@ -23,6 +23,15 @@ + + + + + + + + + API Index diff --git a/doc/ostree-sections.txt b/doc/ostree-sections.txt index 897d389b..535220de 100644 --- a/doc/ostree-sections.txt +++ b/doc/ostree-sections.txt @@ -1,13 +1,92 @@ +
+libostree-async-progress +OstreeAsyncProgress +ostree_async_progress_new +ostree_async_progress_new_and_connect +ostree_async_progress_get_status +ostree_async_progress_get_uint +ostree_async_progress_get_uint64 +ostree_async_progress_set_status +ostree_async_progress_set_uint +ostree_async_progress_set_uint64 +ostree_async_progress_finish + +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 +
+ +
+libostree-bootconfig-parser +OstreeBootconfigParser +ostree_bootconfig_parser_new +ostree_bootconfig_parser_clone +ostree_bootconfig_parser_parse +ostree_bootconfig_parser_write +ostree_bootconfig_parser_set +ostree_bootconfig_parser_get + +OSTREE_BOOTCONFIG_PARSER +OSTREE_IS_BOOTCONFIG_PARSER +OSTREE_TYPE_BOOTCONFIG_PARSER +ostree_bootconfig_parser_get_type +
+ +
+libostree-chain-input-stream +OstreeChainInputStream +ostree_chain_input_stream_new + +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 +
+ +
+libostree-checksum-input-stream +OstreeChecksumInputStream +ostree_checksum_input_stream_new + +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 +
+
libostree-core OSTREE_MAX_METADATA_SIZE +OSTREE_MAX_METADATA_WARN_SIZE OSTREE_MAX_RECURSION OstreeObjectType OSTREE_OBJECT_TYPE_IS_META OSTREE_OBJECT_TYPE_LAST +OSTREE_DIRMETA_GVARIANT_STRING OSTREE_DIRMETA_GVARIANT_FORMAT +OSTREE_FILEMETA_GVARIANT_STRING +OSTREE_FILEMETA_GVARIANT_FORMAT +OSTREE_TREE_GVARIANT_STRING OSTREE_TREE_GVARIANT_FORMAT +OSTREE_COMMIT_GVARIANT_STRING OSTREE_COMMIT_GVARIANT_FORMAT +OSTREE_SUMMARY_GVARIANT_STRING +OSTREE_SUMMARY_GVARIANT_FORMAT ostree_metadata_variant_type ostree_validate_checksum_string ostree_checksum_to_bytes @@ -17,6 +96,7 @@ ostree_checksum_from_bytes_v ostree_checksum_inplace_from_bytes ostree_checksum_inplace_to_bytes ostree_checksum_bytes_peek +ostree_checksum_bytes_peek_validate ostree_cmp_checksum_bytes ostree_validate_rev ostree_parse_refspec @@ -28,8 +108,6 @@ ostree_object_name_serialize ostree_object_name_deserialize ostree_object_to_string ostree_object_from_string -ostree_get_xattrs_for_file -ostree_set_xattrs ostree_content_stream_parse ostree_content_file_parse ostree_raw_file_to_content_stream @@ -46,75 +124,45 @@ ostree_validate_structureof_commit ostree_validate_structureof_dirtree ostree_validate_structureof_dirmeta ostree_commit_get_parent +ostree_commit_get_timestamp
-libostree-repo -OstreeRepo -OstreeRepoMode -ostree_repo_new -ostree_repo_new_default -ostree_repo_open -ostree_repo_create -ostree_repo_get_path -ostree_repo_get_mode -ostree_repo_mode_from_string -ostree_repo_get_config -ostree_repo_copy_config -ostree_repo_remote_list -ostree_repo_get_parent -ostree_repo_write_config -OstreeRepoTransactionStats -ostree_repo_scan_hardlinks -ostree_repo_prepare_transaction -ostree_repo_commit_transaction -ostree_repo_abort_transaction -ostree_repo_transaction_set_ref -ostree_repo_transaction_set_refspec -ostree_repo_has_object -ostree_repo_write_metadata -ostree_repo_write_metadata_async -ostree_repo_write_metadata_finish -ostree_repo_write_metadata_trusted -ostree_repo_write_metadata_stream_trusted -ostree_repo_write_content -ostree_repo_write_content_trusted -ostree_repo_write_content_async -ostree_repo_write_content_finish -ostree_repo_resolve_rev -ostree_repo_list_refs -ostree_repo_load_variant -ostree_repo_load_variant_if_exists -ostree_repo_load_file -ostree_repo_load_object_stream -ostree_repo_query_object_storage_size -ostree_repo_delete_object -OstreeRepoCommitFilterResult -OstreeRepoCommitFilter -OstreeRepoCommitModifier -OstreeRepoCommitModifierFlags -ostree_repo_commit_modifier_new -ostree_repo_commit_modifier_ref -ostree_repo_commit_modifier_unref -ostree_repo_write_directory_to_mtree -ostree_repo_write_archive_to_mtree -ostree_repo_write_mtree -ostree_repo_write_commit -OstreeRepoCheckoutMode -OstreeRepoCheckoutOverwriteMode -ostree_repo_checkout_tree -ostree_repo_checkout_gc -ostree_repo_read_commit -OstreeRepoListObjectsFlags -OSTREE_REPO_LIST_OBJECTS_VARIANT_TYPE -ostree_repo_list_objects -ostree_repo_traverse_new_reachable -ostree_repo_traverse_dirtree -ostree_repo_traverse_commit -OstreeRepoPruneFlags -ostree_repo_prune -OstreeRepoPullFlags -ostree_repo_pull +libostree-deployment +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 +ostree_deployment_set_index +ostree_deployment_set_bootserial +ostree_deployment_set_bootconfig +ostree_deployment_set_origin +ostree_deployment_clone + +OSTREE_DEPLOYMENT +OSTREE_IS_DEPLOYMENT +OSTREE_TYPE_DEPLOYMENT +ostree_deployment_get_type +
+ +
+libostree-diff +OstreeDiffFlags +OstreeDiffItem +ostree_diff_item_ref +ostree_diff_item_unref +ostree_diff_dirs +ostree_diff_print + +ostree_diff_item_get_type
@@ -132,12 +180,164 @@ ostree_mutable_tree_ensure_parent_dirs ostree_mutable_tree_walk ostree_mutable_tree_get_subdirs ostree_mutable_tree_get_files + +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 +
+ +
+libostree-repo +OstreeRepo +OstreeRepoMode +ostree_repo_mode_from_string +ostree_repo_new +ostree_repo_new_default +ostree_repo_open +ostree_repo_set_disable_fsync +ostree_repo_is_system +ostree_repo_create +ostree_repo_get_path +ostree_repo_get_mode +ostree_repo_get_config +ostree_repo_copy_config +ostree_repo_remote_add +ostree_repo_remote_delete +OstreeRepoRemoteChange +ostree_repo_remote_change +ostree_repo_remote_list +ostree_repo_remote_get_url +ostree_repo_get_parent +ostree_repo_write_config +OstreeRepoTransactionStats +ostree_repo_scan_hardlinks +ostree_repo_prepare_transaction +ostree_repo_commit_transaction +ostree_repo_abort_transaction +ostree_repo_transaction_set_refspec +ostree_repo_transaction_set_ref +ostree_repo_set_ref_immediate +ostree_repo_has_object +ostree_repo_write_metadata +ostree_repo_write_metadata_async +ostree_repo_write_metadata_finish +ostree_repo_write_content +ostree_repo_write_metadata_trusted +ostree_repo_write_metadata_stream_trusted +ostree_repo_write_content_trusted +ostree_repo_write_content_async +ostree_repo_write_content_finish +ostree_repo_resolve_rev +ostree_repo_list_refs +ostree_repo_load_variant +ostree_repo_load_variant_if_exists +ostree_repo_load_file +ostree_repo_load_object_stream +ostree_repo_query_object_storage_size +ostree_repo_import_object_from +ostree_repo_delete_object +OstreeRepoCommitFilterResult +OstreeRepoCommitFilter +OstreeRepoCommitModifier +OstreeRepoCommitModifierFlags +ostree_repo_commit_modifier_new +OstreeRepoCommitModifierXattrCallback +ostree_repo_commit_modifier_set_xattr_callback +ostree_repo_commit_modifier_set_sepolicy +ostree_repo_commit_modifier_ref +ostree_repo_commit_modifier_unref +ostree_repo_write_directory_to_mtree +ostree_repo_write_archive_to_mtree +ostree_repo_write_mtree +ostree_repo_write_commit +ostree_repo_read_commit_detached_metadata +ostree_repo_write_commit_detached_metadata +OstreeRepoCheckoutMode +OstreeRepoCheckoutOverwriteMode +ostree_repo_checkout_tree +ostree_repo_checkout_gc +ostree_repo_read_commit +OstreeRepoListObjectsFlags +OSTREE_REPO_LIST_OBJECTS_VARIANT_TYPE +ostree_repo_list_objects +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 +ostree_repo_traverse_new_reachable +ostree_repo_traverse_commit +ostree_repo_traverse_commit_union +OstreeRepoPruneFlags +ostree_repo_prune +OstreeRepoPullFlags +ostree_repo_pull +ostree_repo_pull_one_dir +ostree_repo_pull_with_options +ostree_repo_sign_commit +ostree_repo_append_gpg_signature +ostree_repo_verify_commit +ostree_repo_regenerate_summary + +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-repo-file +OstreeRepoFile +ostree_repo_file_ensure_resolved +ostree_repo_file_get_xattrs +ostree_repo_file_get_repo +ostree_repo_file_get_root +ostree_repo_file_make_empty_tree +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 + +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 +
+ +
+libostree-sepolicy +OstreeSePolicy +ostree_sepolicy_new +ostree_sepolicy_get_path +ostree_sepolicy_get_name +ostree_sepolicy_get_label +OstreeSePolicyRestoreconFlags +ostree_sepolicy_restorecon + +OSTREE_SEPOLICY +OSTREE_IS_SEPOLICY +OSTREE_TYPE_SEPOLICY +ostree_sepolicy_get_type
libostree-sysroot OstreeSysroot -ostree_sysroot_get_type ostree_sysroot_new ostree_sysroot_new_default ostree_sysroot_get_path @@ -151,7 +351,40 @@ ostree_sysroot_get_deployment_directory ostree_sysroot_get_deployment_origin_path ostree_sysroot_cleanup ostree_sysroot_get_repo +ostree_sysroot_deployment_set_kargs ostree_sysroot_write_deployments -ostree_sysroot_deploy_one_tree +ostree_sysroot_deploy_tree ostree_sysroot_get_merge_deployment +ostree_sysroot_origin_new_from_refspec +OstreeSysrootSimpleWriteDeploymentFlags +ostree_sysroot_simple_write_deployment + +OSTREE_SYSROOT +OSTREE_IS_SYSROOT +OSTREE_TYPE_SYSROOT +ostree_sysroot_get_type
+ +
+libostree-sysroot-upgrader +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 +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 + +OSTREE_SYSROOT_UPGRADER +OSTREE_IS_SYSROOT_UPGRADER +OSTREE_TYPE_SYSROOT_UPGRADER +ostree_sysroot_upgrader_get_type +ostree_sysroot_upgrader_flags_get_type +
+ diff --git a/src/libostree/ostree-repo.h b/src/libostree/ostree-repo.h index ce786b19..b08c0f5e 100644 --- a/src/libostree/ostree-repo.h +++ b/src/libostree/ostree-repo.h @@ -119,7 +119,7 @@ gboolean ostree_repo_write_config (OstreeRepo *self, * in the repository after this transaction has completed. * @content_objects_written: The number of content objects that * were written to the repository in this transaction. - * @content_bytes_total: The amount of data added to the repository, + * @content_bytes_written: The amount of data added to the repository, * in bytes, counting only content objects. * * A list of statistics for each transaction that may be