Skip to content

Design note: v1.0 compilation state and C++ options #1254

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
jgabry wants to merge 123 commits into
base: master
Choose a base branch
from
Draft

Design note: v1.0 compilation state and C++ options #1254

Changes from all commits
Commits
Show all changes
123 commits
Select commit Hold shift + click to select a range
d55e6f9
Add design note on compilation state and C++ options
jgabry Aug 27, 2026
fa7b991
Tighten the compilation-state contracts after review
jgabry Aug 27, 2026
44246d4
Specify introspection capture, include comparison, and unknown features
jgabry Aug 27, 2026
76a2ead
Separate requested-feature and unused-capability threading policies
jgabry Aug 27, 2026
c7392e8
Record the schema version and the artifact-side rebuild triggers
jgabry Aug 27, 2026
0790e34
Add an at-a-glance summary near the top
jgabry Aug 27, 2026
21a92f6
Add dev-notes to .Rbuildignore
jgabry Aug 27, 2026
ed78ed0
Remove the interim history section now the tracker is current
jgabry Aug 27, 2026
11e079b
Export compile_stan_file() and share one implementation with cmdstan_…
jgabry Aug 27, 2026
e7bd660
Record the release candidate and how the stages are executed
jgabry Aug 27, 2026
4800906
Settle the record's format and filename
jgabry Aug 27, 2026
f23b1ce
Note a possible test for the pre-record executable path
jgabry Aug 27, 2026
ff4cb77
Separate the formatter from the linter in the release schedule
jgabry Aug 27, 2026
c78ebcd
Merge remote-tracking branch 'origin/master' into compilation-state-d…
jgabry Aug 27, 2026
a679876
Record what brms needs from this design
jgabry Aug 27, 2026
1e247e0
State the downstream findings as signals rather than constraints
jgabry Aug 27, 2026
a3e08ee
Record what the instantiate survey found
jgabry Aug 28, 2026
ee3bef4
Say that the record is compared as an object, not as text
jgabry Aug 28, 2026
6bb28f8
Correct the command-line assignment semantics in section 3
jgabry Aug 28, 2026
ee01180
Keep the request and the reported features in separate accessors
jgabry Aug 28, 2026
4d5386c
Stop erroring when a threaded executable is run without threads
jgabry Aug 28, 2026
7461f46
Drop installation path from the builder comparison
jgabry Aug 28, 2026
33b2452
Classify the whole public surface for validation
jgabry Aug 28, 2026
641864e
Make this document the canonical source for these contracts
jgabry Aug 28, 2026
6af509a
Hide the build record and correct why JSON was chosen
jgabry Aug 28, 2026
1dac880
Identify dependencies by content rather than by path
jgabry Aug 28, 2026
e39fd0b
Rebuild on a forward-version record instead of refusing
jgabry Aug 28, 2026
dabd759
Keep format() but stop it refreshing the snapshot
jgabry Aug 28, 2026
a27f811
Say that the build record should not be committed
jgabry Aug 28, 2026
4640dd7
Add rethinking to the downstream survey
jgabry Aug 28, 2026
15e8573
Drop rethinking's threading internals from the survey
jgabry Aug 28, 2026
1d9ff71
Identify dependencies by path and content together
jgabry Aug 28, 2026
402106d
Restore the installation path to CmdStan identity
jgabry Aug 28, 2026
fe8838b
Classify the whole public surface, accurately this time
jgabry Aug 28, 2026
6040a5f
Specify format versions in both directions
jgabry Aug 28, 2026
4c0e82b
Tie the record's lifecycle to the executable's
jgabry Aug 28, 2026
4227e5b
Name both public build entry points
jgabry Aug 28, 2026
779108f
Point force_recompile at what the assessment cannot see
jgabry Aug 28, 2026
5640da8
Clear three inconsistencies in section 5 and section 7
jgabry Aug 28, 2026
d868797
Update the relocatable-records note for path identity
jgabry Aug 28, 2026
cb64a29
Make adoption silent, and give the rule behind it
jgabry Aug 28, 2026
ff34a99
Correct the rule behind silent adoption
jgabry Aug 28, 2026
8776280
Draw the messaging line at inferability, not at intent
jgabry Aug 28, 2026
77d52c8
Recommend restoring stan_file in instantiate
jgabry Aug 28, 2026
ce286a1
Make the at-a-glance section a map rather than a summary
jgabry Aug 29, 2026
70a2446
Scope the option contracts to build calls, not to cmdstan_model()
jgabry Aug 29, 2026
62e7393
Say "unsupported format version" consistently
jgabry Aug 29, 2026
067fab9
Split record loss into its three cases
jgabry Aug 29, 2026
7edeb13
Reject build configuration supplied without a Stan file
jgabry Aug 29, 2026
0df0437
Deliver the untracked-dependency note on write, and qualify immutability
jgabry Aug 29, 2026
585102c
Correct the scope note on CmdStan identity
jgabry Aug 29, 2026
9ece4c3
Identify dependencies by content rather than by path
jgabry Aug 29, 2026
db34e5e
Separate what the record stores from what the verdict compares
jgabry Aug 29, 2026
c660dd6
State one rule for C++ include resolution, and give #1258 the work list
jgabry Aug 29, 2026
77a0d37
Make the assessment engine its own stage, before it is wired in
jgabry Aug 29, 2026
7e5be9c
Make include_paths the only source-resolution channel, and store opti…
jgabry Aug 29, 2026
91647ea
Define the effective option fields by what they explain, not what the…
jgabry Aug 30, 2026
d24def7
Store what cmdstanr injected, and give the user header one channel
jgabry Aug 30, 2026
69e7447
Derive allow-undefined everywhere instead of accepting it as an option
jgabry Aug 30, 2026
1e21765
State why origin is recorded, rather than leaving it to the examples
jgabry Aug 30, 2026
97d1aab
Canonicalize stanc options by the arguments they emit
jgabry Aug 30, 2026
d1981ee
Reject use-opencl in stanc_options, as the sixth derived flag
jgabry Aug 30, 2026
55e8ccc
Narrow the use-opencl claim to what each model actually does
jgabry Aug 30, 2026
2c3c502
Match option rejection on occurrence rather than enumerated values
jgabry Aug 30, 2026
c6536db
Define the diagnostic-flag invariant by what cannot force a rebuild
jgabry Aug 30, 2026
71c5cd6
Canonicalize cpp_options names once, on entry to the build call
jgabry Aug 30, 2026
45b57e4
Keep pedantic a per-call request rather than a recorded state
jgabry Aug 30, 2026
81176b6
Treat a supplied STAN_VERSION as an ordinary Make variable
jgabry Aug 30, 2026
b78316d
Split precedence between this note and the issues by subject
jgabry Aug 30, 2026
4d325cf
Correct the STAN_VERSION mechanism and the tri-state encoding
jgabry Aug 30, 2026
72ba404
Establish the version invariant and settle the release order
jgabry Aug 31, 2026
0e895b8
Point section 10 at the filed cmdstan_version_compare() issue
jgabry Aug 31, 2026
4f359eb
Stop writing down numbers only the merging pull request knows
jgabry Aug 31, 2026
7801053
Remove two build conveniences and close two reuse gaps
jgabry Aug 31, 2026
8ebaf72
Give stan_build_info() a public schema separate from the record
jgabry Aug 31, 2026
7ad504f
Settle the public result's class and nested field names
jgabry Sep 1, 2026
f5754cb
Say what comparing the model name does not buy
jgabry Sep 1, 2026
3cbd92f
Settle the remaining schema contradictions and two open shapes
jgabry Sep 1, 2026
a9401bc
Define a record as valid or not once, for every consumer
jgabry Sep 1, 2026
bf2854a
Check the version before the schema, and name models from the file
jgabry Sep 1, 2026
8a1fcdc
Move format_version out of the compared set, and adoption into three …
jgabry Sep 2, 2026
1588796
Leave existing executables alone when cmdstanr changes what it injects
jgabry Sep 2, 2026
1fb745b
Say where unknown comes from, and what reporting every reason needs
jgabry Sep 2, 2026
298ecad
Decide older-format compatibility per version pair, not by kind of bump
jgabry Sep 2, 2026
d46e2f4
Stop treating a missing builder as a rebuild trigger
jgabry Sep 2, 2026
d8fae5a
Close three gaps the new rules opened
jgabry Sep 2, 2026
2a1e7bc
Say once that origin decides the list, not the verdict
jgabry Sep 2, 2026
bf0a434
State the bump obligation the readable-set test depends on
jgabry Sep 2, 2026
5a9ca68
Check the selected installation where it is used, not everywhere
jgabry Sep 2, 2026
e93e324
Check the installation before anything runs out of it
jgabry Sep 2, 2026
006c9b9
Make the TBB fallback turn on a usable record, not any record
jgabry Sep 2, 2026
4a50b05
Say once what an unusable record costs, since it is not one outcome
jgabry Sep 2, 2026
07a3c1f
Say which binary the TBB follows, since the call-site list was wrong …
jgabry Sep 2, 2026
cbaa5c0
Reject Make's own flags on build calls, not only assignments
jgabry Sep 2, 2026
46a7e06
Check the effective STANCFLAGS rather than make/local's text
jgabry Sep 2, 2026
e356aa8
Record the TBB directory the build resolved
jgabry Sep 2, 2026
0d7c64f
Give the assessment what it needs to notice a replaced executable
jgabry Sep 2, 2026
601936b
Keep the variables accessor off the installation check, and fix the a…
jgabry Sep 2, 2026
a4d533e
Name the build record after the executable, not the model name
jgabry Sep 2, 2026
0f044ad
Reject stan_file and exe_file supplied together
jgabry Sep 2, 2026
4748685
Correct who is said not to have built an adopted executable
jgabry Sep 2, 2026
74dfe88
Narrow the public build-info result to fields a caller can act on
jgabry Sep 2, 2026
4cc9e0f
Make NEWS the migration path for a change to what cmdstanr injects
jgabry Sep 2, 2026
5697054
Answer an unrunnable executable with an error, not a rebuild
jgabry Sep 2, 2026
aab46be
Say what makes the stanc option sort safe, and what it costs
jgabry Sep 2, 2026
c717b40
Move the release-candidate survey out of the design document
jgabry Sep 2, 2026
ac9cc95
Say that the binding is immutable, not the model
jgabry Sep 2, 2026
4871ca2
Settle what supplied means once, for all six arguments
jgabry Sep 2, 2026
9f57508
Name section 8 after what it contains, and fix two wraps
jgabry Sep 2, 2026
e424a63
Measure the expose_functions defect instead of reading it off the code
jgabry Sep 3, 2026
550dab6
Stop describing the tracker, and stop calling 1025 an answer
jgabry Sep 3, 2026
9a63ffa
Name the environment as a C++ include route the record cannot see
jgabry Sep 3, 2026
b442274
Say that removing the setter rewrites its test rather than deleting it
jgabry Sep 3, 2026
11c4102
Stop claiming only two dependencies go untracked, and fix a line range
jgabry Sep 3, 2026
9d374de
Track the Make configuration that reaches a build without cmdstanr
jgabry Sep 3, 2026
1627f72
Supply nothing when a recorded TBB directory is gone
jgabry Sep 4, 2026
2d29c3c
Compare stanc options in the order the caller gave them
jgabry Sep 4, 2026
02d3292
Resolve the force_recompile option in one place, never in a signature
jgabry Sep 4, 2026
1573dfa
Require cpp_options names to be Make identifiers
jgabry Sep 4, 2026
c8075bf
Report the triggers that can be evaluated, not the ones that apply
jgabry Sep 4, 2026
c4a40bc
Correct four claims the design makes about its own rules
jgabry Sep 4, 2026
f30ab83
Drop two claims that a whole-round sweep found stale
jgabry Sep 4, 2026
9ef3467
Correct a member count and an rpath claim
jgabry Sep 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Loading