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
This commit is contained in:
Mathnerd314
Atomic Bot
parent
693b4ec4be
commit
1b88dc7f90
|
|
@ -32,6 +32,7 @@
|
|||
/ostree.args
|
||||
/ostree.hierarchy
|
||||
/ostree.interfaces
|
||||
/ostree-overrides.txt
|
||||
/ostree.pdf
|
||||
/ostree.prerequisites
|
||||
/ostree.signals
|
||||
|
|
@ -48,4 +49,5 @@
|
|||
/tmpl/*.bak
|
||||
/tmpl/ostree-unused.sgml
|
||||
/xml
|
||||
/version.xml
|
||||
_libs
|
||||
|
|
|
|||
|
|
@ -13,25 +13,23 @@
|
|||
|
||||
<chapter xml:id="reference">
|
||||
<title>API Reference</title>
|
||||
<xi:include href="xml/libostree-core.xml"/>
|
||||
<xi:include href="xml/libostree-repo.xml"/>
|
||||
<xi:include href="xml/libostree-mutable-tree.xml"/>
|
||||
<xi:include href="xml/libostree-sysroot.xml"/>
|
||||
<xi:include href="xml/libostree-async-progress.xml"/>
|
||||
<xi:include href="xml/libostree-sepolicy.xml"/>
|
||||
<xi:include href="xml/libostree-sysroot-upgrader.xml"/>
|
||||
<xi:include href="xml/libostree-gpg-verify-result.xml"/>
|
||||
<xi:include href="xml/libostree-bootconfig-parser.xml"/>
|
||||
<xi:include href="xml/libostree-chain-input-stream.xml"/>
|
||||
<xi:include href="xml/libostree-checksum-input-stream.xml"/>
|
||||
<xi:include href="xml/libostree-deployment.xml"/>
|
||||
<xi:include href="xml/libostree-diff.xml"/>
|
||||
<xi:include href="xml/libostree-repo-file.xml"/>
|
||||
|
||||
<xi:include href="xml/ostree-core.xml"/>
|
||||
<xi:include href="xml/ostree-repo.xml"/>
|
||||
<xi:include href="xml/ostree-mutable-tree.xml"/>
|
||||
<xi:include href="xml/ostree-sysroot.xml"/>
|
||||
<xi:include href="xml/ostree-async-progress.xml"/>
|
||||
<xi:include href="xml/ostree-sepolicy.xml"/>
|
||||
<xi:include href="xml/ostree-sysroot-upgrader.xml"/>
|
||||
<xi:include href="xml/ostree-gpg-verify-result.xml"/>
|
||||
<xi:include href="xml/ostree-bootconfig-parser.xml"/>
|
||||
<xi:include href="xml/ostree-chain-input-stream.xml"/>
|
||||
<xi:include href="xml/ostree-checksum-input-stream.xml"/>
|
||||
<xi:include href="xml/ostree-deployment.xml"/>
|
||||
<xi:include href="xml/ostree-diff.xml"/>
|
||||
<xi:include href="xml/ostree-repo-file.xml"/>
|
||||
<index id="api-index-full">
|
||||
<title>API Index</title>
|
||||
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
|
||||
</index>
|
||||
|
||||
</chapter>
|
||||
</book>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<SECTION>
|
||||
<FILE>libostree-async-progress</FILE>
|
||||
<FILE>ostree-async-progress</FILE>
|
||||
OstreeAsyncProgress
|
||||
ostree_async_progress_new
|
||||
ostree_async_progress_new_and_connect
|
||||
|
|
@ -22,7 +22,7 @@ ostree_async_progress_get_type
|
|||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>libostree-bootconfig-parser</FILE>
|
||||
<FILE>ostree-bootconfig-parser</FILE>
|
||||
OstreeBootconfigParser
|
||||
ostree_bootconfig_parser_new
|
||||
ostree_bootconfig_parser_clone
|
||||
|
|
@ -40,7 +40,7 @@ ostree_bootconfig_parser_get_type
|
|||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>libostree-chain-input-stream</FILE>
|
||||
<FILE>ostree-chain-input-stream</FILE>
|
||||
OstreeChainInputStream
|
||||
ostree_chain_input_stream_new
|
||||
<SUBSECTION Standard>
|
||||
|
|
@ -56,7 +56,7 @@ ostree_chain_input_stream_get_type
|
|||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>libostree-checksum-input-stream</FILE>
|
||||
<FILE>ostree-checksum-input-stream</FILE>
|
||||
OstreeChecksumInputStream
|
||||
ostree_checksum_input_stream_new
|
||||
<SUBSECTION Standard>
|
||||
|
|
@ -72,7 +72,7 @@ ostree_checksum_input_stream_get_type
|
|||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>libostree-core</FILE>
|
||||
<FILE>ostree-core</FILE>
|
||||
OSTREE_MAX_METADATA_SIZE
|
||||
OSTREE_MAX_METADATA_WARN_SIZE
|
||||
OSTREE_MAX_RECURSION
|
||||
|
|
@ -133,7 +133,7 @@ ostree_commit_get_timestamp
|
|||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>libostree-deployment</FILE>
|
||||
<FILE>ostree-deployment</FILE>
|
||||
OstreeDeployment
|
||||
ostree_deployment_hash
|
||||
ostree_deployment_equal
|
||||
|
|
@ -162,7 +162,7 @@ ostree_deployment_get_type
|
|||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>libostree-diff</FILE>
|
||||
<FILE>ostree-diff</FILE>
|
||||
OstreeDiffFlags
|
||||
OstreeDiffItem
|
||||
ostree_diff_item_ref
|
||||
|
|
@ -174,7 +174,7 @@ ostree_diff_item_get_type
|
|||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>libostree-gpg-verify-result</FILE>
|
||||
<FILE>ostree-gpg-verify-result</FILE>
|
||||
OstreeGpgVerifyResult
|
||||
OstreeGpgSignatureAttr
|
||||
ostree_gpg_verify_result_count_all
|
||||
|
|
@ -193,8 +193,33 @@ OSTREE_TYPE_GPG_VERIFY_RESULT
|
|||
ostree_gpg_verify_result_get_type
|
||||
</SECTION>
|
||||
|
||||
<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>libostree-mutable-tree</FILE>
|
||||
<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>
|
||||
|
||||
<SECTION>
|
||||
<FILE>ostree-mutable-tree</FILE>
|
||||
OstreeMutableTree
|
||||
ostree_mutable_tree_new
|
||||
ostree_mutable_tree_set_metadata_checksum
|
||||
|
|
@ -220,7 +245,7 @@ ostree_mutable_tree_get_type
|
|||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>libostree-repo</FILE>
|
||||
<FILE>ostree-repo</FILE>
|
||||
OstreeRepo
|
||||
OstreeRepoMode
|
||||
ostree_repo_mode_from_string
|
||||
|
|
@ -362,7 +387,7 @@ ostree_repo_transaction_stats_get_type
|
|||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>libostree-repo-file</FILE>
|
||||
<FILE>ostree-repo-file</FILE>
|
||||
OstreeRepoFile
|
||||
ostree_repo_file_ensure_resolved
|
||||
ostree_repo_file_get_xattrs
|
||||
|
|
@ -388,7 +413,7 @@ ostree_repo_file_get_type
|
|||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>libostree-sepolicy</FILE>
|
||||
<FILE>ostree-sepolicy</FILE>
|
||||
OstreeSePolicy
|
||||
ostree_sepolicy_new
|
||||
ostree_sepolicy_get_path
|
||||
|
|
@ -407,7 +432,7 @@ ostree_sepolicy_get_type
|
|||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>libostree-sysroot</FILE>
|
||||
<FILE>ostree-sysroot</FILE>
|
||||
OstreeSysroot
|
||||
ostree_sysroot_new
|
||||
ostree_sysroot_new_default
|
||||
|
|
@ -451,7 +476,7 @@ ostree_sysroot_get_type
|
|||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>libostree-sysroot-upgrader</FILE>
|
||||
<FILE>ostree-sysroot-upgrader</FILE>
|
||||
OstreeSysrootUpgrader
|
||||
ostree_sysroot_upgrader_new
|
||||
ostree_sysroot_upgrader_new_for_os
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@
|
|||
#include "ostree-async-progress.h"
|
||||
|
||||
/**
|
||||
* SECTION:libostree-async-progress
|
||||
* SECTION:ostree-async-progress
|
||||
* @title: Progress notification system for asynchronous operations
|
||||
* @short_description: Values representing progress
|
||||
*
|
||||
|
|
|
|||
|
|
@ -83,7 +83,7 @@ _ostree_make_temporary_symlink_at (int tmp_dirfd,
|
|||
|
||||
GFileInfo * _ostree_header_gfile_info_new (mode_t mode, uid_t uid, gid_t gid);
|
||||
|
||||
/* XX + / + checksum-2 + . + extension, but let's just use 256 for a
|
||||
/* XX/checksum-2.extension, but let's just use 256 for a
|
||||
* bit of overkill.
|
||||
*/
|
||||
#define _OSTREE_LOOSE_PATH_MAX (256)
|
||||
|
|
@ -112,8 +112,7 @@ _ostree_get_relative_static_delta_part_path (const char *from,
|
|||
const char *to,
|
||||
guint i);
|
||||
|
||||
static inline char *
|
||||
_ostree_get_commitpartial_path (const char *checksum)
|
||||
static inline char * _ostree_get_commitpartial_path (const char *checksum)
|
||||
{
|
||||
return g_strconcat ("state/", checksum, ".commitpartial", NULL);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -47,7 +47,7 @@ zlib_file_header_parse (GVariant *metadata,
|
|||
GError **error);
|
||||
|
||||
/**
|
||||
* SECTION:libostree-core
|
||||
* SECTION:ostree-core
|
||||
* @title: Core repository-independent functions
|
||||
* @short_description: Create, validate, and convert core data types
|
||||
*
|
||||
|
|
|
|||
|
|
@ -59,7 +59,7 @@ G_BEGIN_DECLS
|
|||
* @OSTREE_OBJECT_TYPE_DIR_TREE: List of children (trees or files), and metadata
|
||||
* @OSTREE_OBJECT_TYPE_DIR_META: Directory metadata
|
||||
* @OSTREE_OBJECT_TYPE_COMMIT: Toplevel object, refers to tree and dirmeta for root
|
||||
* @OSTREE_OBJECT_TYPE_COMMIT_TOMBSTONE: Toplevel object, refers to a deleted commit
|
||||
* @OSTREE_OBJECT_TYPE_TOMBSTONE_COMMIT: Toplevel object, refers to a deleted commit
|
||||
*
|
||||
* Enumeration for core object types; %OSTREE_OBJECT_TYPE_FILE is for
|
||||
* content, the other types are metadata.
|
||||
|
|
@ -153,9 +153,9 @@ typedef enum {
|
|||
|
||||
/**
|
||||
* OstreeRepoMode:
|
||||
* @OSTREE_REPO_MODE_BARE: Files are stored as themselves; can only be written as root
|
||||
* @OSTREE_REPO_MODE_BARE: Files are stored as themselves; checkouts are hardlinks; can only be written as root
|
||||
* @OSTREE_REPO_MODE_ARCHIVE_Z2: Files are compressed, should be owned by non-root. Can be served via HTTP
|
||||
* @OSTREE_REPO_MODE_BARE_USER: Files are stored as themselves, except ownership; can be written by user
|
||||
* @OSTREE_REPO_MODE_BARE_USER: Files are stored as themselves, except ownership; can be written by user. Hardlinks work only in user checkouts.
|
||||
*
|
||||
* See the documentation of #OstreeRepo for more information about the
|
||||
* possible modes.
|
||||
|
|
@ -166,8 +166,8 @@ typedef enum {
|
|||
OSTREE_REPO_MODE_BARE_USER
|
||||
} OstreeRepoMode;
|
||||
|
||||
const _OSTREE_PUBLIC
|
||||
GVariantType *ostree_metadata_variant_type (OstreeObjectType objtype);
|
||||
_OSTREE_PUBLIC
|
||||
const GVariantType *ostree_metadata_variant_type (OstreeObjectType objtype);
|
||||
|
||||
_OSTREE_PUBLIC
|
||||
gboolean ostree_validate_checksum_string (const char *sha256,
|
||||
|
|
@ -242,7 +242,8 @@ void ostree_object_from_string (const char *str,
|
|||
gchar **out_checksum,
|
||||
OstreeObjectType *out_objtype);
|
||||
|
||||
_OSTREE_PUBLIC gboolean
|
||||
_OSTREE_PUBLIC
|
||||
gboolean
|
||||
ostree_content_stream_parse (gboolean compressed,
|
||||
GInputStream *input,
|
||||
guint64 input_length,
|
||||
|
|
|
|||
|
|
@ -24,19 +24,33 @@
|
|||
|
||||
G_BEGIN_DECLS
|
||||
|
||||
|
||||
/**
|
||||
* OstreeDeployment:
|
||||
* @parent_instance:
|
||||
* @index: Global offset
|
||||
* @osname:
|
||||
* @csum: OSTree checksum of tree
|
||||
* @deployserial: How many times this particular csum appears in deployment list
|
||||
* @bootcsum: Checksum of kernel+initramfs
|
||||
* @bootserial: An integer assigned to this tree per its ${bootcsum}
|
||||
* @bootconfig: Bootloader configuration
|
||||
* @origin: How to construct an upgraded version of this tree
|
||||
* @unlocked: The unlocked state
|
||||
*/
|
||||
struct _OstreeDeployment
|
||||
{
|
||||
GObject parent_instance;
|
||||
|
||||
int index; /* Global offset */
|
||||
char *osname; /* osname */
|
||||
char *csum; /* OSTree checksum of tree */
|
||||
int deployserial; /* How many times this particular csum appears in deployment list */
|
||||
char *bootcsum; /* Checksum of kernel+initramfs */
|
||||
int bootserial; /* An integer assigned to this tree per its ${bootcsum} */
|
||||
OstreeBootconfigParser *bootconfig; /* Bootloader configuration */
|
||||
GKeyFile *origin; /* How to construct an upgraded version of this tree */
|
||||
OstreeDeploymentUnlockedState unlocked; /* The unlocked state */
|
||||
int index;
|
||||
char *osname;
|
||||
char *csum;
|
||||
int deployserial;
|
||||
char *bootcsum;
|
||||
int bootserial;
|
||||
OstreeBootconfigParser *bootconfig;
|
||||
GKeyFile *origin;
|
||||
OstreeDeploymentUnlockedState unlocked;
|
||||
};
|
||||
|
||||
void _ostree_deployment_set_bootcsum (OstreeDeployment *self, const char *bootcsum);
|
||||
|
|
|
|||
|
|
@ -210,6 +210,8 @@ diff_add_dir_recurse (GFile *d,
|
|||
* @modified: (element-type OstreeDiffItem): Modified files
|
||||
* @removed: (element-type Gio.File): Removed files
|
||||
* @added: (element-type Gio.File): Added files
|
||||
* @cancellable: Cancellable
|
||||
* @error: Error
|
||||
*
|
||||
* Compute the difference between directory @a and @b as 3 separate
|
||||
* sets of #OstreeDiffItem in @modified, @removed, and @added.
|
||||
|
|
|
|||
|
|
@ -27,11 +27,17 @@
|
|||
|
||||
G_BEGIN_DECLS
|
||||
|
||||
/**
|
||||
* OstreeDiffFlags:
|
||||
*/
|
||||
typedef enum {
|
||||
OSTREE_DIFF_FLAGS_NONE = 0,
|
||||
OSTREE_DIFF_FLAGS_IGNORE_XATTRS = (1 << 0)
|
||||
} OstreeDiffFlags;
|
||||
|
||||
/**
|
||||
* OstreeDiffItem:
|
||||
*/
|
||||
typedef struct _OstreeDiffItem OstreeDiffItem;
|
||||
struct _OstreeDiffItem
|
||||
{
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@
|
|||
#include "ostree-gpg-verify-result-private.h"
|
||||
|
||||
/**
|
||||
* SECTION: libostree-gpg-verify-result
|
||||
* SECTION: ostree-gpg-verify-result
|
||||
* @title: GPG signature verification results
|
||||
* @short_description: Inspect detached GPG signatures
|
||||
*
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ enum {
|
|||
|
||||
/**
|
||||
* SECTION:ostree-lzma-compressor
|
||||
* @short_description: LZMA compressor
|
||||
* @title: LZMA compressor
|
||||
*
|
||||
* An implementation of #GConverter that compresses data using
|
||||
* LZMA.
|
||||
|
|
|
|||
|
|
@ -29,6 +29,14 @@ enum {
|
|||
PROP_0,
|
||||
};
|
||||
|
||||
/**
|
||||
* SECTION:ostree-lzma-decompressor
|
||||
* @title: LZMA decompressor
|
||||
*
|
||||
* An implementation of #GConverter that decompresses data using
|
||||
* LZMA.
|
||||
*/
|
||||
|
||||
static void _ostree_lzma_decompressor_iface_init (GConverterIface *iface);
|
||||
|
||||
struct _OstreeLzmaDecompressor
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@
|
|||
#include "ostree-core.h"
|
||||
|
||||
/**
|
||||
* SECTION:libostree-mutable-tree
|
||||
* SECTION:ostree-mutable-tree
|
||||
* @title: In-memory modifiable filesystem tree
|
||||
* @short_description: Modifiable filesystem tree
|
||||
*
|
||||
|
|
|
|||
|
|
@ -84,7 +84,8 @@ gboolean ostree_mutable_tree_lookup (OstreeMutableTree *self,
|
|||
OstreeMutableTree **out_subdir,
|
||||
GError **error);
|
||||
|
||||
_OSTREE_PUBLIC gboolean
|
||||
_OSTREE_PUBLIC
|
||||
gboolean
|
||||
ostree_mutable_tree_ensure_parent_dirs (OstreeMutableTree *self,
|
||||
GPtrArray *split_path,
|
||||
const char *metadata_checksum,
|
||||
|
|
|
|||
|
|
@ -2122,7 +2122,31 @@ repo_remote_fetch_summary (OstreeRepo *self,
|
|||
* ------------------------------------------------------------------------------------------
|
||||
*/
|
||||
|
||||
/* Documented below */
|
||||
/**
|
||||
* ostree_repo_pull_with_options:
|
||||
* @self: Repo
|
||||
* @remote_name: Name of remote
|
||||
* @options: A GVariant a{sv} with an extensible set of flags.
|
||||
* @progress: (allow-none): Progress
|
||||
* @cancellable: Cancellable
|
||||
* @error: Error
|
||||
*
|
||||
* Like ostree_repo_pull(), but supports an extensible set of flags.
|
||||
* The following are currently defined:
|
||||
*
|
||||
* * refs (as): Array of string refs
|
||||
* * flags (i): An instance of #OstreeRepoPullFlags
|
||||
* * subdir (s): Pull just this subdirectory
|
||||
* * override-remote-name (s): If local, add this remote to refspec
|
||||
* * gpg-verify (b): GPG verify commits
|
||||
* * gpg-verify-summary (b): GPG verify summary
|
||||
* * depth (i): How far in the history to traverse; default is 0, -1 means infinite
|
||||
* * disable-static-deltas (b): Do not use static deltas
|
||||
* * require-static-deltas (b): Require static deltas
|
||||
* * override-commit-ids (as): Array of specific commit IDs to fetch for refs
|
||||
* * dry-run (b): Only print information on what will be downloaded (requires static deltas)
|
||||
* * override-url (s): Fetch objects from this URL if remote specifies no metalink in options
|
||||
*/
|
||||
gboolean
|
||||
ostree_repo_pull_with_options (OstreeRepo *self,
|
||||
const char *remote_name_or_baseurl,
|
||||
|
|
@ -2836,7 +2860,24 @@ ostree_repo_pull_with_options (OstreeRepo *self,
|
|||
return ret;
|
||||
}
|
||||
|
||||
/* Documented below */
|
||||
/**
|
||||
* ostree_repo_remote_fetch_summary_with_options:
|
||||
* @self: Self
|
||||
* @name: name of a remote
|
||||
* @options: (nullable): A GVariant a{sv} with an extensible set of flags
|
||||
* @out_summary: (nullable): return location for raw summary data, or %NULL
|
||||
* @out_signatures: (nullable): return location for raw summary signature
|
||||
* data, or %NULL
|
||||
* @cancellable: a #GCancellable
|
||||
* @error: a #GError
|
||||
*
|
||||
* Like ostree_repo_remote_fetch_summary(), but supports an extensible set of flags.
|
||||
* The following are currently defined:
|
||||
*
|
||||
* - override-url (s): Fetch summary from this URL if remote specifies no metalink in options
|
||||
*
|
||||
* Returns: %TRUE on success, %FALSE on failure
|
||||
*/
|
||||
gboolean
|
||||
ostree_repo_remote_fetch_summary_with_options (OstreeRepo *self,
|
||||
const char *name,
|
||||
|
|
@ -2908,31 +2949,6 @@ out:
|
|||
|
||||
#else /* HAVE_LIBSOUP */
|
||||
|
||||
/**
|
||||
* ostree_repo_pull_with_options:
|
||||
* @self: Repo
|
||||
* @remote_name: Name of remote
|
||||
* @options: A GVariant a{sv} with an extensible set of flags.
|
||||
* @progress: (allow-none): Progress
|
||||
* @cancellable: Cancellable
|
||||
* @error: Error
|
||||
*
|
||||
* Like ostree_repo_pull(), but supports an extensible set of flags.
|
||||
* The following are currently defined:
|
||||
*
|
||||
* * refs (as): Array of string refs
|
||||
* * flags (i): An instance of #OstreeRepoPullFlags
|
||||
* * subdir (s): Pull just this subdirectory
|
||||
* * override-remote-name (s): If local, add this remote to refspec
|
||||
* * gpg-verify (b): GPG verify commits
|
||||
* * gpg-verify-summary (b): GPG verify summary
|
||||
* * depth (i): How far in the history to traverse; default is 0, -1 means infinite
|
||||
* * disable-static-deltas (b): Do not use static deltas
|
||||
* * require-static-deltas (b): Require static deltas
|
||||
* * override-commit-ids (as): Array of specific commit IDs to fetch for refs
|
||||
* * dry-run (b): Only print information on what will be downloaded (requires static deltas)
|
||||
* * override-url (s): Fetch objects from this URL if remote specifies no metalink in options
|
||||
*/
|
||||
gboolean
|
||||
ostree_repo_pull_with_options (OstreeRepo *self,
|
||||
const char *remote_name,
|
||||
|
|
@ -2946,24 +2962,6 @@ ostree_repo_pull_with_options (OstreeRepo *self,
|
|||
return FALSE;
|
||||
}
|
||||
|
||||
/**
|
||||
* ostree_repo_remote_fetch_summary_with_options:
|
||||
* @self: Self
|
||||
* @name: name of a remote
|
||||
* @options: (nullable): A GVariant a{sv} with an extensible set of flags
|
||||
* @out_summary: (nullable): return location for raw summary data, or %NULL
|
||||
* @out_signatures: (nullable): return location for raw summary signature
|
||||
* data, or %NULL
|
||||
* @cancellable: a #GCancellable
|
||||
* @error: a #GError
|
||||
*
|
||||
* Like ostree_repo_remote_fetch_summary(), but supports an extensible set of flags.
|
||||
* The following are currently defined:
|
||||
*
|
||||
* - override-url (s): Fetch summary from this URL if remote specifies no metalink in options
|
||||
*
|
||||
* Returns: %TRUE on success, %FALSE on failure
|
||||
*/
|
||||
gboolean
|
||||
ostree_repo_remote_fetch_summary_with_options (OstreeRepo *self,
|
||||
const char *name,
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@
|
|||
#include <glib/gstdio.h>
|
||||
|
||||
/**
|
||||
* SECTION:libostree-repo
|
||||
* SECTION:ostree-repo
|
||||
* @title: Content-addressed object store
|
||||
* @short_description: A git-like storage system for operating system binaries
|
||||
*
|
||||
|
|
@ -2309,6 +2309,8 @@ ostree_repo_set_disable_fsync (OstreeRepo *self,
|
|||
* @self: An #OstreeRepo
|
||||
* @dfd: directory fd
|
||||
* @path: subpath in @dfd
|
||||
* @cancellable: a #GCancellable
|
||||
* @error: a #GError
|
||||
*
|
||||
* Set a custom location for the cache directory used for e.g.
|
||||
* per-remote summary caches. Setting this manually is useful when
|
||||
|
|
@ -4183,9 +4185,7 @@ out:
|
|||
|
||||
/**
|
||||
* ostree_repo_sign_delta:
|
||||
* @self: Self
|
||||
* @from_commit: SHA256 of starting commit to sign, or %NULL
|
||||
* @to_commit: SHA256 of target commit to sign
|
||||
*
|
||||
* This function is deprecated, sign the summary file instead.
|
||||
* Add a GPG signature to a static delta.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -115,6 +115,10 @@ gboolean ostree_repo_remote_delete (OstreeRepo *self,
|
|||
GCancellable *cancellable,
|
||||
GError **error);
|
||||
|
||||
/**
|
||||
* OstreeRepoRemoteChange:
|
||||
* The remote change operation.
|
||||
*/
|
||||
typedef enum {
|
||||
OSTREE_REPO_REMOTE_CHANGE_ADD,
|
||||
OSTREE_REPO_REMOTE_CHANGE_ADD_IF_NOT_EXISTS,
|
||||
|
|
@ -223,6 +227,10 @@ gboolean ostree_repo_write_config (OstreeRepo *self,
|
|||
* were written to the repository in this transaction.
|
||||
* @content_bytes_written: The amount of data added to the repository,
|
||||
* in bytes, counting only content objects.
|
||||
* @padding1: reserved
|
||||
* @padding2: reserved
|
||||
* @padding3: reserved
|
||||
* @padding4: reserved
|
||||
*
|
||||
* A list of statistics for each transaction that may be
|
||||
* interesting for reporting purposes.
|
||||
|
|
@ -699,7 +707,8 @@ typedef enum {
|
|||
OSTREE_REPO_CHECKOUT_OVERWRITE_UNION_FILES = 1
|
||||
} OstreeRepoCheckoutOverwriteMode;
|
||||
|
||||
_OSTREE_PUBLIC gboolean
|
||||
_OSTREE_PUBLIC
|
||||
gboolean
|
||||
ostree_repo_checkout_tree (OstreeRepo *self,
|
||||
OstreeRepoCheckoutMode mode,
|
||||
OstreeRepoCheckoutOverwriteMode overwrite_mode,
|
||||
|
|
@ -866,14 +875,16 @@ typedef enum {
|
|||
OSTREE_REPO_COMMIT_TRAVERSE_FLAG_NONE = (1 << 0)
|
||||
} OstreeRepoCommitTraverseFlags;
|
||||
|
||||
_OSTREE_PUBLIC gboolean
|
||||
_OSTREE_PUBLIC
|
||||
gboolean
|
||||
ostree_repo_commit_traverse_iter_init_commit (OstreeRepoCommitTraverseIter *iter,
|
||||
OstreeRepo *repo,
|
||||
GVariant *commit,
|
||||
OstreeRepoCommitTraverseFlags flags,
|
||||
GError **error);
|
||||
|
||||
_OSTREE_PUBLIC gboolean
|
||||
_OSTREE_PUBLIC
|
||||
gboolean
|
||||
ostree_repo_commit_traverse_iter_init_dirtree (OstreeRepoCommitTraverseIter *iter,
|
||||
OstreeRepo *repo,
|
||||
GVariant *dirtree,
|
||||
|
|
@ -903,8 +914,8 @@ void ostree_repo_commit_traverse_iter_get_dir (OstreeRepoCommitTraverseIter *ite
|
|||
char **out_content_checksum,
|
||||
char **out_meta_checksum);
|
||||
|
||||
_OSTREE_PUBLIC void
|
||||
ostree_repo_commit_traverse_iter_clear (OstreeRepoCommitTraverseIter *iter);
|
||||
_OSTREE_PUBLIC
|
||||
void ostree_repo_commit_traverse_iter_clear (OstreeRepoCommitTraverseIter *iter);
|
||||
|
||||
_OSTREE_PUBLIC
|
||||
void ostree_repo_commit_traverse_iter_cleanup (void *p);
|
||||
|
|
@ -923,7 +934,8 @@ typedef enum {
|
|||
OSTREE_REPO_PRUNE_FLAGS_REFS_ONLY
|
||||
} OstreeRepoPruneFlags;
|
||||
|
||||
_OSTREE_PUBLIC gboolean
|
||||
_OSTREE_PUBLIC
|
||||
gboolean
|
||||
ostree_repo_prune_static_deltas (OstreeRepo *self, const char *commit,
|
||||
GCancellable *cancellable,
|
||||
GError **error);
|
||||
|
|
@ -961,7 +973,8 @@ gboolean ostree_repo_pull (OstreeRepo *self,
|
|||
GCancellable *cancellable,
|
||||
GError **error);
|
||||
|
||||
_OSTREE_PUBLIC gboolean
|
||||
_OSTREE_PUBLIC
|
||||
gboolean
|
||||
ostree_repo_pull_one_dir (OstreeRepo *self,
|
||||
const char *remote_name,
|
||||
const char *dir_to_pull,
|
||||
|
|
@ -1000,7 +1013,8 @@ gboolean ostree_repo_sign_delta (OstreeRepo *self,
|
|||
GCancellable *cancellable,
|
||||
GError **error);
|
||||
|
||||
_OSTREE_PUBLIC gboolean
|
||||
_OSTREE_PUBLIC
|
||||
gboolean
|
||||
ostree_repo_add_gpg_signature_summary (OstreeRepo *self,
|
||||
const gchar **key_id,
|
||||
const gchar *homedir,
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@
|
|||
#include "ostree-bootloader-syslinux.h"
|
||||
|
||||
/**
|
||||
* SECTION:libostree-sepolicy
|
||||
* SECTION:ostree-sepolicy
|
||||
* @title: SELinux policy management
|
||||
* @short_description: Read SELinux policy and manage filesystem labels
|
||||
*
|
||||
|
|
|
|||
|
|
@ -34,6 +34,10 @@ typedef enum {
|
|||
|
||||
} OstreeSysrootDebugFlags;
|
||||
|
||||
/**
|
||||
* OstreeSysroot:
|
||||
* Internal struct
|
||||
*/
|
||||
struct OstreeSysroot {
|
||||
GObject parent;
|
||||
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@
|
|||
#include "ostree-sysroot-upgrader.h"
|
||||
|
||||
/**
|
||||
* SECTION:libostree-sysroot-upgrader
|
||||
* SECTION:ostree-sysroot-upgrader
|
||||
* @title: Simple upgrade class
|
||||
* @short_description: Upgrade OSTree systems
|
||||
*
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ find_booted_deployment (OstreeSysroot *self,
|
|||
GError **error);
|
||||
|
||||
/**
|
||||
* SECTION:libostree-sysroot
|
||||
* SECTION:ostree-sysroot
|
||||
* @title: Root partition mount point
|
||||
* @short_description: Manage physical root filesystem
|
||||
*
|
||||
|
|
|
|||
Loading…
Reference in New Issue