mirror of
https://github.com/ARM-software/workload-automation.git
synced 2024-10-06 10:51:13 +01:00
138 lines
5.2 KiB
Python
138 lines
5.2 KiB
Python
# Copyright 2014-2018 ARM Limited
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
#
|
|
|
|
# TODO: because of some weirdness involving get_params_rst and underline
|
|
# functions from wa.utils.doc, pylint gets stuck here for a very
|
|
# long time. To avoid that, skip this file.
|
|
# pylint: disable-all
|
|
|
|
import sys
|
|
from subprocess import call, Popen, PIPE
|
|
|
|
from wa import Command
|
|
from wa.framework import pluginloader
|
|
from wa.framework.configuration.core import MetaConfiguration, RunConfiguration
|
|
from wa.framework.exception import NotFoundError
|
|
from wa.framework.target.descriptor import list_target_descriptions
|
|
from wa.utils.types import caseless_string, identifier
|
|
from wa.utils.doc import (strip_inlined_text, get_rst_from_plugin,
|
|
get_params_rst, underline)
|
|
from wa.utils.misc import which
|
|
|
|
from devlib.utils.misc import escape_double_quotes
|
|
|
|
|
|
class ShowCommand(Command):
|
|
|
|
name = 'show'
|
|
description = 'Display documentation for the specified plugin (workload, instrument, etc.).'
|
|
|
|
def initialize(self, context):
|
|
self.parser.add_argument('plugin', metavar='PLUGIN',
|
|
help='The name of the plugin to display documentation for.')
|
|
|
|
def execute(self, state, args):
|
|
name = identifier(args.plugin)
|
|
rst_output = None
|
|
|
|
if name == caseless_string('settings'):
|
|
rst_output = get_rst_for_global_config()
|
|
rst_output += get_rst_for_envars()
|
|
plugin_name = name.lower()
|
|
kind = 'global:'
|
|
else:
|
|
try:
|
|
plugin = pluginloader.get_plugin_class(name)
|
|
except NotFoundError:
|
|
plugin = None
|
|
if plugin:
|
|
rst_output = get_rst_from_plugin(plugin)
|
|
plugin_name = plugin.name
|
|
kind = '{}:'.format(plugin.kind)
|
|
else:
|
|
target = get_target_description(name)
|
|
if target:
|
|
rst_output = get_rst_from_target(target)
|
|
plugin_name = target.name
|
|
kind = 'target:'
|
|
|
|
if not rst_output:
|
|
raise NotFoundError('Could not find plugin or alias "{}"'.format(name))
|
|
|
|
if which('pandoc'):
|
|
p = Popen(['pandoc', '-f', 'rst', '-t', 'man'], stdin=PIPE, stdout=PIPE, stderr=PIPE)
|
|
if sys.version_info[0] == 3:
|
|
output, _ = p.communicate(rst_output.encode(sys.stdin.encoding))
|
|
output = output.decode(sys.stdout.encoding)
|
|
else:
|
|
output, _ = p.communicate(rst_output)
|
|
|
|
# Make sure to double escape back slashes
|
|
output = output.replace('\\', '\\\\\\')
|
|
|
|
# Correctly format the title and page number of the man page
|
|
title, body = output.split('\n', 1)
|
|
title = '.TH {}{} 7'.format(kind, plugin_name)
|
|
output = '\n'.join([title, body])
|
|
|
|
call('echo "{}" | man -l -'.format(escape_double_quotes(output)), shell=True)
|
|
else:
|
|
print(rst_output) # pylint: disable=superfluous-parens
|
|
|
|
|
|
def get_target_description(name):
|
|
targets = list_target_descriptions()
|
|
for target in targets:
|
|
if name == identifier(target.name):
|
|
return target
|
|
|
|
|
|
def get_rst_from_target(target):
|
|
text = underline(target.name, '~')
|
|
if hasattr(target, 'description'):
|
|
desc = strip_inlined_text(target.description or '')
|
|
text += desc
|
|
text += underline('Device Parameters:', '-')
|
|
text += get_params_rst(target.conn_params)
|
|
text += get_params_rst(target.platform_params)
|
|
text += get_params_rst(target.target_params)
|
|
text += get_params_rst(target.assistant_params)
|
|
text += '.. Note: For available runtime parameters please see the documentation'
|
|
return text + '\n'
|
|
|
|
|
|
def get_rst_for_global_config():
|
|
text = underline('Global Configuration')
|
|
text += 'These parameters control the behaviour of WA/run as a whole, they ' \
|
|
'should be set inside a config file (either located in ' \
|
|
'$WA_USER_DIRECTORY/config.yaml or one which is specified with -c), ' \
|
|
'or into config/global section of the agenda.\n\n'
|
|
|
|
cfg_points = MetaConfiguration.config_points + RunConfiguration.config_points
|
|
text += get_params_rst(cfg_points)
|
|
return text
|
|
|
|
|
|
def get_rst_for_envars():
|
|
text = underline('Environment Variables')
|
|
text += '''WA_USER_DIRECTORY: str
|
|
This is the location WA will look for config.yaml, plugins, dependencies,
|
|
and it will also be used for local caches, etc. If this variable is not set,
|
|
the default location is ``~/.workload_automation`` (this is created when WA
|
|
is installed).
|
|
|
|
.. note.. This location must be writable by the user who runs WA.'''
|
|
return text
|