Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Support for compressed documents is scheduled for removal #608

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc: Support for compressed documents is scheduled for removal #608

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions modulemd/include/modulemd-2.0/modulemd-compression.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,19 @@
#pragma once

#include <glib.h>
#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.
*/


Expand All @@ -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
{
Expand All @@ -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);


Expand Down
3 changes: 3 additions & 0 deletions modulemd/include/modulemd-2.0/modulemd-module-index.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions modulemd/include/modulemd-2.0/modulemd.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 *
Expand Down
2 changes: 2 additions & 0 deletions modulemd/modulemd-validator.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down