BuildStream
2.1.0
  • About
  • Installing from Source
  • Using
  • Reference
    • Project format
    • Plugin specific documentation
    • Plugin API reference
    • Additional writings
    • buildstream package
  • Porting guide
  • Contributing
  • Architecture
  • Glossary
BuildStream
  • Reference
  • View page source

Reference

This section details the core API reference along with other more elaborate details about BuildStream internals.

  • Project format
    • Introduction
    • Project configuration
    • Declaring elements
    • Builtin public data
    • The project.refs file
  • Plugin specific documentation
    • Elements
    • Sources
    • External plugins
  • Plugin API reference
    • Foundation types
    • FastEnum
    • CoreWarnings
    • OverlapAction
    • SourceRef
    • Node - Parsed YAML configuration
    • MappingNode
    • Node
    • ProvenanceInformation
    • ScalarNode
    • SequenceNode
    • Plugin - Base plugin class
    • Plugin
    • Source - Base source class
    • SourceFetcher - Object for fetching individual URLs
    • SourceError
    • SourceFetcher
    • Source
    • DownloadableFileSource - Abstract class for sources downloaded from a URI
    • DownloadableFileSource
    • Element - Base element class
    • ElementError
    • DependencyConfiguration
    • Element
    • BuildElement - Abstract class for build elements
    • BuildElement
    • ScriptElement - Abstract class for scripting elements
    • ScriptElement
    • setup()
    • Sandbox - The build sandbox
    • SandboxCommandError
    • Sandbox
    • Directory - Interfacing with files
    • DirectoryError
    • FileType
    • FileStat
    • Directory
    • Exceptions - API for Error Handling
    • ErrorDomain
    • LoadErrorReason
    • Utilities
    • UtilError
    • ProgramNotFoundError
    • DirectoryExistsError
    • FileListResult
    • list_relative_paths()
    • glob()
    • sha256sum()
    • safe_copy()
    • safe_link()
    • safe_remove()
    • copy_files()
    • link_files()
    • get_host_tool()
    • get_bst_version()
    • move_atomic()
    • save_file_atomic()
    • get_umask()
  • Additional writings
    • BuildStream and Docker
Previous Next

© Copyright 2017-2022, The Apache Software Foundation.

Built with Sphinx using a theme provided by Read the Docs.