From 8cea37b79acc80644de376d4bf6d712a105442d8 Mon Sep 17 00:00:00 2001 From: Anton Korobeynikov Date: Tue, 23 Jan 2007 12:35:46 +0000 Subject: [PATCH] Updating documentation: - Document visibility stuff - Fix gcc' supported attributes list - Document udis86 configure option git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@33462 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/GettingStarted.html | 5 +++++ docs/LangRef.html | 48 +++++++++++++++++++++++++++++++++++----- docs/ReleaseNotes.html | 17 +++++++------- 3 files changed, 56 insertions(+), 14 deletions(-) diff --git a/docs/GettingStarted.html b/docs/GettingStarted.html index bda0cf8f3ce..41ec511e14e 100644 --- a/docs/GettingStarted.html +++ b/docs/GettingStarted.html @@ -849,6 +849,11 @@ script to configure the build system:

documentation from the source code. This is disabled by default because generating the documentation can take a long time and producess 100s of megabytes of output. +
--with-udis86
+
LLVM can use external disassembler library for various purposes (now it's + used only for examining code produced by JIT). This option will enable usage + of udis86 x86 (both 32 and 64 + bits) disassembler library.

To configure LLVM, follow these steps:

diff --git a/docs/LangRef.html b/docs/LangRef.html index 4b71ba30a46..a1c9a2808da 100644 --- a/docs/LangRef.html +++ b/docs/LangRef.html @@ -578,6 +578,40 @@ convention.

+ +
+ Visibility Styles +
+ +
+ +

+All Global Variables and Functions have one of the following visibility styles: +

+ +
+
"default" - Default style:
+ +
On ELF, default visibility means that the declaration is visible to other + modules and, in shared libraries, means that the declared entity may be + overridden. On Darwin, default visibility means that the declaration is + visible to other modules. Default visibility corresponds to "external + linkage" in the language. +
+ +
"hidden" - Hidden style:
+ +
Two declarations of an object with hidden visibility refer to the same + object if they are in the same shared object. Usually, hidden visibility + indicates that the symbol will not be placed into the dynamic symbol table, + so no other module (executable or shared library) can reference it + directly. +
+ +
+ +
+
Global Variables @@ -638,14 +672,18 @@ a power of 2.

LLVM function definitions consist of the "define" keyord, an optional linkage type, an optional +visibility style, an optional calling convention, a return type, an optional parameter attribute for the return type, a function name, a (possibly empty) argument list (each with optional -parameter attributes), an optional section, an -optional alignment, an opening curly brace, a list of basic blocks, and a -closing curly brace. LLVM function declarations -consist of the "declare" keyword, an optional calling convention, a return type, an optional +parameter attributes), an optional section, an +optional alignment, an opening curly brace, a list of basic blocks, and a +closing curly brace. + +LLVM function declarations consist of the "declare" keyword, an +optional linkage type, an optional +visibility style, an optional +calling convention, a return type, an optional parameter attribute for the return type, a function name, a possibly empty list of arguments, and an optional alignment.

diff --git a/docs/ReleaseNotes.html b/docs/ReleaseNotes.html index 172eba872ca..1aa43a6909b 100644 --- a/docs/ReleaseNotes.html +++ b/docs/ReleaseNotes.html @@ -510,27 +510,26 @@ bits. Supported: constructor, destructor, deprecated, fastcall, format, format_arg, non_null, noreturn, - stdcall, unused, used, - warn_unused_result, weak
+ section, stdcall, unused, used, + visibility, warn_unused_result, weak
Ignored: noinline, always_inline, pure, const, nothrow, malloc, no_instrument_function, cdecl
- Unsupported: section, alias, - visibility, regparm, all other target specific + Unsupported: alias, regparm, all other target specific attributes
  • Variable Attributes: Specifying attributes of variables.
    Supported: cleanup, common, nocommon, - deprecated, dllimport, - dllexport, transparent_union, - unused, used, weak
    + deprecated, dllimport, dllexport, + section, transparent_union, unused, + used, weak
    Unsupported: aligned, mode, packed, - section, shared, tls_model, - vector_size, all target specific attributes. + shared, tls_model, + vector_size, all target specific attributes.
  • Type Attributes: Specifying attributes of types.
    -- 2.34.1