TAGS(3erl) ERLANG MODULE DEFINITION TAGS(3erl)MODULE
tags - Generate Emacs TAGS file from Erlang source files.
DESCRIPTION
A TAGS file is used by Emacs to find function and variable definitions in any source file in a big project. This module can generate a
TAGS file from Erlang source files. It recognises functions, records, and defines.
EXPORTS
root([Options])
Create a TAGS file covering all files in the Erlang distribution.
file(File [, Options])
Create a TAGS file for the file `File'.
files(FileList [, Options])
Create a TAGS file for the files in the list `FileList'.
dir(Dir [, Options])
Create a TAGS file for all files in directory `Dir'.
dirs(DirList [, Options])
Create a TAGS file for all files in any directory in `DirList'.
subdir(Dir [, Options])
Descend recursively down the directory `Dir' and create a TAGS file based on all files found.
subdirs(DirList [, Options])
Descend recursively down all the directories in `DirList' and create a TAGS file based on all files found.
OPTIONS
The functions above have an optional argument, Options. It is a list which can contain the following elements:
{outfile, NameOfTAGSFile}
Create a TAGS file named `NameOfTAGSFile'.
{outdir, NameOfDirectory}
Create a file named TAGS in the directory `NameOfDirectory'.
The default behaviour is to create a file named "TAGS" in the current directory.
SEE ALSO
GNU Emacs Manual, chapter "Editing Programs", section "Tag Tables".
Erlang mode V2.0 for Emacs.
AUTHOR
Anders Lindgren
Ericsson Software Technology 1996-05-30 TAGS(3erl)
Check Out this Related Man Page
make(3erl) Erlang Module Definition make(3erl)NAME
make - A Make Utility for Erlang
DESCRIPTION
The module make provides a set of functions similar to the UNIX type Make functions.
EXPORTS
all() -> up_to_date | error
all(Options) -> up_to_date | error
Types Options = [Option]
Option = noexec | load | netload | <compiler option>
This function first looks in the current working directory for a file named Emakefile (see below) specifying the set of modules to
compile and the compile options to use. If no such file is found, the set of modules to compile defaults to all modules in the cur-
rent working directory.
Traversing the set of modules, it then recompiles every module for which at least one of the following conditions apply:
* there is no object file, or
* the source file has been modified since it was last compiled, or,
* an include file has been modified since the source file was last compiled.
As a side effect, the function prints the name of each module it tries to compile. If compilation fails for a module, the make pro-
cedure stops and error is returned.
Options is a list of make- and compiler options. The following make options exist:
* noexec
No execution mode. Just prints the name of each module that needs to be compiled.
* load
Load mode. Loads all recompiled modules.
* netload
Net load mode. Loads all recompiled modules an all known nodes.
All items in Options that are not make options are assumed to be compiler options and are passed as-is to compile:file/2 . Options
defaults to [] .
files(ModFiles) -> up_to_date | error
files(ModFiles, Options) -> up_to_date | error
Types ModFiles = [Module | File]
Module = atom()
File = string()
Options = [Option]
Option = noexec | load | netload | <compiler option>
files/1,2 does exactly the same thing as all/0,1 but for the specified ModFiles , which is a list of module or file names. The file
extension .erl may be omitted.
The Emakefile (if it exists) in the current directory is searched for compiler options for each module. If a given module does not
exist in Emakefile or if Emakefile does not exist, the module is still compiled.
EMAKEFILE
make:all/0,1 and make:files/1,2 looks in the current working directory for a file named Emakefile . If it exists, Emakefile should contain
elements like this:
Modules.
{Modules,Options}.
Modules is an atom or a list of atoms. It can be
* a module name, e.g. file1
* a module name in another directory, e.g. ../foo/file3
* a set of modules specified with a wildcards, e.g. 'file*'
* a wildcard indicating all modules in current directory, i.e. '*'
* a list of any of the above, e.g. ['file*','../foo/file3','File4']
Options is a list of compiler options.
Emakefile is read from top to bottom. If a module matches more than one entry, the first match is valid. For example, the following Emake-
file means that file1 shall be compiled with the options [debug_info,{i,"../foo"}] , while all other files in the current directory shall
be compiled with only the debug_info flag.
{'file1',[debug_info,{i,"../foo"}]}.
{'*',[debug_info]}.
Ericsson AB tools 2.6.6.3 make(3erl)