Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docs: Log the full list of macros, remove code-style macros to prevent Doxygen errors

Browse source
This commit is contained in:
Angus Gratton 2020-06-02 10:44:18 +10:00 committed by Angus Gratton
parent 2b270bccbf
commit db5d659762
1 changed files with 15 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
docs/idf_extensions/gen_defines.py
View file

@ -7,6 +7,7 @@
import glob import glob
import os import os
import pprint
import subprocess import subprocess
import re import re
@ -32,6 +33,11 @@ def generate_defines(app, project_description):
for soc_header in soc_headers: for soc_header in soc_headers:
defines.update(get_defines(soc_header, sdk_config_path)) defines.update(get_defines(soc_header, sdk_config_path))
# write a list of definitions to make debugging easier
with open(os.path.join(app.config.build_dir, "macro-definitions.txt"), "w") as f:
pprint.pprint(defines, f)
print("Saved macro list to %s" % f.name)
add_tags(app, defines) add_tags(app, defines)
app.emit('idf-defines-generated', defines) app.emit('idf-defines-generated', defines)
@ -48,8 +54,14 @@ def get_defines(header_path, sdk_config_path):
for line in processed_output.split("\n"): for line in processed_output.split("\n"):
line = line.strip() line = line.strip()
m = re.search("#define ([^ ]+) ?(.*)", line) m = re.search("#define ([^ ]+) ?(.*)", line)
if m and not m.group(1).startswith("_"): if m:
defines[m.group(1)] = m.group(2) name = m.group(1)
value = m.group(2)
if name.startswith("_"):
continue # toolchain macro
if (" " in value) or ("=" in value):
value = "" # macros that expand to multiple tokens (ie function macros) cause doxygen errors, so just mark as 'defined'
defines[name] = value
return defines return defines
@ -69,4 +81,4 @@ def setup(app):
app.connect('idf-info', generate_defines) app.connect('idf-info', generate_defines)
app.add_event('idf-defines-generated') app.add_event('idf-defines-generated')
return {'parallel_read_safe': True, 'parallel_write_safe': True, 'version': '0.1'} return {'parallel_read_safe': True, 'parallel_write_safe': True, 'version': '0.2'}