xref: /OK3568_Linux_fs/kernel/Documentation/sphinx/kernellog.py (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun# SPDX-License-Identifier: GPL-2.0
2*4882a593Smuzhiyun#
3*4882a593Smuzhiyun# Sphinx has deprecated its older logging interface, but the replacement
4*4882a593Smuzhiyun# only goes back to 1.6.  So here's a wrapper layer to keep around for
5*4882a593Smuzhiyun# as long as we support 1.4.
6*4882a593Smuzhiyun#
7*4882a593Smuzhiyunimport sphinx
8*4882a593Smuzhiyun
9*4882a593Smuzhiyunif sphinx.__version__[:3] >= '1.6':
10*4882a593Smuzhiyun    UseLogging = True
11*4882a593Smuzhiyun    from sphinx.util import logging
12*4882a593Smuzhiyun    logger = logging.getLogger('kerneldoc')
13*4882a593Smuzhiyunelse:
14*4882a593Smuzhiyun    UseLogging = False
15*4882a593Smuzhiyun
16*4882a593Smuzhiyundef warn(app, message):
17*4882a593Smuzhiyun    if UseLogging:
18*4882a593Smuzhiyun        logger.warning(message)
19*4882a593Smuzhiyun    else:
20*4882a593Smuzhiyun        app.warn(message)
21*4882a593Smuzhiyun
22*4882a593Smuzhiyundef verbose(app, message):
23*4882a593Smuzhiyun    if UseLogging:
24*4882a593Smuzhiyun        logger.verbose(message)
25*4882a593Smuzhiyun    else:
26*4882a593Smuzhiyun        app.verbose(message)
27*4882a593Smuzhiyun
28*4882a593Smuzhiyundef info(app, message):
29*4882a593Smuzhiyun    if UseLogging:
30*4882a593Smuzhiyun        logger.info(message)
31*4882a593Smuzhiyun    else:
32*4882a593Smuzhiyun        app.info(message)
33