Categorygithub.com/linuxboot/osf-buildergetdeps
package
0.0.0-20230914200841-78298d54b394
Repository: https://github.com/linuxboot/osf-builder.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
21
Dependents
0
Files
1.1k SLOC

# README

getdeps

getdeps is a tool to fetch OSF dependencies and put them in the local directory so that it is ready to build. It helps with component versioning and multiple configurations, and uses JSON to describe a configuration.

OSF is made by multiple components, for which you may or may not have the full source code. With getdeps you can specify which components you want, along with their exact versions and locations (e.g. URL or git repository).

Quickstart

cd cmd/getdeps
go build
./getdeps --config ../../configs/qemu-x86_64.json
cat generated_versions.json

The above commands will fetch the required components to build OSF for QEmu with machine type q35 on x86_64. Each component is fetched in an homonym directory in the current directory where getdeps is run.

Components

Currently getdeps supports the following components:

  • coreboot: from the coreboot project, this component is currently used to initialize the platform, and to load a LinuxBoot payload, made by the kernel and initramfs components below. It is fetched via git.
  • kernel: this is based on the Linux kernel. You can specify a git repository or a tarball.
  • initramfs: based on u-root, an embedded environment with various bootloaders that run in userspace on the firmware kernel.

Each component is controlled by the configuration files described below.

Configuration files

TODO

URL overrides

TODO

# Functions

NewConfig creates a new config object by parsing the specified file, without loading the includes.
NewConfigWithIncludes parses a configuration blob and recursively any specified `include` directive.
NewURLOverrides creates a new URLOverrides object after parsing the specified configuration file.

# Constants

compression types.
compression types.
compression types.

# Structs

Config contains the sources which need to be fetched.
File represents a single file to be fetched.
Files represents a list of files that need to be fetched.
Git represents a Git repository.
Gopkg represents a Go package.
Node is a common action node.
Untar represents a tarball.

# Interfaces

Component defines an interface for the different components.

# Type aliases

CompressionType is the type that defines compression types.
HashMode represents the hash mode to use.
URLOverrides maps URLs to be overridden with custom ones.