wic: get rid of listing properties

Functionality of listing and using properties of wic images
does not exist in the wic code. However, there are plenty of
help and usage content about it, which is very confusing.

Removed everything regarding image properties from wic codebase.

(From OE-Core rev: af0a6d547a5a3efefdd4900f7079dfd10b85342d)

Signed-off-by: Ed Bartosh <ed.bartosh@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Ed Bartosh 2015-09-02 13:58:15 +03:00 committed by Richard Purdie
parent 1561970e88
commit 14b47e22f9
3 changed files with 30 additions and 131 deletions

View File

@ -194,46 +194,29 @@ def wic_create(wks_file, rootfs_dir, bootimg_dir, kernel_dir,
print "\nThe image(s) were created using OE kickstart file:\n %s" % wks_file print "\nThe image(s) were created using OE kickstart file:\n %s" % wks_file
def wic_list(args, scripts_path, properties_file): def wic_list(args, scripts_path):
""" """
Print the complete list of properties defined by the image, or the Print the list of images or source plugins.
possible values for a particular image property.
""" """
if len(args) < 1: if len(args) < 1:
return False return False
if len(args) == 1: if args == ["images"]:
if args[0] == "images": list_canned_images(scripts_path)
list_canned_images(scripts_path) return True
return True elif args == ["source-plugins"]:
elif args[0] == "source-plugins": list_source_plugins()
list_source_plugins() return True
return True elif len(args) == 2 and args[1] == "help":
elif args[0] == "properties": wks_file = args[0]
return True fullpath = find_canned_image(scripts_path, wks_file)
else: if not fullpath:
return False print "No image named %s found, exiting. "\
"(Use 'wic list images' to list available images, or "\
if len(args) == 2: "specify a fully-qualified OE kickstart (.wks) "\
if args[0] == "properties": "filename)\n" % wks_file
wks_file = args[1] sys.exit(1)
print "print properties contained in wks file: %s" % wks_file list_canned_image_help(scripts_path, fullpath)
return True return True
elif args[0] == "property":
print "print property values for property: %s" % args[1]
return True
elif args[1] == "help":
wks_file = args[0]
fullpath = find_canned_image(scripts_path, wks_file)
if not fullpath:
print "No image named %s found, exiting. "\
"(Use 'wic list images' to list available images, or "\
"specify a fully-qualified OE kickstart (.wks) "\
"filename)\n" % wks_file
sys.exit(1)
list_canned_image_help(scripts_path, fullpath)
return True
else:
return False
return False return False

View File

@ -108,7 +108,7 @@ wic_usage = """
Current 'wic' commands are: Current 'wic' commands are:
help Show help for command or one of the topics (see below) help Show help for command or one of the topics (see below)
create Create a new OpenEmbedded image create Create a new OpenEmbedded image
list List available values for options and image properties list List available canned images and source plugins
Help topics: Help topics:
overview wic overview - General overview of wic overview wic overview - General overview of wic
@ -221,27 +221,19 @@ DESCRIPTION
The -c option is used to specify compressor utility to compress The -c option is used to specify compressor utility to compress
an image. gzip, bzip2 and xz compressors are supported. an image. gzip, bzip2 and xz compressors are supported.
The set of properties available for a given image type can be
listed using the 'wic list' command.
""" """
wic_list_usage = """ wic_list_usage = """
List available OpenEmbedded image properties and values List available OpenEmbedded images and source plugins
usage: wic list images usage: wic list images
wic list <image> help wic list <image> help
wic list source-plugins wic list source-plugins
wic list properties
wic list properties <wks file>
wic list property <property>
[-o <JSON PROPERTY FILE> | --outfile <JSON PROPERTY_FILE>]
This command enumerates the set of available canned images as well as This command enumerates the set of available canned images as well as
help for those images. It also can be used to enumerate the complete help for those images. It also can be used to list of available source
set of possible values for a specified option or property needed by plugins.
the image creation process.
The first form enumerates all the available 'canned' images. The first form enumerates all the available 'canned' images.
@ -251,40 +243,23 @@ wic_list_usage = """
The third form enumerates all the available --sources (source The third form enumerates all the available --sources (source
plugins). plugins).
The fourth form enumerates all the possible values that exist and can
be specified in an OE kickstart (wks) file.
The fifth form enumerates all the possible options that exist for the
set of properties specified in a given OE kickstart (ks) file.
The final form enumerates all the possible values that exist and can
be specified for any given OE kickstart (wks) property.
See 'wic help list' for more details. See 'wic help list' for more details.
""" """
wic_list_help = """ wic_list_help = """
NAME NAME
wic list - List available OpenEmbedded image properties and values wic list - List available OpenEmbedded images and source plugins
SYNOPSIS SYNOPSIS
wic list images wic list images
wic list <image> help wic list <image> help
wic list source-plugins wic list source-plugins
wic list properties
wic list properties <wks file>
wic list property <property>
[-o <JSON PROPERTY FILE> | --outfile <JSON PROPERTY_FILE>]
DESCRIPTION DESCRIPTION
This command enumerates the complete set of possible values for a
specified option or property needed by the image creation process.
This command enumerates the set of available canned images as well This command enumerates the set of available canned images as well
as help for those images. It also can be used to enumerate the as help for those images. It also can be used to list available
complete set of possible values for a specified option or property source plugins.
needed by the image creation process.
The first form enumerates all the available 'canned' images. The first form enumerates all the available 'canned' images.
These are actually just the set of .wks files that have been moved These are actually just the set of .wks files that have been moved
@ -301,60 +276,6 @@ DESCRIPTION
sources listed by the 'list source-plugins' command. Users can sources listed by the 'list source-plugins' command. Users can
also add their own source plugins - see 'wic help plugins' for also add their own source plugins - see 'wic help plugins' for
details. details.
The third form enumerates all the possible values that exist and
can be specified in a OE kickstart (wks) file. The output of this
can be used by the third form to print the description and
possible values of a specific property.
The fourth form enumerates all the possible options that exist for
the set of properties specified in a given OE kickstart (wks)
file. If the -o option is specified, the list of properties, in
addition to being displayed, will be written to the specified file
as a JSON object. In this case, the object will consist of the
set of name:value pairs corresponding to the (possibly nested)
dictionary of properties defined by the input statements used by
the image. Some example output for the 'list <wks file>' command:
$ wic list test.ks
"part" : {
"mountpoint" : "/"
"fstype" : "ext3"
}
"part" : {
"mountpoint" : "/home"
"fstype" : "ext3"
"offset" : "10000"
}
"bootloader" : {
"type" : "efi"
}
.
.
.
Each entry in the output consists of the name of the input element
e.g. "part", followed by the properties defined for that
element enclosed in braces. This information should provide
sufficient information to create a complete user interface with.
The final form enumerates all the possible values that exist and
can be specified for any given OE kickstart (wks) property. If
the -o option is specified, the list of values for the given
property, in addition to being displayed, will be written to the
specified file as a JSON object. In this case, the object will
consist of the set of name:value pairs corresponding to the array
of property values associated with the property.
$ wic list property part
["mountpoint", "where the partition should be mounted"]
["fstype", "filesytem type of the partition"]
["ext3"]
["ext4"]
["btrfs"]
["swap"]
["offset", "offset of the partition within the image"]
""" """
wic_plugins_help = """ wic_plugins_help = """

View File

@ -249,18 +249,13 @@ def wic_create_subcommand(args, usage_str):
def wic_list_subcommand(args, usage_str): def wic_list_subcommand(args, usage_str):
""" """
Command-line handling for listing available image properties and Command-line handling for listing available images.
values. The real work is done by image.engine.wic_list() The real work is done by image.engine.wic_list()
""" """
parser = optparse.OptionParser(usage=usage_str) parser = optparse.OptionParser(usage=usage_str)
args = parser.parse_args(args)[1]
parser.add_option("-o", "--outfile", action="store", if not engine.wic_list(args, scripts_path):
dest="properties_file",
help="dump the possible values for image properties to a JSON file")
(options, args) = parser.parse_args(args)
if not engine.wic_list(args, scripts_path, options.properties_file):
logging.error("Bad list arguments, exiting\n") logging.error("Bad list arguments, exiting\n")
parser.print_help() parser.print_help()
sys.exit(1) sys.exit(1)