diff options
| author | Amar Takhar <amar@rtems.org> | 2015-02-27 11:14:36 -0500 |
|---|---|---|
| committer | Amar Takhar <amar@rtems.org> | 2015-12-11 15:15:48 -0500 |
| commit | b973de2f48f086c98ef8f3c13715f8392d30cafa (patch) | |
| tree | 52605a954f1e95e3edbce4ed8c30fce2f99f7af0 | |
| parent | 375662ed7cda243ab5cb95d9646d1e9888b41442 (diff) | |
Re-add docs.py for automatic documentation generation.
This is a very quick hack to list all available options in RTEMS. It is not a
permanent solution.
| -rw-r--r-- | rtems_waf/docs.py | 129 |
1 files changed, 129 insertions, 0 deletions
diff --git a/rtems_waf/docs.py b/rtems_waf/docs.py new file mode 100644 index 0000000000..afa251035f --- /dev/null +++ b/rtems_waf/docs.py @@ -0,0 +1,129 @@ +from bsp import list_bsp +from rtems_waf.config.base import config_list + + +def header(): + return """ +<html> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> + + <title>List of RTEMS BSP Options</title> + <meta name="Description" content="List of options for RTEMS BSPs"> + <meta name="Keywords" content="RTEMS, BSP, sparc, intel, mips"/> + <meta name="Author" content="http://www.rtems.org/"/> + <style> +#download table { + border-spacing: 3px; + border-style: outset outset outset outset; + border-width: 1px 1px 1px 1px; + background-color: #dcfdc4; + border-color: black black black black; + border-collapse: collapse; +} + +#download table th { + background-color: 6c945a; +} + +h1, h2, h3, h4 { + font: bold 1.5em/1.5em sans serif; + color: #444; +} + + </style> + <meta name="Copyright" content="Copyright (C) 2015 RTEMS Project"/> +</head> + +<body> +<div id='download'> + """ + + +def footer(): + return """ +</div> +</body> +</html> + """ + + +TABLE_START = """ +<table style='round' border='1' cellpadding='5'> +<tr align='center'><th>Option</th><th nowrap='nowrap'>Default Value</th><th>Description</th></tr> +""" + +TABLE_END = """ +</table> +""" + +TABLE_ROW =""" +<tr valign='top'> + <td align='left'>%s</td> + <td align='left' valign='top'>%s</td> + <td align='left' align='top'>%s</td> +</tr> +""" + +BSP_HEADING = """ +<br/> +<hr size='1'> +<h2>%s</h2> +""" + +TABLE_HEADING = """ +<br/> +<b>%s</b> +""" + + +def rtems_cmd_docs(ctx): + fp = open(ctx.options.file_out, "w") + fp.write(header()) + + full = [] + for arch in list_bsp: + full.append(arch) + for bsp in list_bsp[arch]: + full.append("%s/%s" % (arch, bsp)) + + all = ["general", "host"] + sorted(full) + + def cfg_get(entry): + for config in config_list: + if config.name == entry: + return config +# raise Exception("Not found %s" % entry) # XXX: Because not all BSPs are added. + + for entry in all: + cfg = cfg_get(entry) + + if cfg == None: + continue # XXX: Hack because not all BSPs are added. +# print cfg.name, cfg + + c = cfg() + + fp.write(BSP_HEADING % c.name) + def print_opt(name, values): + if not list(values): + return + + fp.write(TABLE_HEADING % "%s Options" % name) + fp.write(TABLE_START) + for option in values: + opt = values[option] + if type(opt.value) is list: + value = " ".join(opt.value) + else: + value = opt.value + fp.write(TABLE_ROW % (opt.name, value or " ", opt.descr)) + + fp.write(TABLE_END) + + print_opt("Build", c.option_build) + print_opt("Header", c.option_header) + + + fp.write(footer()) + |