diff --git a/release/packages/generate-ucl.lua b/release/packages/generate-ucl.lua index d9125182a1a4..19a9a95d5d38 100755 --- a/release/packages/generate-ucl.lua +++ b/release/packages/generate-ucl.lua @@ -1,240 +1,246 @@ #!/usr/libexec/flua +-- +-- Copyright (c) 2024-2025 Baptiste Daroussin +-- Copyright (c) 2025 Lexi Winter +-- +-- SPDX-License-Identifier: BSD-2-Clause +-- --[[ usage: generate-ucl.lua [ ]... Build a package's UCL configuration by loading the template UCL file , replacing any $VARIABLES in the UCL based on the provided variables, then writing the result to . ]]-- local ucl = require("ucl") -- Give subpackages a special comment and description suffix to indicate what -- they contain, so e.g. "foo-man" has " (manual pages)" appended to its -- comment. This avoids having to create a separate ucl files for every -- subpackage just to set this. -- -- Note that this is not a key table because the order of the pattern matches -- is important. pkg_suffixes = { { "%-dev%-lib32$", "(32-bit development files)", "This package contains development files for compiling ".. "32-bit applications on a 64-bit host." }, { "%-dbg%-lib32$", "(32-bit debugging symbols)", "This package contains 32-bit external debugging symbols ".. "for use with a source-level debugger.", }, { "%-man%-lib32$", "(32-bit manual pages)", "This package contains the online manual pages for 32-bit ".. "components on a 64-bit host.", }, { "%-lib32$", "(32-bit libraries)", "This package contains 32-bit libraries for running 32-bit ".. "applications on a 64-bit host.", }, { "%-lib$", "(libraries)", "This package contains runtime shared libraries.", }, { "%-dev$", "(development files)", "This package contains development files for ".. "compiling applications." }, { "%-man$", "(manual pages)", "This package contains the online manual pages." }, { "%-dbg$", "(debugging symbols)", "This package contains external debugging symbols for use ".. "with a source-level debugger.", }, } -- A list of packages which don't get the automatic suffix handling, -- e.g. -man packages with no corresponding base package. local no_suffix_pkgs = { ["kernel-man"] = true, } function add_suffixes(obj) local pkgname = obj["name"] for _,pattern in pairs(pkg_suffixes) do if pkgname:match(pattern[1]) ~= nil then obj["comment"] = obj["comment"] .. " " .. pattern[2] obj["desc"] = obj["desc"] .. "\n\n" .. pattern[3] return end end end -- Hardcode a list of packages which don't get the automatic pkggenname -- dependency because the base package doesn't exist. We should have a better -- way to handle this. local no_gen_deps = { ["libcompat-dev"] = true, ["libcompat-dev-lib32"] = true, ["libcompat-man"] = true, ["libcompiler_rt-dev"] = true, ["libcompiler_rt-dev-lib32"] = true, ["liby-dev"] = true, ["liby-dev-lib32"] = true, ["kernel-man"] = true, } -- Return true if the package 'pkgname' should have a dependency on the package -- pkggenname. function add_gen_dep(pkgname, pkggenname) if pkgname == pkggenname then return false end if pkgname == nil or pkggenname == nil then return false end if no_gen_deps[pkgname] ~= nil then return false end if pkgname:match("%-lib$") ~= nil then return false end if pkggenname == "kernel" then return false end return true end local pkgname = nil local pkggenname = nil local pkgprefix = nil local pkgversion = nil -- This parser is the output UCL we want to build. local parser = ucl.parser() -- Set any $VARIABLES from the command line in the parser. This causes ucl to -- automatically replace them when we load the source ucl. if #arg < 2 or #arg % 2 ~= 0 then io.stderr:write(arg[0] .. ": expected an even number of arguments, got " .. #arg) os.exit(1) end for i = 2, #arg - 2, 2 do local varname = arg[i - 1] local varvalue = arg[i] if varname == "PKGNAME" and #varvalue > 0 then pkgname = varvalue elseif varname == "PKGGENNAME" and #varvalue > 0 then pkggenname = varvalue elseif varname == "VERSION" and #varvalue > 0 then pkgversion = varvalue elseif varname == "PKG_NAME_PREFIX" and #varvalue > 0 then pkgprefix = varvalue end parser:register_variable(varname, varvalue) end -- Load the source ucl file. local res,err = parser:parse_file(arg[#arg - 1]) if not res then io.stderr:write(arg[0] .. ": fail to parse("..arg[#arg - 1].."): "..err) os.exit(1) end local obj = parser:get_object() -- If pkgname is different from pkggenname, add a dependency on pkggenname. -- This means that e.g. -dev packages depend on their respective base package. if add_gen_dep(pkgname, pkggenname) then if obj["deps"] == nil then obj["deps"] = {} end obj["deps"][pkggenname] = { ["version"] = pkgversion, ["origin"] = "base/"..pkgprefix.."-"..pkggenname, } end -- -- Handle the 'set' annotation, a comma-separated list of sets which this -- package should be placed in. If it's not specified, the package goes -- in the default set which is base. -- -- Ensure we have an annotations table to work with. obj["annotations"] = obj["annotations"] or {} -- If no set is provided, use the default set which is "base". sets = obj["annotations"]["set"] or "base" -- For subpackages, we may need to rewrite the set name. This is done a little -- differently from the normal pkg suffix processing, because we don't need sets -- to be as a granular as the base packages. -- -- Create a single lib32 set for all lib32 packages. Most users don't need -- lib32, so this avoids creating a large number of unnecessary lib32 sets. -- However, lib32 debug symbols still go into their own package since they're -- quite large. if pkgname:match("%-dbg%-lib32$") then sets = "lib32-dbg" elseif pkgname:match("%-lib32$") then sets = "lib32" -- If this is a -dev package, put it in a single set called "devel" which -- contains all development files. Also include lib*-man packages, which -- contain manpages for libraries. Having a separate -dev for every -- set is not necessary, because generally you either want development -- support or you don't. elseif pkgname:match("%-dev$") or pkgname:match("^lib.*%-man$") then sets = "devel" -- Don't separate tests and tests-dbg into 2 sets, if the user wants tests -- they should be able to debug failures. elseif sets == "tests" then sets = sets -- If this is a -dbg package, put it in the -dbg subpackage of each set, -- which means the user can install debug symbols only for the sets they -- have installed. elseif pkgname:match("%-dbg$") then local newsets = {} for set in sets:gmatch("[^,]+") do newsets[#newsets + 1] = set .. "-dbg" end sets = table.concat(newsets, ",") end -- Put our new sets back into the package. obj["annotations"]["set"] = sets -- If PKG_NAME_PREFIX is provided, rewrite the names of dependency packages. -- We can't do this in UCL since variable substitution doesn't work in array -- keys. if pkgprefix ~= nil and obj["deps"] ~= nil then newdeps = {} for dep, opts in pairs(obj["deps"]) do local newdep = pkgprefix .. "-" .. dep -- Make sure origin is set. opts["origin"] = opts["origin"] or "base/"..newdep newdeps[newdep] = opts end obj["deps"] = newdeps end -- Add comment and desc suffix. if no_suffix_pkgs[pkgname] == nil then add_suffixes(obj) end -- Write the output file. local f,err = io.open(arg[#arg], "w") if not f then io.stderr:write(arg[0] .. ": fail to open("..arg[#arg].."): ".. err) os.exit(1) end f:write(ucl.to_format(obj, 'ucl', true)) f:close()