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

Use YAML as default storage #2330

Open
markus2330 opened this Issue Jan 23, 2019 · 0 comments

Comments

Projects
None yet
2 participants
@markus2330
Copy link
Contributor

markus2330 commented Jan 23, 2019

The current default format "dump" is not suitable to be edited by hand (e.g. by using kdb editor), which is a usability problem. To improve the situation, YAML can be used. The new storage plugin should fulfill following properties (ordered by priority):

  1. it should round-trip (if a KeySet is serialized and then parsed again, we end up with an identical internal representation)
  2. drop-in replacement as default storage plugin even if user still has some dump files lying around (something like dini is needed)
  3. user efforts in manually crafting the file are not lost (comments, ordering, ...)
  4. source code is maintainable (grammar-based,...) and modular (parsing, generation, ... separated)
  5. good error messages for typical mistakes
  6. good documentation of the format (and grammar for formal definition)
  7. line number information is kept #736

Tasks:

  • migrate internal documentation to YAML #1115
  • run fuzzer #185
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment