diff --git a/kernel/register.cc b/kernel/register.cc index 2a590a2dd..2e68c3d85 100644 --- a/kernel/register.cc +++ b/kernel/register.cc @@ -118,14 +118,14 @@ void Pass::post_execute(Pass::pre_post_exec_state_t state) void Pass::help() { - if (!help_v2()) { + if (!formatted_help()) { log("\n"); log("No help message for command `%s'.\n", pass_name.c_str()); log("\n"); } } -bool Pass::help_v2() +bool Pass::formatted_help() { return false; } @@ -825,7 +825,7 @@ struct HelpPass : public Pass { auto experimental_flag = pass->experimental_flag; auto cmd_help = PrettyHelp(PrettyHelp::Mode::LISTING); - auto has_pretty_help = pass->help_v2(); + auto has_pretty_help = pass->formatted_help(); if (!has_pretty_help) { enum PassUsageState { diff --git a/kernel/register.h b/kernel/register.h index 5cdb62ebe..537e1670d 100644 --- a/kernel/register.h +++ b/kernel/register.h @@ -59,8 +59,10 @@ struct Pass // Prefer overriding 'Pass::on_shutdown()' if possible virtual ~Pass(); + // Makes calls to log() to generate help message virtual void help(); - virtual bool help_v2(); + // Uses PrettyHelp::get_current() to produce a more portable formatted help message + virtual bool formatted_help(); virtual void clear_flags(); virtual void execute(std::vector args, RTLIL::Design *design) = 0; diff --git a/passes/cmds/chformal.cc b/passes/cmds/chformal.cc index c233390cd..8194b7365 100644 --- a/passes/cmds/chformal.cc +++ b/passes/cmds/chformal.cc @@ -73,7 +73,7 @@ static bool is_triggered_check_cell(RTLIL::Cell * cell) struct ChformalPass : public Pass { ChformalPass() : Pass("chformal", "change formal constraints of the design") {} - bool help_v2() override { + bool formatted_help() override { auto *help = PrettyHelp::get_current(); help->set_group("formal"); help->usage("chformal [types] [mode] [options] [selection]");