Skip to content

Refresh the TPCC README - #395

Merged
KKould merged 1 commit into
mainfrom
docs/tpcc-readme
Oct 26, 2026
Merged

KKould merged 1 commit into
mainfrom
docs/tpcc-readme

Conversation

@KKould

@KKould KKould commented Oct 26, 2026

Copy link
Copy Markdown
Member

What problem does this PR solve?

tpcc/README.md was out of date: it described four runner variants, kept a July raw-output section with the removed SQLite balanced/practical profiles, and pointed at an untracked local results directory. The root README listed --backend rocksdb|lmdb, which are not valid values.

Issue link:

What is changed and how it works?

  • Add tables for the make targets and the common TPCC options, matching Makefile and tpcc/src/main.rs.
  • Describe the three runner variants and --variants; drop the stale July raw outputs and the local results path.
  • Fix the --backend values in the root README.

Code changes

  • Has Rust code change
  • Has CI related scripts change

Check List

Tests

  • Unit test
  • Integration test
  • Manual test (add detailed scripts or steps below)
  • No code

Side effects

  • Performance regression: Consumes more CPU
  • Performance regression: Consumes more Memory
  • Breaking backward compatibility

Note for reviewer

The 720s results table is unchanged.

@KKould KKould self-assigned this Oct 26, 2026
@KKould KKould added the documentation Improvements or additions to documentation label Oct 26, 2026
@KKould
KKould merged commit 0ac2fe7 into main Oct 26, 2026
12 checks passed
@codecov

codecov Bot commented Oct 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.39%. Comparing base (9235a48) to head (6332935).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #395   +/-   ##
=======================================
  Coverage   93.39%   93.39%           
=======================================
  Files         272      272           
  Lines       39089    39089           
=======================================
  Hits        36508    36508           
  Misses       2581     2581           
Flag Coverage Δ
rust 93.39% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant