Skip to content
New issue

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

#

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

Already on GitHub? # to your account

fixe #2278 #2312

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

fixe #2278 #2312

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2799596
fixe #2278
Bhavin-umatiya Dec 24, 2024
3838247
Merge branch 'chipsalliance:master' into master
Bhavin-umatiya Dec 25, 2024
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
39 changes: 39 additions & 0 deletions .vscode/launch.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
{
Bhavin-umatiya marked this conversation as resolved.
Show resolved Hide resolved
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "(gdb) Attach",
"type": "cppdbg",
"request": "attach",
"program": "enter program name, for example ${workspaceFolder}/a.exe",
"MIMode": "gdb",
"miDebuggerPath": "/path/to/gdb",
"setupCommands": [
{
"description": "Enable pretty-printing for gdb",
"text": "-enable-pretty-printing",
"ignoreFailures": true
},
{
"description": "Set Disassembly Flavor to Intel",
"text": "-gdb-set disassembly-flavor intel",
"ignoreFailures": true
}
]
},
{
"name": "(Windows) Launch",
"type": "cppvsdbg",
"request": "launch",
"program": "enter program name, for example ${workspaceFolder}/a.exe",
"args": [],
"stopAtEntry": false,
"cwd": "${fileDirname}",
"environment": [],
"console": "externalTerminal"
}
]
}
24 changes: 13 additions & 11 deletions verible/verilog/analysis/descriptions.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,16 @@ struct LintConfigParameterDescriptor {
std::string description;
};

struct LintRuleDescriptor {
Copy link
Collaborator

Choose a reason for hiding this comment

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

where did this one go ? Looks like the end of the file was accidentally deleted ?

LintRuleId name; // ID/name of the rule.
absl::string_view topic; // section in style-guide
std::string desc; // Detailed description.
std::vector<LintConfigParameterDescriptor> param;
};

} // namespace analysis
} // namespace verilog

#endif // VERIBLE_VERILOG_ANALYSIS_DESCRIPTIONS_H_
std::string format_long_description(const std::string& description) {
Copy link
Collaborator

Choose a reason for hiding this comment

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

This needs a unit test.

The naming convention for functions is typically CamelCase, so here FormatLongDescription()

Copy link
Collaborator

Choose a reason for hiding this comment

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

if you pass in an absl::string_view, your operations below will be cheaper.

Copy link
Author

Choose a reason for hiding this comment

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

@hzeller okay sir again i do my best

const size_t max_length = 80;
Bhavin-umatiya marked this conversation as resolved.
Show resolved Hide resolved
std::string formatted_desc;
size_t start = 0;

while (start < description.size()) {
size_t end = std::min(start + max_length, description.size());
formatted_desc += description.substr(start, end - start) + "\n ";
Bhavin-umatiya marked this conversation as resolved.
Show resolved Hide resolved
start = end;
}

return formatted_desc;
}
9 changes: 8 additions & 1 deletion verible/verilog/analysis/verilog-linter.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,7 +360,8 @@ absl::Status PrintRuleInfo(std::ostream *os,
}

void GetLintRuleDescriptionsHelpFlag(std::ostream *os,
absl::string_view flag_value) {
absl::string_view flag_value,
bool verbose) {
// Set up the map.
auto rule_map = analysis::GetAllRuleDescriptions();
for (const auto &rule_id : analysis::kDefaultRuleSet) {
Expand All @@ -380,9 +381,15 @@ void GetLintRuleDescriptionsHelpFlag(std::ostream *os,
*os << status.message();
return;
}

// If verbose flag is set, print example for the rule
if (verbose) {
*os << "\nExample: " << rule.second.GetExample() << "\n"; // Assuming rule.second has GetExample()
}
}
}


void GetLintRuleFile(std::ostream *os, const LinterConfiguration &config) {
// This rule bundle contains only a list of enabled rules. There
// are also no param's defined (an empty string), unless the user
Expand Down
Loading