This repository has been archived by the owner on Oct 15, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 123
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: add arbitrary_metadata.md decision
- Loading branch information
Markus Raab
committed
Oct 14, 2020
1 parent
f8822fc
commit badcec5
Showing
2 changed files
with
36 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
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,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 |