Skip to content

The docs read against the graph diff - #173

Merged
torstei merged 2 commits into
mainfrom
docs/timbersh-release-pass
Sep 6, 2026
Merged

The docs read against the graph diff#173
torstei merged 2 commits into
mainfrom
docs/timbersh-release-pass

Conversation

@torstei

@torstei torstei commented Sep 6, 2026

Copy link
Copy Markdown
Owner

The release doc pass for timbersh-v0.9.0timbersh-v0.8.0..main, which is
timbergraph and the graph statement (#171). Reading the prose against the
code found one real defect and four gaps.

The defect

graph refuses samples that already carry a host label, because the shell
adds one itself. The message named metric, which is not bound — metrics is
— so raising the refusal raised NameError: name 'metric' is not defined from
inside the shell instead. Fixed, and the new test fails without the fix:

FAIL  a_graph_refuses_a_host_label_it_would_have_to_write_over
timberfs=#   ! name 'metric' is not defined

The gaps

  • A .B request sitting mid-line in timbersh(1) is not a request: the
    rendered page carried the literal .B "graph M from SRC extracting NAME".
    Swept every man page for the same shape — this was the only one, and all six
    render with no --warnings=all output.
  • --width/--height had no help text and no man entry. They are characters
    on the terminal and pixels in an image, which is worth writing down.
  • The grammar \? prints — which timbersh(1) explicitly calls the authority,
    "this page deliberately does not copy it" — listed png but neither svg
    nor using. Both, and the parse error beside it, now do.
  • tools/README.md documented --using under timbergraph and never
    mentioned that the graph statement has the same clause.

Packaging

Recommends: timberfs (>= 0.26.0)>= 0.32.0. graph ... extracting runs
timberfs tally --try locally and resolves an extractor name against the
directory the timberfs package ships; both landed in 0.32.0. Still a
Recommends and still only a hint — the case that matters is a remote target,
about which a dpkg constraint says nothing, so the runtime diagnosis stays the
real guard.

Merge order: this names 0.32.0, so v0.32.0 ships first and
timbersh-v0.9.0 is tagged only after its apt-repo rebuild has finished — the
two tags must never be pushed concurrently.

The release doc pass over timbersh-v0.8.0..main, which is timbergraph and
the `graph` statement, plus the one defect reading them found.

- The refusal for samples that already carry a `host` label named an
  undefined variable, so raising it raised a NameError from inside the
  shell instead. Tested, and the test fails without the fix.
- A `.B` request mid-line in timbersh(1) put the literal `.B "graph M
  from SRC extracting NAME"` in the rendered page.
- `--width`/`--height` had neither help text nor a man entry.
- The grammar `\?` prints — which timbersh(1) calls the authority — knew
  `png` but not `svg` or `using`.
- Recommends: timberfs (>= 0.32.0), for `extracting`: it runs `timberfs
  tally --try` here and resolves a name against the packaged extractor
  directory.
The same shortcoming as the Rust side: a reading directory is listed only
if it exists, so where none does the message named nowhere at all. It
names all three now.

The test replaces the directory list rather than skipping where a real
one exists — a test that runs on some machines and not others has told
you nothing.
@torstei
torstei merged commit 96d5dc2 into main Sep 6, 2026
7 checks passed
@torstei
torstei deleted the docs/timbersh-release-pass branch September 6, 2026 22:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant