diff --git a/modulemd/include/modulemd-2.0/modulemd-compression.h b/modulemd/include/modulemd-2.0/modulemd-compression.h index 75834768..ddb38b0b 100644 --- a/modulemd/include/modulemd-2.0/modulemd-compression.h +++ b/modulemd/include/modulemd-2.0/modulemd-compression.h @@ -14,14 +14,19 @@ #pragma once #include +#include "modulemd-deprecated.h" G_BEGIN_DECLS /** * SECTION: modulemd-compression * @title: Modulemd Compression Helpers - * @stability: stable + * @stability: unstable * @short_description: Utility functions for working with compressed files. + * + * Direct support for handling compressed YAML documents is scheduled for removal. + * If you work with compressed documents, first uncompress them and then pass + * the raw YAML documents to this library. */ @@ -37,6 +42,7 @@ G_BEGIN_DECLS * @MODULEMD_COMPRESSION_TYPE_SENTINEL: Enum list terminator * * Since: 2.8 + * Deprecated: 2.14.1: Support for compressed documents is scheduled for removal. */ typedef enum { @@ -62,8 +68,9 @@ typedef enum * a known type. * * Since: 2.8 + * Deprecated: 2.14.1: Support for compressed documents is scheduled for removal. */ -ModulemdCompressionTypeEnum +MMD_DEPRECATED ModulemdCompressionTypeEnum modulemd_compression_type (const gchar *name); diff --git a/modulemd/include/modulemd-2.0/modulemd-module-index.h b/modulemd/include/modulemd-2.0/modulemd-module-index.h index e0757693..2fef8cc5 100644 --- a/modulemd/include/modulemd-2.0/modulemd-module-index.h +++ b/modulemd/include/modulemd-2.0/modulemd-module-index.h @@ -163,6 +163,9 @@ modulemd_module_index_new (void); * @failures appropriately if any of the YAML subdocuments were invalid or * sets @error if there was a fatal parse error. * + * Support for compressed YAML files is deprecated. In the future this + * function will only support uncompressed YAML files. + * * Since: 2.0 */ gboolean diff --git a/modulemd/include/modulemd-2.0/modulemd.h b/modulemd/include/modulemd-2.0/modulemd.h index a9208e5e..105a7cb7 100644 --- a/modulemd/include/modulemd-2.0/modulemd.h +++ b/modulemd/include/modulemd-2.0/modulemd.h @@ -317,6 +317,9 @@ modulemd_get_version (void); * initialized with the content from @yaml_file. Returns NULL and sets @error * if the file is not completely valid. * + * Support for compressed YAML files is deprecated. In the future this + * function will only support uncompressed YAML files. + * * Since: 2.10 */ ModulemdModuleIndex * diff --git a/modulemd/modulemd-validator.1 b/modulemd/modulemd-validator.1 index 8362b064..e995d72e 100644 --- a/modulemd/modulemd-validator.1 +++ b/modulemd/modulemd-validator.1 @@ -76,6 +76,8 @@ Print a usage text and then exit. .TP \fB\-V\fP, \fB\-\-version\fP Print a version number and then exit. +.SH DEPRECATION NOTICE +Support for compressed \fIFILES\fP is deprecated. .SH EXIT CODE If the supplied documents are valid (and satisfy the \fB--type\fP constrain), zero exit code will be returned. Otherwise a non-zero code will be emitted.