Skip to content

Conversation

@sauclovian-g
Copy link
Contributor

Prompted by some stuff that came up in #2272.

Comment on lines 53 to 55
For tests that need binary artefacts (Java bytecode, LLVM bitcode) or
things that might as well be (linked-mir.json from mir-json) include
the corresponding source and a (gmake) Makefile that builds the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For tests that need binary artefacts (Java bytecode, LLVM bitcode) or
things that might as well be (linked-mir.json from mir-json) include
the corresponding source and a (gmake) Makefile that builds the
For tests that need binary artefacts (Java bytecode, LLVM bitcode) or
things that might as well be (linked-mir.json from mir-json), include
the corresponding source and a (gmake) Makefile that builds the

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

For tests that need binary artefacts (Java bytecode, LLVM bitcode) or
things that might as well be (linked-mir.json from mir-json) include
the corresponding source and a (gmake) Makefile that builds the
artefact, as well as the artefact itself.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A minor thing, but this README is a bit inconsistent about whether it uses the spelling "artifact" vs. "artefact". I have a mild preference towards the former since it uses the American English spelling, but I don't feel strongly. Either way, we should use one or the other consistently.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since working on data provenance years ago I use "artefact" for physical objects and "artifact" for constructs (as in, your data may have artifacts, your data is an artefact) because in that context it can be quite confusing to not be careful about that distinction. Here it doesn't really matter, but since most of the uses are ones I just added I updated the other to match.

things that might as well be (linked-mir.json from mir-json) include
the corresponding source and a (gmake) Makefile that builds the
artefact, as well as the artefact itself.
Indicate other provenance information in the makefile (e.g. LLVM version and
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Indicate other provenance information in the makefile (e.g. LLVM version and
Indicate other provenance information in the Makefile (e.g. LLVM version and

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

(or at least not anywhere accessible, e.g. I think the #! discussion
was in an issue somewhere)
@sauclovian-g sauclovian-g force-pushed the improve-intTest-readme branch from c1f9027 to 91a4d5b Compare March 31, 2025 21:19
@sauclovian-g sauclovian-g merged commit b0c2ecb into master Mar 31, 2025
13 checks passed
@sauclovian-g sauclovian-g deleted the improve-intTest-readme branch March 31, 2025 21:24
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.

3 participants