| // Package Profiles, and its children, provide implementations of the |
| // veyron2.Profile interface. These implementations should import all of the |
| // packages that they require to implement Profile-specific functionality. |
| // |
| // The taxonomy used to organise Profiles may be arbitrary and the directory |
| // structure used here is just one convention for how to do so. This directory |
| // structure reflects the generality of a Profile at any given depth in the |
| // hierarchy, with higher levels of the directory structure being more |
| // generic and lower levels more specific. |
| // |
| // Profiles register themselves by calling veyron2/rt.RegisterProfile in their |
| // init function and are hence are chosen by importing them into an |
| // applications main package. It is possible, but discouraged, for more |
| // specific packages may use functionality exposed by more general packages |
| // and rely on go's module dependency algorithm to execute the init function |
| // from the more specific package after the less specific one and hence |
| // override the earlier Profile registration. This is discouraged because it |
| // is harder for the reader to track the dependencies to see what is included |
| // by each package. Commonly used functionality is placed in profiles/internal |
| // for use by all profiles. |
| // |
| // This top level directory contains a 'generic' Profile and utility routines |
| // used by other Profiles. It should be imported whenever possible and |
| // particularly by tests. |
| // |
| // The 'roaming' Profile adds operating system support for varied network |
| // configurations and in particular dhcp. It should be used by any application |
| // that may 'roam' or any may be behind a 1-1 NAT. The 'static' profile |
| // does not provide dhcp support, but is otherwise like the roaming profile. |
| // |
| package profiles |
