Module webmachine_deps

Ensure that the relatively-installed dependencies are on the code loading path, and locate resources relative to this application's path.

Copyright © 2007-2008 Basho Technologies Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Authors: Justin Sheehy (justin@basho.com), Andy Gross (andy@basho.com).

Description

Ensure that the relatively-installed dependencies are on the code loading path, and locate resources relative to this application's path.

Function Index

deps_on_path/0List of project dependencies on the path.
ensure/0Ensure that the ebin and include paths for dependencies of this application are on the code path.
ensure/1Ensure that all ebin and include paths for dependencies of the application for Module are on the code path.
get_base_dir/0Return the application directory for this application.
get_base_dir/1Return the application directory for Module.
local_path/1Return an application-relative directory for this application.
local_path/2Return an application-relative directory from Module's application.
new_siblings/1Find new siblings paths relative to Module that aren't already on the code path.

Function Details

deps_on_path/0

deps_on_path() -> [ProjNameAndVers]

List of project dependencies on the path.

ensure/0

ensure() -> ok

Ensure that the ebin and include paths for dependencies of this application are on the code path. Equivalent to ensure(?Module).

ensure/1

ensure(Module) -> ok

Ensure that all ebin and include paths for dependencies of the application for Module are on the code path.

get_base_dir/0

get_base_dir() -> string()

Return the application directory for this application. Equivalent to get_base_dir(?MODULE).

get_base_dir/1

get_base_dir(Module) -> string()

Return the application directory for Module. It assumes Module is in a standard OTP layout application in the ebin or src directory.

local_path/1

local_path(Components) -> string()

Return an application-relative directory for this application. Equivalent to local_path(Components, ?MODULE).

local_path/2

local_path(Components::[string()], Module) -> string()

Return an application-relative directory from Module's application.

new_siblings/1

new_siblings(Module) -> [Dir]

Find new siblings paths relative to Module that aren't already on the code path.


Generated by EDoc, Feb 8 2011, 19:14:54.