Task: Document the Setup, Markets and Logging ORE parameters

Table of Contents

This page documents a task in the See and change everything a report runs story. It captures the goal, current status, acceptance, and any notes or results.

1. Goal

Every leaf of the Setup, Logging and Markets blocks of ore.xml is a row of ore_parameter with a label, help line, description, default, format and the release that introduced it.

2. Status

Field Value
State DONE
Parent story See and change everything a report runs
Now Nothing.
Waiting on Nothing.
Next Nothing.
Last touched 2026-10-23

3. Acceptance

  • Every Setup, Markets and Logging parameter in the ORE examples is a row with complete text. ORE reads no Restore block, so it has no row.
  • The seed comes from a generator that fails when a text is incomplete.
  • A pgTAP check ties each engine settings column to its row.

4. Plan

(Implementation strategy. Written when work starts; key decisions are distilled into the parent story's * Decisions at close, but the plan itself stays — it is the historical record of what we did.)

5. Measurements

Every number this task claims about a tree, with the command that produced it and the commit it was measured at. A number without both is not a measurement, because a clean-up record describes a tree and trunk moves under a branch: a consumer count, a gate's component count and a suite's size all change with no code changing, and the reader of a bare number cannot tell which tree it came from. Where the raw output matters, put it in an evidence/ file beside the task and name that file in the Command column.

What Value Command Commit
       

6. Notes

7. Test Scenarios

Manual QA scenarios (scaffolded via compass add test_scenario) that verify this task. Link new ones here as they're created; the scenario doc itself links back via its "Verifies task" field.

Scenario State Notes
     

8. PRs

PR Title
#3646 [reporting] Document the Setup, Logging and Markets ORE parameters

9. Review

Comment summary File Decision Notes
       

10. Result

The 70 Setup, Logging and Markets parameters that are not engine settings have a label, a help line, a description, a default, a format and the release that introduced them. The texts come from the ORE user guide and the ORE source at tag v1.8.17.0. Nine names are in example files and no release reads them, and the text says so. useAnalytics is no longer read since 1.8.9.1. A generator writes the seed, and the gate block-parameters-seed compares the seed with the texts. The pgTAP key test now derives the XPath of a Logging and a Markets parameter.

The text of buildFailedTrades said No by default. The ORE application sets that default, and the library defaults to Yes. The text and the prototype now say both.

Emacs 29.3 (Org mode 9.6.15)