-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Documented the proposed metadata format for the dirs in ksf.
- Loading branch information
Showing
1 changed file
with
32 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
= YAML-based metadata for Kaitai Struct Formats directories | ||
|
||
[[rationale]] | ||
== Rationale | ||
It is needed to store some metadata for each directory in `kaitai_struc_formats` repo. | ||
|
||
[[general]] | ||
== General | ||
* YAML is used as a serialization format. | ||
* `JSONSchema` will also be available. | ||
|
||
[[metadata]] | ||
== Metadata dict | ||
There are 2 keys defined in a metadata dict: | ||
* `short` for summary. | ||
* `long` for more extended guidelines what goes into this dir and wat doesn't | ||
|
||
All are mandatory. | ||
|
||
[[tree]] | ||
== Directory tree metadata format | ||
|
||
* The file path relative to the repo root is `_build/dirMeta.yml` | ||
|
||
* Each dir name is a key in a YAML dictionary. | ||
|
||
* Metadata dict is stored in mandatory `_` subkey. | ||
|
||
[[tags]] | ||
== Format | ||
|
||
Just a dict with keys that are tag names and values that are metadata dicts. |