github.com/YosysHQ.yosys
1
0
Fork 0
mirror of synced 2026-04-18 10:26:18 +00:00
Code Issues Releases Wiki Activity

Docs: Add cell reference

Browse Source 
Subclass the command reference code in order to support smart references to the internal cells.
This commit is contained in:
Krystine Sherwin
2024-05-03 11:45:17 +12:00
parent c98d134662
commit f9b4e04fef
2 changed files with 59 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
kernel/register.cc
View File

@@ -899,17 +899,26 @@ struct HelpPass : public Pass {
fprintf(f, "%s\n", title_line.c_str());
fprintf(f, "%s\n", underline.c_str());
// help text
fprintf(f, "%s\n\n", cell.desc.c_str());
// help text, with cell def for links
fprintf(f, ".. cell:def:: %s\n", cell.name.c_str());
if (cell.title.length())
fprintf(f, " :title: %s\n\n", cell.title.c_str());
else
fprintf(f, " :title: %s\n\n", cell.name.c_str());
std::stringstream ss;
ss << cell.desc;
for (std::string line; std::getline(ss, line, '\n');) {
fprintf(f, " %s\n", line.c_str());
}
// source code
fprintf(f, "Simulation model (Verilog)\n");
fprintf(f, "\nSimulation model (Verilog)\n");
fprintf(f, "--------------------------\n\n");
fprintf(f, ".. code-block:: verilog\n");
fprintf(f, " :caption: %s\n\n", cell.source.c_str());
std::stringstream ss;
ss << cell.code;
for (std::string line; std::getline(ss, line, '\n');) {
std::stringstream ss2;
ss2 << cell.code;
for (std::string line; std::getline(ss2, line, '\n');) {
fprintf(f, " %s\n", line.c_str());
}