Skip to content
This repository has been archived by the owner on Oct 15, 2024. It is now read-only.

Commit

Permalink
doc: add arbitrary_metadata.md decision
Browse files Browse the repository at this point in the history
  • Loading branch information
Markus Raab committed Oct 14, 2020
1 parent f8822fc commit badcec5
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
1 change: 1 addition & 0 deletions doc/decisions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ section here.
- [Base Name](base_name.md)
- [Characters](characters.md)
- [Holes and Non-leaf values](holes.md)
- [Arbitrary Meta-Data](arbitrary_metadata.md)
- [Capabilities](capabilities.md)
- [Array](array.md)
- [Boolean](boolean.md)
Expand Down
35 changes: 35 additions & 0 deletions doc/decisions/arbitrary_metadata.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Arbitrary Metadata

## Problem

To make storage-plugins suitable for `spec` they need to be able to store
all the meta-data as specified in [METADATA.ini](/doc/METADATA.ini).
Most file formats do not have support for that.

## Constraints

## Assumptions

## Considered Alternatives

- store metadata in the comments like the `ini` plugin:
this exposes internal meta-data into the comments and
can drastically affect the readability of a storage file.
Comments should never be touched by a parser.
-

## Decision

Use different storage plugins, or plugins with different configurations,
for the `spec` namespace:

- `ni`
- TOML with `meta` configuration

## Rationale

## Implications

## Related Decisions

## Notes

0 comments on commit badcec5

Please sign in to comment.