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.

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

Documented the proposed metadata format for the dirs in ksf. #48

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
38 changes: 38 additions & 0 deletions ksf_dir_meta_yaml.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
= 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

* The file path relative to the repo root is `_build/tags.yml`

* Just a dict with keys that are tag names and values that are metadata dicts.