EPICS-sumo
4.5
  • Installing Sumo
    • Parts of sumo
    • Requirements
    • Install methods
      • Install with pip
        • Install locations
        • Install examples (shown for global install)
      • Global install with with system’s package manager (Linux)
    • The sumo configuration file
  • Introduction
    • The problem
      • New version of a direct dependency
      • New version of an indirect dependency
      • The overall picture
    • The solution
      • Builds
      • Database files and directories
      • Creating a build
      • Using a build
    • The implementation
  • Module Specifications
    • Sources of module specifications
      • The configuration file
      • The command line option “-m” or “–module”
      • Arguments to a command
    • Combining all module specifications
      • Override mode
      • Append mode
      • Processing the list
    • The format of a module specification
      • Module versions
      • Commands
        • clear
        • rm
        • load
        • build
  • Configuration Files
    • The philosphy
    • File format
    • Environment variable expansion
    • Using more than one configuration file
    • Default paths
    • The config option
    • Load commands in configuration files
    • The configuration file for sumo-scan
      • Keys in the sumo-scan configuration file
    • The configuration file for sumo
      • Keys in the sumo configuration file
      • Example of a sumo configuration file
      • Example of MODULES files
  • sumo-scan
    • What the script does
    • How it works
      • Phase I, RELEASE file scanning
      • Phase II, Grouping
      • Phase III, repository scan
      • Optional Phase IV, name to paths map
      • Optional Phase V, paths to names map
      • Program output
    • Commands
      • config list
      • config show [OPTIONNAMES]
      • config make FILENAME [OPTIONNAMES]
      • all
      • deps
      • groups
      • repos
      • name2paths
      • path2names
    • Options
  • sumo
    • What the script does
    • How it works
      • The dependency database
        • aliases
        • dependencies
        • extra
        • make-recipes
        • releasefile
        • source
          • path
          • tar
          • darcs
          • hg
          • git
          • svn
          • cvs
        • weight
      • The scan database
      • The build database
        • moduledata
        • linkdata
        • state
      • Configuration Files
    • Commands
      • maincommands
        • help COMMAND
        • config SUBCOMMAND
        • lock FILE
        • unlock FILE
        • db SUBCOMMAND
        • build SUBCOMMAND
      • subcommands for maincommand “config”
        • config list
        • config local DIRECTORY
        • config make FILENAME [OPTIONNAMES]
        • config new DIRECTORY TEMPLATE
        • config show [OPTIONNAMES]
        • config standalone DIRECTORY
      • subcommands for maincommand “db”
        • db alias-add MODULE DEPENDENCY ALIAS
        • db appconvert SCANFILE
        • db check
        • db clonemodule OLD-MODULE NEW-MODULE [VERSIONS]
        • db cloneversion MODULE OLD-VERSION NEW-VERSION [SOURCESPEC]
        • db commands MODULE LINES
        • db convert SCANFILE
        • db dependency-add MODULE DEPENDENCY
        • db dependency-delete MODULE DEPENDENCY
        • db edit
        • db extra MODULE [LINES]
        • db find REGEXP
        • db format
        • db list MODULES
        • db make-recipes MODULE [TARGET] [LINES]
        • db merge DB
        • db modconvert SCANFILE MODULES
        • db releasefilename MODULE RELEASEFILENAME
        • db replaceversion MODULE OLD-VERSION NEW-VERSION
        • db show MODULES
        • db weight WEIGHT MODULES
      • subcommands for maincommand “build”
        • build delete BUILDTAGS
        • build find MODULES
        • build getmodules BUILDTAG [MODULES]
        • build list
        • build new MODULES
        • build remake BUILDTAG
        • build show BUILDTAG
        • build showmodules [BUILDTAG]
        • build showdependencies [BUILDTAG]
        • build showdependents [BUILDTAG]
        • build state BUILDTAG [NEW-STATE]
        • build try MODULES
        • build use MODULES
    • Command completion
      • Prerequisites
      • Activate command completion on the fly
      • Activate command completion permanently
      • Completion cache files
    • The help pager
    • Options
      • --#opt-postload FILES
      • --#opt-preload FILES
      • --#postload FILES
      • --#preload FILES
      • -a ALIAS, --alias ALIAS
      • --all-builds
      • -A, --append OPTIONNAME
      • -b, --brief
      • --builddir BUILDDIR
      • -t BUILDTAG, --buildtag BUILDTAG
      • --buildtag-stem STEM
      • -c FILE, --config FILE
      • --dbdir DBDIR
      • --dbrepo REPOSITORY
      • --dbrepomode MODE
      • --detail NO
      • -D EXPRESSION, --dir-patch EXPRESSION
      • --disable-loading
      • -n, --dry-run
      • --dump-modules
      • --dumpdb
      • --editor EDITOR
      • --exceptions
      • -X REGEXP, --exclude-states REGEXP
      • -x EXTRALINE, --extra EXTRALLINE
      • --getmodules BUILDTAG
      • -h [OPTIONS], --help [OPTIONS]
      • --jobs
      • --lines
      • --list
      • --localbuilddir BUILDDIR
      • --logmsg LOGMESSAGE
      • --makeflags MAKEFLAGS
      • -m MODULE, --module MODULE
      • --no-checkout
      • -C, --no-default-config
      • -N, --no-err-build-exists
      • --no-make
      • --noignorecase
      • --nolock
      • -o OUTPUTFILE, --output OUTPUTFILE
      • -p, --progress
      • --readonly
      • --recursive
      • --scandb SCANDB
      • --sort-build-dependencies-first
      • --sort-build-dependencies-last
      • --summary
      • --test
      • --trace
      • --tracemore
      • -U EXPRESSION, --url-patch EXPRESSION
      • -v, --verbose
      • --version
      • -y, --yes
  • Using sumo in your application
    • Use supports in an application
    • Use a different version of a support
    • Details
      • MODULES
      • RELEASE for BL-001
      • RELEASE for BL-002
      • Makefile for BL-002
      • BUILDS.DB
  • Develop support modules with sumo
    • Create the sandbox
    • Create a “HEAD” version of a module
    • Build the module for the first time
    • Change and recompile
    • Test in an application
    • Commit the changes and define a tag
    • Add the new support to the dependency database
  • Example for sumo build try
  • sumo ioc
    • Prepare the directory
    • The script options
    • Running the script
    • How improve this example
  • sumo demo
    • Build an EPICS example
      • Prepare the directory
      • Set up the support and application directories
    • Set up sumo
    • Migrate the example for usage with sumo
      • Scan the support directory and create a dependency database
      • Create a copy of the sources of the original application
      • Scan the application to create a MODULES file
      • Rebuild the application, now with sumo
    • What to do now
  • Migrating supports and applications
    • Migrating the support directory
      • Set up the sumo directory
      • Scan the support directory with sumo-scan
      • Apply changes to the scan file (optional)
      • Create the dependency database
      • Create the sumo configuration file
    • Migrating a single support
    • Migrating an application
      • Create configuration file and module list
      • Build all support modules the application requires
      • Use the support modules in the application
  • How to Contribute
    • Patch files
    • Mercurial patch bundle
  • Glossary
  • SUMO license
EPICS-sumo
  • Index

Index

A | B | C | D | M | R | S | T | V

A

  • alias
  • aliases

B

  • build
  • build database
  • builds
  • BUILDS.DB
  • buildtag
  • buildtags

C

  • command
  • commandline option
  • commandline options
  • commands
  • configuration file

D

  • dependencies
  • dependency
  • dependency database
  • DEPS.DB

M

  • module
  • modulename
  • modulenames
  • modules
  • modulespec
  • modulespecifications
  • modulespecs
  • moduleversion
  • moduleversions

R

  • regular expression

S

  • scan database
  • SCANDB
  • scanfile
  • source
  • sources
  • state
  • states
  • support directory

T

  • tag

V

  • version
  • versionname
  • versionnames
  • versions
  • versionspec

© Copyright 2022, Helmholtz-Zentrum Berlin GmbH.

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