# Generated Files — Do Not Hand-Edit

These artifacts are produced by tooling. Editing them by hand is almost always
wrong: your change is either overwritten on regeneration or causes CI to fail.
When the underlying source changes, regenerate them with the listed command.

## sqlness `.result` files — `tests/cases/**/*.result`

Generated by the sqlness runner from the sibling `.sql` files. **Never edit a
`.result` by hand.** To update expectations, change the `.sql` (or the engine
behavior) and re-run the test; the runner rewrites the `.result`.

```bash
cargo sqlness bare            # run all local cases
cargo sqlness bare -t <name>  # run one case
```

Review the regenerated output with `git diff tests`.

Note: `tests/cases/distributed/common` is a **symlink** to
`tests/cases/standalone/common`. They are the same files — editing one changes
both, and there is no need to diff standalone vs distributed.

## Configuration docs — `config/config.md`

Generated from the `config/*.example.toml` files and
`config/config-docs-template.md`.

```bash
make config-docs
```

Edit the example TOMLs and/or the template, then regenerate. Do not edit
`config/config.md` directly.

## Grafana dashboards

Generated artifacts; regenerate rather than editing by hand.

```bash
make dashboards
```

## `build.rs`-generated code

Some crates generate code at build time into the Cargo `OUT_DIR` (e.g.
`common-version` for build/git info, plus `common-catalog`, `common-function`'s
system tables, `log-store`, `servers`). There is no checked-in file to edit —
change the corresponding `build.rs` or its inputs instead.

## Protobuf / gRPC types

Generated from the external `greptime-proto` crate, not from sources in this
repo. To change the wire format, change `greptime-proto` upstream and bump the
dependency.

## License headers

Managed by the license-header tooling and the pre-commit hooks; let the tooling
add/fix them rather than editing headers by hand.
