summaryrefslogtreecommitdiff
path: root/archived/projt-launcher/docs/handbook/bzip2-testfiles.md
diff options
context:
space:
mode:
authorMehmet Samet Duman <yongdohyun@projecttick.org>2026-04-02 18:51:45 +0300
committerMehmet Samet Duman <yongdohyun@projecttick.org>2026-04-02 18:51:45 +0300
commitd3261e64152397db2dca4d691a990c6bc2a6f4dd (patch)
treefac2f7be638651181a72453d714f0f96675c2b8b /archived/projt-launcher/docs/handbook/bzip2-testfiles.md
parent31b9a8949ed0a288143e23bf739f2eb64fdc63be (diff)
downloadProject-Tick-d3261e64152397db2dca4d691a990c6bc2a6f4dd.tar.gz
Project-Tick-d3261e64152397db2dca4d691a990c6bc2a6f4dd.zip
NOISSUE add archived projects
Signed-off-by: Mehmet Samet Duman <yongdohyun@projecttick.org>
Diffstat (limited to 'archived/projt-launcher/docs/handbook/bzip2-testfiles.md')
-rw-r--r--archived/projt-launcher/docs/handbook/bzip2-testfiles.md101
1 files changed, 101 insertions, 0 deletions
diff --git a/archived/projt-launcher/docs/handbook/bzip2-testfiles.md b/archived/projt-launcher/docs/handbook/bzip2-testfiles.md
new file mode 100644
index 0000000000..8631c937b4
--- /dev/null
+++ b/archived/projt-launcher/docs/handbook/bzip2-testfiles.md
@@ -0,0 +1,101 @@
+# Bzip2 Test Files
+
+> **Purpose**: Test file collection for bzip2 validation
+> **Latest Version**: 0.0.5-1
+
+---
+
+## Overview
+
+A collection of `.bz2` files used to test bzip2 functionality. Files come from various projects and cover edge cases.
+
+---
+
+## Directory Contents
+
+Each test directory contains:
+
+| File Type | Description |
+|-----------|-------------|
+| `README` | Source and license information |
+| `*.bz2` | Compressed files (should work) |
+| `*.md5` | Hash of original file |
+| `*.bz2.bad` | Corrupt files (should fail) |
+
+---
+
+## File Types
+
+### Good Files (`.bz2`)
+
+Compressed files that should decompress correctly. Each has an `.md5` file for verification.
+
+### Bad Files (`.bz2.bad`)
+
+Deliberately corrupt files to test error handling. These should **not** decompress successfully.
+
+---
+
+## Verification
+
+### Generate MD5
+
+```bash
+md5sum < file > file.md5
+```
+
+### Verify MD5
+
+```bash
+md5sum --check file.md5 < file
+```
+
+---
+
+## Adding Test Files
+
+### Good Files
+
+1. Create the `.bz2` file
+2. Generate `.md5`: `md5sum < original > original.md5`
+3. Add to appropriate directory
+4. Update README with source
+
+### Bad Files
+
+1. Create corrupt `.bz2` file
+2. Name with `.bz2.bad` extension
+3. Document the corruption type
+
+---
+
+## ⚠️ Security Notice
+
+> **Vulnerability Reporting**
+>
+> If you find a file that causes crashes, buffer overflows, or security issues:
+>
+> 1. **Do NOT share publicly**
+> 2. Report confidentially to maintainers
+> 3. Allow 60-90 days for fix before disclosure
+
+---
+
+## Credits
+
+Test files contributed by:
+- Apache Commons Compress
+- DotNetZip Library
+- Go Lang project
+- lbzip2 project
+- pyflate project
+
+Thanks to Mark Wielaard for assembling the collection.
+
+---
+
+## Related Documentation
+
+- [Bzip2 Overview](./bzip2.md) — Main documentation
+- [Bzip2 Tests](./bzip2-tests.md) — Test suite
+- [Compiling](./bzip2-compiling.md) — Build instructions