From df88b47cdafcc2e04452456942ea572a7b72e2f2 Mon Sep 17 00:00:00 2001 From: Lars G Thorsen Date: Tue, 26 Jan 2010 10:13:35 +0000 Subject: OTP-8343 The documentation is now possible to build in an open source environment after a number of bugs are fixed and some features are added in the documentation build process. - The arity calculation is updated. - The module prefix used in the function names for bif's are removed in the generated links so the links will look like http://www.erlang.org/doc/man/erlang.html#append_element-2 instead of http://www.erlang.org/doc/man/erlang.html#erlang:append_element-2 - Enhanced the menu positioning in the html documentation when a new page is loaded. - A number of corrections in the generation of man pages (thanks to Sergei Golovan) - Moved some man pages to more apropriate sections, pages in section 4 moved to 5 and pages in 6 moved to 7. - The legal notice is taken from the xml book file so OTP's build process can be used for non OTP applications. --- system/doc/extensions/include.xml | 81 --------------------------------------- 1 file changed, 81 deletions(-) delete mode 100644 system/doc/extensions/include.xml (limited to 'system/doc/extensions/include.xml') diff --git a/system/doc/extensions/include.xml b/system/doc/extensions/include.xml deleted file mode 100644 index cd78644b95..0000000000 --- a/system/doc/extensions/include.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - -
- - 19992009 - Ericsson AB. All Rights Reserved. - - - The contents of this file are subject to the Erlang Public License, - Version 1.1, (the "License"); you may not use this file except in - compliance with the License. You should have received a copy of the - Erlang Public License along with this software. If not, it can be - retrieved online at http://www.erlang.org/. - - Software distributed under the License is distributed on an "AS IS" - basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See - the License for the specific language governing rights and limitations - under the License. - - - - Includes - Arndt Jonasson - 1 - 99-01-25 - PA1 - include.sgml -
-

There are two directives which can be used in Erlang source - files to cause the compiler to temporarily read input from another - source. They are typically used to provide macro definitions and - record definitions from header files. It is recommended to use the - file name extension ".hrl" for files which are meant to be - included (the 'h' can be read as "header").

-

When locating header files a list of directory names, the - compiler include path, is used. In short the list contains the current - working directory of the file server, the base name of the compiled - file, and the directories given by the include option, in that order. - See erlc(1) and compile(3) for the details of the - compiler include path.

- -
- The -include Directive -

The first action taken by the -include directive is to - check if the format of the first path component of the specified - filename is $VAR, for some string VAR. If that is the - case, the value of the environment variable VAR as returned by - os:getenv(VAR) is substituted for the first path component. If - os:getenv/1 returns false, the first path component is - left as is. If the filename is absolute (possibly after variable - substitution), the header file with that name is included. Otherwise, - the specified header file is searched for in the directories in the - compiler include path, starting with the first directory in the list. - The first file found while traversing the list is included. Examples:

- - -include("my_records.hrl"). - -include("incdir/more_records.hrl"). - -include("/home/users/proj/recs.hrl"). - -include("$PROJ_ROOT/app1/defs.hrl"). -
- -
- The -include_lib Directive -

The -include_lib directive first tries to find the - specified header file using the procedure employed for the - -include directive. If no header file can be found by searching - the compiler include path, the first path component of the specified - filename (possibly after variable substitution) is regarded as the - name of an application, and the directory of the current version of - the application is searched. Example:

- - -include_lib("mnesia/include/mnemosyne.hrl"). -

The compiler is instructed to look for the directory where the - current version of the mnesia application is installed, that is - code:lib_dir(mnesia), and then search the subdirectory - include for the file mnemosyne.hrl.

-
- - -- cgit v1.2.3