xref: /OK3568_Linux_fs/yocto/poky/meta/lib/bblayers/create.py (revision 4882a59341e53eb6f0b4789bf948001014eff981) 
1#
2# SPDX-License-Identifier: GPL-2.0-only
3#
4
5import logging
6import os
7import sys
8import shutil
9
10import bb.utils
11
12from bblayers.common import LayerPlugin
13
14logger = logging.getLogger('bitbake-layers')
15
16def plugin_init(plugins):
17    return CreatePlugin()
18
19def read_template(template, template_dir='templates'):
20    lines = str()
21    with open(os.path.join(os.path.dirname(__file__), template_dir, template)) as fd:
22        lines = ''.join(fd.readlines())
23    return lines
24
25class CreatePlugin(LayerPlugin):
26    def do_create_layer(self, args):
27        """Create a basic layer"""
28        layerdir = os.path.abspath(args.layerdir)
29        if os.path.exists(layerdir):
30            sys.stderr.write("Specified layer directory exists\n")
31            return 1
32
33        # create dirs
34        conf = os.path.join(layerdir, 'conf')
35        bb.utils.mkdirhier(conf)
36
37        layername = os.path.basename(os.path.normpath(args.layerdir))
38        layerid = args.layerid if args.layerid is not None else layername
39
40        # Create the README from templates/README
41        readme_template =  read_template('README').format(layername=layername)
42        readme = os.path.join(layerdir, 'README')
43        with open(readme, 'w') as fd:
44            fd.write(readme_template)
45
46        # Copy the MIT license from meta
47        copying = 'COPYING.MIT'
48        dn = os.path.dirname
49        license_src = os.path.join(dn(dn(dn(__file__))), copying)
50        license_dst = os.path.join(layerdir, copying)
51        shutil.copy(license_src, license_dst)
52
53        # Get the compat value for core layer.
54        compat = self.tinfoil.config_data.getVar('LAYERSERIES_COMPAT_core') or ""
55
56        # Create the layer.conf from templates/layer.conf
57        layerconf_template = read_template('layer.conf').format(
58                layerid=layerid, priority=args.priority, compat=compat)
59        layerconf = os.path.join(conf, 'layer.conf')
60        with open(layerconf, 'w') as fd:
61            fd.write(layerconf_template)
62
63        # Create the example from templates/example.bb
64        example_template = read_template('example.bb')
65        example = os.path.join(layerdir, 'recipes-' + args.examplerecipe, args.examplerecipe)
66        bb.utils.mkdirhier(example)
67        with open(os.path.join(example, args.examplerecipe + '_%s.bb') % args.version, 'w') as fd:
68            fd.write(example_template)
69
70        logger.plain('Add your new layer with \'bitbake-layers add-layer %s\'' % args.layerdir)
71
72    def register_commands(self, sp):
73        parser_create_layer = self.add_command(sp, 'create-layer', self.do_create_layer, parserecipes=False)
74        parser_create_layer.add_argument('layerdir', help='Layer directory to create')
75        parser_create_layer.add_argument('--layerid', '-i', help='Layer id to use if different from layername')
76        parser_create_layer.add_argument('--priority', '-p', default=6, help='Priority of recipes in layer')
77        parser_create_layer.add_argument('--example-recipe-name', '-e', dest='examplerecipe', default='example', help='Filename of the example recipe')
78        parser_create_layer.add_argument('--example-recipe-version', '-v', dest='version', default='0.1', help='Version number for the example recipe')
79
80