Skip to content

Clean up documentation of new-er --report spec that include triggers, etc #469

@timsnyder

Description

@timsnyder

oss << "Please refer to the files 'ReportTriggers.txt' and 'SubreportTriggers.txt'" << std::endl;
oss << "found in this directory for more information on how to specify these options" << std::endl;
oss << "from YAML files directly." << std::endl;

I recently ran into this error message. The in this directory part is really confusing. Should it point to the Sparta documentation somewhere instead?

Nope, the files to which it refers are in the CoreExample directory.

Not intuitive at all when one encounters this in the wild as a result of passing old arguments to an actual Sparta-based simulator that has nothing to do with the CoreExample.

What's worse is that the new hierarchical report specification seems to only be documented in those TXT files in the core example, it isn't included in the doxygen. Also, highly confusing.

Metadata

Metadata

Assignees

Labels

component: spartaIssue is related to sparta frameworkdocumentationImprovements or additions to documentation

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions