Document `xlog.meta(file-name)` method
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Related dev. issue(s): https://github.com/tarantool/tarantool/issues/8978
Product: Tarantool
Since: 3.0
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_lua/xlog/
SME: @ Serpentian
Details
Open an xlog file, and return its meta block.
Possible errors: Failed to open a file or it does not contain properly
formatted meta block.
Example:
tarantool> xlog = require('xlog')
---
...
tarantool> xlog.meta('00000000000000000000.snap')
---
- filetype: SNAP
prev_vclock: {}
instance_uuid: 87b2e60f-275c-4efa-9b0e-e9562e309692
vclock: {}
...
Requested by @Serpentian in https://github.com/tarantool/tarantool/commit/145af72b2ed85734ebad8e7bd76412369d079b58.
Definition of done
- The xlog module reference includes the
metafunction description
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the xlog module reference at the linked root document and locate the existing function descriptions. Document xlog.meta(file-name) using the stated behavior, possible file and meta-block errors, and the provided Lua example; done means the reference includes the meta function description.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100