| // Copyright 2015 The Vanadium Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style |
| // license that can be found in the LICENSE file. |
| |
| // Package Profiles, and its children, provide implementations of the |
| // v23.Profile function. 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 v.io/v23/rt.RegisterProfile in their |
| // init function and are hence are chosen by importing them into an |
| // applications main package. It is an error to import more than one profile, |
| // and the registration mechanism will panic if this is attempted. |
| // Commonly used functionality and pre-canned profiles are in profiles/internal. |
| // |
| // 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 |
