Clarify that only gzip is supported at this time

vectordotdev · Dec 19, 2024 · 7ebae1b · 7ebae1b
1 parent 522a290
commit 7ebae1b
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/src/sources/file.rs b/src/sources/file.rs
@@ -298,7 +298,8 @@ pub enum FingerprintConfig {
         bytes: Option<usize>,
 
         /// The number of bytes to skip ahead (or ignore) when reading the data used for generating the checksum.
-        /// If the file is compressed, the number of bytes refer to the header in the uncompressed content.
+        /// If the file is compressed, the number of bytes refer to the header in the uncompressed content. Only
+        /// gzip is supported at this time.
         ///
         /// This can be helpful if all files share a common header that should be skipped.
         #[serde(default = "default_ignored_header_bytes")]
@@ -307,7 +308,8 @@ pub enum FingerprintConfig {
 
         /// The number of lines to read for generating the checksum.
         ///
-        /// The number of lines are determined from the uncompressed content if the file is compressed.
+        /// The number of lines are determined from the uncompressed content if the file is compressed. Only
+        /// gzip is supported at this time.
         ///
         /// If the file has less than this amount of lines, it won’t be read at all.
         #[serde(default = "default_lines")]

diff --git a/website/cue/reference/components/sources/base/file.cue b/website/cue/reference/components/sources/base/file.cue
@@ -98,7 +98,8 @@ base: components: sources: file: configuration: {
 			ignored_header_bytes: {
 				description: """
 					The number of bytes to skip ahead (or ignore) when reading the data used for generating the checksum.
-					If the file is compressed, the number of bytes refer to the header in the uncompressed content.
+					If the file is compressed, the number of bytes refer to the header in the uncompressed content. Only
+					gzip is supported at this time.
 
 					This can be helpful if all files share a common header that should be skipped.
 					"""
@@ -113,7 +114,8 @@ base: components: sources: file: configuration: {
 				description: """
 					The number of lines to read for generating the checksum.
 
-					The number of lines are determined from the uncompressed content if the file is compressed.
+					The number of lines are determined from the uncompressed content if the file is compressed. Only
+					gzip is supported at this time
 
 					If the file has less than this amount of lines, it won’t be read at all.
 					"""