PackageDescription

Describes the build settings and meta data of a single package.

This structure contains the effective build settings and dependencies for the selected build platform. This structure is most useful for displaying information about a package in an IDE. Use TargetDescription instead when writing a build-tool.

struct PackageDescription {

Version version_;

string description;

string homepage;

string[] authors;

string copyright;

string license;

string[] dependencies;

string configuration;

TargetType targetType;

string targetPath;

string targetName;

string targetFileName;

string workingDirectory;

string mainSourceFile;

string[] dflags;

string[] lflags;

string[] libs;

string[] injectSourceFiles;

string[] copyFiles;

string[] extraDependencyFiles;

string[] versions;

string[] debugVersions;

string[] importPaths;

string[] cImportPaths;

string[] stringImportPaths;

string[] preGenerateCommands;

string[] postGenerateCommands;

string[] preBuildCommands;

string[] postBuildCommands;

string[] preRunCommands;

string[] postRunCommands;

string[string] environments;

string[string] buildEnvironments;

string[string] runEnvironments;

string[string] preGenerateEnvironments;

string[string] postGenerateEnvironments;

string[string] preBuildEnvironments;

string[string] postBuildEnvironments;

string[string] preRunEnvironments;

string[string] postRunEnvironments;

BuildRequirement[] buildRequirements;

BuildOption[] options;

SourceFileDescription[] files;

}

Members

Variables

active bool active;: Does this package take part in the build?
authors string[] authors;: Undocumented in source.
buildEnvironments string[string] buildEnvironments;: Undocumented in source.
buildRequirements BuildRequirement[] buildRequirements;: Undocumented in source.
cImportPaths string[] cImportPaths;: Undocumented in source.
configuration string configuration;: The configuration that is built
copyFiles string[] copyFiles;: Files to copy to the target directory
copyright string copyright;: Undocumented in source.
debugVersions string[] debugVersions;: D debug version identifiers to set
dependencies string[] dependencies;: Undocumented in source.
description string description;: Undocumented in source.
dflags string[] dflags;: Flags passed to the D compiler
environments string[string] environments;: Undocumented in source.
extraDependencyFiles string[] extraDependencyFiles;: Files to check for rebuild dub project
files SourceFileDescription[] files;: A list of all source/import files possibly used by the package
homepage string homepage;: Undocumented in source.
importPaths string[] importPaths;: Undocumented in source.
injectSourceFiles string[] injectSourceFiles;: Files that should be injected when this package is dependent upon by a binary image.
lflags string[] lflags;: Flags passed to the linker
libs string[] libs;: Library names to link against (typically using "-l<name>")
license string license;: Undocumented in source.
mainSourceFile string mainSourceFile;: Undocumented in source.
name string name;: Qualified name of the package
options BuildOption[] options;: Undocumented in source.
path string path;: Path to the package
postBuildCommands string[] postBuildCommands;: Commands to execute after every build, with variables not substituted.
postBuildEnvironments string[string] postBuildEnvironments;: Undocumented in source.
postGenerateCommands string[] postGenerateCommands;: Commands executed after creating the description, with variables not substituted.
postGenerateEnvironments string[string] postGenerateEnvironments;: Undocumented in source.
postRunCommands string[] postRunCommands;: Commands to execute after every run, with variables not substituted.
postRunEnvironments string[string] postRunEnvironments;: Undocumented in source.
preBuildCommands string[] preBuildCommands;: Commands to execute prior to every build, with variables not substituted.
preBuildEnvironments string[string] preBuildEnvironments;: Undocumented in source.
preGenerateCommands string[] preGenerateCommands;: Commands executed before creating the description, with variables not substituted.
preGenerateEnvironments string[string] preGenerateEnvironments;: Undocumented in source.
preRunCommands string[] preRunCommands;: Commands to execute prior to every run, with variables not substituted.
preRunEnvironments string[string] preRunEnvironments;: Undocumented in source.
runEnvironments string[string] runEnvironments;: Undocumented in source.
stringImportPaths string[] stringImportPaths;: Undocumented in source.
targetFileName string targetFileName;: Undocumented in source.
targetName string targetName;: Undocumented in source.
targetPath string targetPath;: Undocumented in source.
targetType TargetType targetType;: Undocumented in source.
version_ Version version_;: Version of the package
versions string[] versions;: D version identifiers to set
workingDirectory string workingDirectory;: Undocumented in source.

Meta

Source

See Implementation

dub description enums

SourceFileRole

structs