mirrors/yosys
3
0
Fork 0
mirror of https://github.com/YosysHQ/yosys synced 2025-07-29 07:27:58 +00:00
Code Activity

Docs: Proto doc_string approach for cmd help

Browse source 
Add `doc_string` field to `Pass` constructor
Add `docs/util/newcmdref.py` to contain command domain
Update `docs/util/cmdref.py` with `cmd:usage` and `cmd:optiongroup` for describing commands.
Functional, but WIP.
This commit is contained in:
Krystine Sherwin 2025-07-21 10:33:31 +12:00
parent 5ce097ed3d
commit 714790c70b
No known key found for this signature in database
5 changed files with 635 additions and 43 deletions
Download patch file Download diff file Expand all files Collapse all files

6
kernel/register.h
View file

@ -40,8 +40,10 @@ struct PassUsageBlock {
struct Pass
{
std::string pass_name, short_help;
const vector<std::string> doc_string;
const vector<PassUsageBlock> pass_usages;
Pass(std::string name, std::string short_help = "** document me **",
const vector<std::string> doc_string = {},
const vector<PassUsageBlock> usages = {});
// Prefer overriding 'Pass::on_shutdown()' if possible
virtual ~Pass();
@ -62,6 +64,10 @@ struct Pass
return !pass_usages.empty();
}
bool HasDocstring() {
return !doc_string.empty();
}
struct pre_post_exec_state_t {
Pass *parent_pass;
int64_t begin_ns;