7b2c98854c
When we update the script we should rebuild the docs. Otherwise breaking changes made to the kdoc script don't become apparent until later. Reviewed-by: Pierrick Bouvier <pierrick.bouvier@linaro.org> Signed-off-by: Alex Bennée <alex.bennee@linaro.org> Message-Id: <20250116160306.1709518-32-alex.bennee@linaro.org>
70 lines
1.9 KiB
Python
70 lines
1.9 KiB
Python
# coding=utf-8
|
|
#
|
|
# QEMU depfile generation extension
|
|
#
|
|
# Copyright (c) 2020 Red Hat, Inc.
|
|
#
|
|
# This work is licensed under the terms of the GNU GPLv2 or later.
|
|
# See the COPYING file in the top-level directory.
|
|
|
|
"""depfile is a Sphinx extension that writes a dependency file for
|
|
an external build system"""
|
|
|
|
import os
|
|
import sphinx
|
|
import sys
|
|
from pathlib import Path
|
|
|
|
__version__ = '1.0'
|
|
|
|
def get_infiles(env):
|
|
for x in env.found_docs:
|
|
yield str(env.doc2path(x))
|
|
yield from ((os.path.join(env.srcdir, dep)
|
|
for dep in env.dependencies[x]))
|
|
for mod in sys.modules.values():
|
|
if hasattr(mod, '__file__'):
|
|
if mod.__file__:
|
|
yield mod.__file__
|
|
# this is perhaps going to include unused files:
|
|
for static_path in env.config.html_static_path + env.config.templates_path:
|
|
for path in Path(static_path).rglob('*'):
|
|
yield str(path)
|
|
|
|
# also include kdoc script
|
|
yield str(env.config.kerneldoc_bin[1])
|
|
|
|
|
|
def write_depfile(app, exception):
|
|
if exception:
|
|
return
|
|
|
|
env = app.env
|
|
if not env.config.depfile:
|
|
return
|
|
|
|
# Using a directory as the output file does not work great because
|
|
# its timestamp does not necessarily change when the contents change.
|
|
# So create a timestamp file.
|
|
if env.config.depfile_stamp:
|
|
with open(env.config.depfile_stamp, 'w') as f:
|
|
pass
|
|
|
|
with open(env.config.depfile, 'w') as f:
|
|
print((env.config.depfile_stamp or app.outdir) + ": \\", file=f)
|
|
print(*get_infiles(env), file=f)
|
|
for x in get_infiles(env):
|
|
print(x + ":", file=f)
|
|
|
|
|
|
def setup(app):
|
|
app.add_config_value('depfile', None, 'env')
|
|
app.add_config_value('depfile_stamp', None, 'env')
|
|
app.connect('build-finished', write_depfile)
|
|
|
|
return dict(
|
|
version = __version__,
|
|
parallel_read_safe = True,
|
|
parallel_write_safe = True
|
|
)
|