file(File) -> ok | error
file(File, Options) -> ok | error
Types
Create a TAGS file for the file File.
Module
tags
Module Summary
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 large projects. This module can generate a TAGS file from Erlang source files. It recognises functions, records, and macro definitions.
Exports
files(FileList) -> ok | error
files(FileList, Options) -> ok | error
Types
Create a TAGS file for the files in the list FileList.
dir(Dir) -> ok | error
dir(Dir, Options) -> ok | error
Types
Create a TAGS file for all files in directory Dir.
dirs(DirList) -> ok | error
dirs(DirList, Options) -> ok | error
Types
Create a TAGS file for all files in any directory in DirList.
subdir(Dir) -> ok | error
subdir(Dir, Options) -> ok | error
Types
Descend recursively down the directory Dir and create a TAGS file based on all files found.
subdirs(DirList) -> ok | error
subdirs(DirList, Options) -> ok | error
Types
Descend recursively down all the directories in DirList and create a TAGS file based on all files found.
root() -> ok | error
root(Options) -> ok | error
Types
Create a TAGS file covering all files in the Erlang distribution.
options
The functions above have an optional argument, Options. It is a list which can contain the following elements:
-
{outfile, NameOfTAGSFile}Create aTAGSfile namedNameOfTAGSFile. -
{outdir, NameOfDirectory}Create a file namedTAGSin the directoryNameOfDirectory.
The default behaviour is to create a file named TAGS in the current directory.
Examples
-
tags:root([{outfile, "root.TAGS"}]).
This command will create a file named
root.TAGSin the current directory. The file will contain references to all Erlang source files in the Erlang distribution. -
tags:files(["foo.erl", "bar.erl", "baz.erl"], [{outdir, "../projectdir"}]).
Here we create file named
TAGSplaced it in the directory../projectdir. The file contains information about the functions, records, and macro definitions of the three files.
see also
- Richard M. Stallman. GNU Emacs Manual, chapter "Editing Programs", section "Tag Tables". Free Software Foundation, 1995.
- Anders Lindgren. The Erlang editing mode for Emacs. Ericsson, 1998.
© 2010–2022 Ericsson AB
Licensed under the Apache License, Version 2.0.
