EMBedded Disk GENerator (embdgen)

Welcome to the documentation of embdgen (/embd’gen/), the embedded disk generator.

This tool can be used to generate disk images (not only) for embedded use cases.

Config

• YAML Config Interface
  • Introduction
  • Simple Example
  • Content Generator Example
  • Reference
  • Label Types
    • GUID Partition Table (GPT) partition type (gpt)
    • Master Boot Record (DOS) partition type (mbr)
  • Region Types
    • A region without any data (empty)
    • Partition region (partition)
    • Raw region (raw)
  • Content Types
    • Cominit content (cominit)
    • Content from an archive (archive)
    • Empty content (empty)
    • Ext4 Content (ext4)
    • Fat32 Content (fat32)
    • A list of files (files)
    • Raw binary content (raw)
    • Resize an ext4 partition (resize_ext4)
    • U-Boot Environment region (uboot_env)
    • dm-verity hashed content (verity)
  • Content Generator Types
    • Split an archive into multiple parts (split_archive)
    • Utility: Split for a SplitArchiveContentGenerator (Split)

Reference

• Core
  • embdgen.core.utils
  • embdgen.core.label
  • embdgen.core.region
  • embdgen.core.content
  • embdgen.core.content_generator

• Core Plugins
  • embdgen.plugins.label
    • embdgen.plugins.label.GPT
    • embdgen.plugins.label.MBR
  • embdgen.plugins.region
    • embdgen.plugins.region.EmptyRegion
    • embdgen.plugins.region.PartitionRegion
    • embdgen.plugins.region.RawRegion
  • embdgen.plugins.content
    • embdgen.plugins.content.ArchiveContent
    • embdgen.plugins.content.Ext4Content
    • embdgen.plugins.content.Fat32Content
    • embdgen.plugins.content.FilesContent
    • embdgen.plugins.content.RawContent
    • embdgen.plugins.content.UBootEnvContent
    • embdgen.plugins.content.VerityContent
  • embdgen.plugins.content_generator
    • embdgen.plugins.content_generator.SplitArchiveContentGenerator

• Plugins
  • Cominit support (embdgen-cominit)
    • embdgen.plugins.content
      • embdgen.plugins.content.CominitContent
  • YAML Config Plugin (embdgen-config-yaml)

Meta

• Index
• Module Index
• Search Page