diff --git a/source/dub/packagemanager.d b/source/dub/packagemanager.d index 2c072a4..a45d80b 100644 --- a/source/dub/packagemanager.d +++ b/source/dub/packagemanager.d @@ -958,7 +958,22 @@ private enum LocalPackagesFilename = "local-packages.json"; private enum LocalOverridesFilename = "local-overrides.json"; -/// A managed location (see `PlacementLocation`) +/** + * A managed location, with packages, configuration, and overrides + * + * There exists three standards locations, listed in `PlacementLocation`. + * The user one is the default, with the system and local one meeting + * different needs. + * + * Each location has a root, under which the following may be found: + * - A `packages/` directory, where packages are stored (see `packagePath`); + * - A `local-packages.json` file, with extra search paths + * and manually added packages (see `dub add-local`); + * - A `local-overrides.json` file, with manually added overrides (`dub add-override`); + * + * Additionally, each location host a config file, + * which is not managed by this module, but by dub itself. + */ private struct Location { /// The absolute path to the root of the location NativePath packagePath;