rt-thread/tools/options.py

#
# File      : options.py
# This file is part of RT-Thread RTOS
# COPYRIGHT (C) 2006 - 2015, RT-Thread Development Team
#
#  This program is free software; you can redistribute it and/or modify
#  it under the terms of the GNU General Public License as published by
#  the Free Software Foundation; either version 2 of the License, or
#  (at your option) any later version.
#
#  This program is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#  GNU General Public License for more details.
#
#  You should have received a copy of the GNU General Public License along
#  with this program; if not, write to the Free Software Foundation, Inc.,
#  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Change Logs:
# Date           Author       Notes
# 2022-04-20     WuGensheng  Add Options to SCons
#

from SCons.Script import AddOption, Dir
import platform
import os

def AddOptions():
    ''' ===== Add generic options to SCons ===== '''
    AddOption('--dist',
                dest = 'make-dist',
                action = 'store_true',
                default = False,
                help = 'make distribution')
    AddOption('--dist-ide', '--dist-rtstudio',
                dest = 'make-dist-ide',
                action = 'store_true',
                default = False,
                help = 'make distribution for RT-Thread Studio IDE')
    AddOption('--project-path',
                dest = 'project-path',
                type = 'string',
                default = None,
                help = 'set project output path')
    AddOption('--project-name',
                dest = 'project-name',
                type = 'string',
                default = os.path.basename(Dir('#').abspath),
                help = 'set project name')
    AddOption('--cscope',
                dest = 'cscope',
                action = 'store_true',
                default = False,
                help = 'Build Cscope cross reference database. Requires cscope installed.')
    AddOption('--clang-analyzer',
                dest = 'clang-analyzer',
                action = 'store_true',
                default = False,
                help = 'Perform static analyze with Clang-analyzer. ' + \
                    'Requires Clang installed.' + \
                    'It is recommended to use with scan-build like this:' + \
                    '`scan-build scons --clang-analyzer`' + \
                    'If things goes well, scan-build will instruct you to invoke scan-view.')
    AddOption('--buildlib',
                dest = 'buildlib',
                type = 'string',
                help = 'building library of a component')
    AddOption('--cleanlib',
                dest = 'cleanlib',
                action = 'store_true',
                default = False,
                help = 'clean up the library by --buildlib')
    AddOption('--target',
                dest = 'target',
                type = 'string',
                help = 'set target project: mdk/mdk4/mdk5/iar/vs/vsc/ua/cdk/ses/makefile/eclipse/codelite/cmake')
    AddOption('--cmsispack',
                dest = 'cmsispack',
                type = 'string',
                help = 'set pack: <cmsispack path>')
    AddOption('--strict',
                dest='strict-compiling',
                help='Compiling project with strict mode and ALL warning will be errors',
                action='store_true',
                default=False)
    AddOption('--verbose',
                dest = 'verbose',
                action = 'store_true',
                default = False,
                help = 'print verbose information during build')
    AddOption('--cc-prefix', '--exec-prefix',
                dest = 'exec-prefix',
                type = 'string',
                help = 'set RTT_CC_PREFIX temperately')
    AddOption('--cc-path', '--exec-path',
                dest = 'exec-path',
                type = 'string',
                help = 'set RTT_EXEC_PATH temperately')
    AddOption('--stackanalysis',
                dest = 'stackanalysis',
                action = 'store_true',
                default = False,
                help = 'thread stack static analysis')
    AddOption('--genconfig',
                dest = 'genconfig',
                action = 'store_true',
                default = False,
                help = 'Generate .config from rtconfig.h')
    AddOption('--useconfig',
                dest = 'useconfig',
                type = 'string',
                help = 'make rtconfig.h from config file.')
    AddOption('--global-macros',
                dest = 'global-macros',
                type = 'string',
                help = 'attach global macros in the project. '+\
                'e.g. scons --global-config=RT_USING_XX,RT_USING_YY'+\
                ' or scons --global-config="RT_USING_XX, RT_USING_YY"')
    AddOption('--reset-project-config',
                dest = 'reset-project-config',
                action = 'store_true',
                default = False,
                help = 'reset the project configurations to default')
    AddOption('--guiconfig', '--pyconfig',
                dest = 'guiconfig',
                action = 'store_true',
                default = False,
                help = 'Python GUI menuconfig for RT-Thread BSP')
    AddOption('--defconfig', '--pyconfig-silent',
                dest = 'defconfig',
                action = 'store_true',
                default = False,
                help = 'Don`t show Python GUI menuconfig window')
    AddOption('--menuconfig',
                dest = 'menuconfig',
                action = 'store_true',
                default = False,
                help = 'make menuconfig for RT-Thread BSP')
    AddOption('--cdb',
                dest = 'cdb',
                action = 'store_true',
                default = False,
                help = 'make compile_commands.json')