Browse Source

Update documentation

tags/0.1.0
Jake Wakeling 2 months ago
parent
commit
2bd53c3057
4 changed files with 22 additions and 19 deletions
  1. 1
    1
      README.md
  2. 9
    0
      doc/OAR_ErrorCodes.txt
  3. 12
    7
      doc/OAR_Format.txt
  4. 0
    11
      doc/errorCodes.txt

+ 1
- 1
README.md View File

@@ -4,7 +4,7 @@ modern replacement for the TAR archive format without bloat.

The OAR archive format is designed for archival purposes, as such it does not
include support for file system permissions or system links. This makes the OAR
format unsuitable for system backup purposes.
format unsuitable for certain use cases.

## Format Specification
The OmegaARc archive file format specification can be found in the doc folder >

+ 9
- 0
doc/OAR_ErrorCodes.txt View File

@@ -0,0 +1,9 @@
OmegaARc Error Codes:
0x000A: Failed to allocate memory
0x0A10: Failed to open archive file for writing
0x0A11: Failed to open input file for reading
0x0A20: Failed to open archive file for reading
0x0A21: Failed to read OAR header
0x0A22: Failed to open output file for writing

doc/oarFormat.txt → doc/OAR_Format.txt View File

@@ -1,21 +1,23 @@
OmegaARc Format Description (0.0.1)
OmegaARc Format Description (0.1.0)
-----------------------------------
This file contains the description of the OmegaARc (OAR) archive format.

Format Overview
---------------
It is possible that the OmegaARc format will change in the future.
It is possible that the OmegaARc format will change in the future. It is most
likely that the only changes that will be made, however, are the additions of
extra header elements or compression.

Archive Structure
~~~~~~~~~~~~~~~~~
{
OmegaARc Signature
{
Header (Fixed 128 Bytes)
Header
FileData
}
}
This sequence will repeat for each file.
The header and file data will repeat for each file contained within an archive.

Archive Signature
~~~~~~~~~~~~~~~~
@@ -32,7 +34,10 @@ follows: 0x4F 0x41 0x52 0x00
Header Structure
~~~~~~~~~~~~~~~~
{
Filename (Fixed 96 Bytes)
File Size (Fixed 24 Bytes)
Checksum (Fixed 8 Bytes)
Filename
File Size
Checksum
}

Each element within the header is terminated with a null character, allowing
for all elements to have totally dynamic sizes.

+ 0
- 11
doc/errorCodes.txt View File

@@ -1,11 +0,0 @@
OmegaARc Library Error Codes
0x000A: Generic memory allocation error
0x0A10: Failed to open archive file for writing
0x0A11: Failed to open input file
0x0A20: Failed to open archive file for reading
0x0A21: Failed to read OAR header
0x0A22: Failed to open output file

OmegaARc Tool Error Codes
0x0002: File count out of range
0x000A: Generic memory allocation error

Loading…
Cancel
Save