Document lake output format and add/update ls docs #5187
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What's Changing
-f lake
output format is documentedzed ls
zed ls
Why
When creating the "output formats" table in #5170, I spotted
lake
as one of the output formats available via-f
in thezq -h
help text. I wasn't previously familiar with it, but I asked around to get consensus on whether it should be documented or hidden. @mccanne ultimately was slightly in favor of documenting it, so that's the main thing I set out to do here.Details
Once I got started, I realized I wanted to hyperlink to docs about the
zed ls
command and only then noticed we didn't have a section in thezed
command doc about it, so I went to add one based on the currentzed ls -h
command help text. However, that help text seemed somewhat out-of-sync with its current behavior, so I corrected that as well.Closes #5169