diff options
Diffstat (limited to 'HOWTO')
| -rw-r--r-- | HOWTO/INSTALL-CROSS.md | 45 | ||||
| -rw-r--r-- | HOWTO/INSTALL-WIN32.md | 35 | ||||
| -rw-r--r-- | HOWTO/INSTALL.md | 145 | ||||
| -rw-r--r-- | HOWTO/MARKDOWN.md | 15 |
4 files changed, 28 insertions, 212 deletions
diff --git a/HOWTO/INSTALL-CROSS.md b/HOWTO/INSTALL-CROSS.md index 224f238fd0..3796bf8a59 100644 --- a/HOWTO/INSTALL-CROSS.md +++ b/HOWTO/INSTALL-CROSS.md @@ -286,6 +286,7 @@ document for information on how to build the documentation. Testing the cross compiled system --------------------------------- + Some of the tests that come with erlang use native code to test. This means that when cross compiling erlang you also have to cross compile test suites in order to run tests on the target host. To do this you first have to release @@ -520,50 +521,6 @@ When a variable has been set, no warning will be issued. `posix_memalign` implementation that accepts larger than page size alignment. -* `erl_xcomp_ose_ldflags_pass1` - Linker flags for the OSE module (pass 1) - -* `erl_xcomp_ose_ldflags_pass2` - Linker flags for the OSE module (pass 2) - -* `erl_xcomp_ose_OSEROOT` - OSE installation root directory - -* `erl_xcomp_ose_STRIP` - Strip utility shipped with the OSE distribution - -* `erl_xcomp_ose_LM_POST_LINK` - OSE postlink tool - -* `erl_xcomp_ose_LM_SET_CONF` - Sets the configuration for an OSE load module - -* `erl_xcomp_ose_LM_ELF_SIZE` - Prints the section size information for an - OSE load module - -* `erl_xcomp_ose_LM_LCF` - OSE load module linker configuration file - -* `erl_xcomp_ose_BEAM_LM_CONF` - Beam OSE load module configuration file - -* `erl_xcomp_ose_EPMD_LM_CONF` - EPMD OSE load module configuration file - -* `erl_xcomp_ose_RUN_ERL_LM_CONF` - run_erl_lm OSE load module configuration file - -Copyright and License ---------------------- - -%CopyrightBegin% - -Copyright Ericsson AB 2009-2014. All Rights Reserved. - -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. - -%CopyrightEnd% - [$ERL_TOP/HOWTO/INSTALL.md]: INSTALL.md diff --git a/HOWTO/INSTALL-WIN32.md b/HOWTO/INSTALL-WIN32.md index 067c939d7a..98c608060d 100644 --- a/HOWTO/INSTALL-WIN32.md +++ b/HOWTO/INSTALL-WIN32.md @@ -60,7 +60,8 @@ followed by some FAQ, and then we’ll go into more details of the setup. Short Version --------------------------- +------------- + In the following sections, we've described as much as we could about the installation of the tools needed. Once the tools are installed, building is quite easy. We have also tried to make these instructions understandable @@ -391,7 +392,7 @@ tools: LIB="$WIN_VISUAL_STUDIO_ROOT\\VC\\lib\\;$WIN_SDK\\lib\\winv6.3\\um\\x86" - INCLUDE="$WIN_VISUAL_STUDIO_ROOT\\VC\\include\\;$WIN_SDK\\include\\shared\\; + INCLUDE="$WIN_VISUAL_STUDIO_ROOT\\VC\\include\\;$WIN_SDK\\include\\shared\\;\ $WIN_SDK\\include\\um;$WIN_SDK\\include\\winrt\\;$WIN_SDK\\include\\um\\gl" export CYGWIN PATH LIBPATH LIB INCLUDE @@ -611,7 +612,7 @@ tools: We would recommend using 1.0.2d. -* Building with wxWidgets. Download wxWidgets-3.0.2 or higher. +* Building with wxWidgets. Download wxWidgets-3.0.3 or higher. Install or unpack it to the pgm folder: Cygwin: @@ -621,19 +622,19 @@ tools: MSYS2: `DRIVE:/PATH/msys<32/64>/opt/local/pgm` - If the `wxUSE_POSTSCRIPT` isn't enabled in `<path\to\pgm>\wxMSW-3.0.2\include\wx\msw\setup.h`, + If the `wxUSE_POSTSCRIPT` isn't enabled in `<path\to\pgm>\wxMSW-3.0.3\include\wx\msw\setup.h`, enable it. build: From a command prompt with the VC tools available (See the instructions for OpenSSL build above for help on starting the proper command prompt in RELEASE mode): - C:\...\> cd <path\to\pgm>\wxMSW-3.0.2\build\msw + C:\...\> cd <path\to\pgm>\wxMSW-3.0.3\build\msw C:\...\> nmake BUILD=release SHARED=0 DIR_SUFFIX_CPU= -f makefile.vc Or - if building a 64bit version: - C:\...\> cd <path\to\pgm>\wxMSW-3.0.2\build\msw + C:\...\> cd <path\to\pgm>\wxMSW-3.0.3\build\msw C:\...\> nmake TARGET_CPU=amd64 BUILD=release SHARED=0 DIR_SUFFIX_CPU= -f makefile.vc * Get the Erlang source distribution (from <http://www.erlang.org/download.html>). @@ -883,28 +884,6 @@ to a common MSYS command prompt for building. Also all test suites cannot be built as MsysGIT/MSYS does not handle symbolic links. -Copyright and License ---------------------- - -%CopyrightBegin% - -Copyright Ericsson AB 2003-2015. All Rights Reserved. - -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. - -%CopyrightEnd% - - [1]: http://www.erlang.org/static/doc/mailinglist.html [2]: http://bugs.erlang.org [3]: https://github.com/erlang/otp diff --git a/HOWTO/INSTALL.md b/HOWTO/INSTALL.md index 43bcdb3a9e..36365799e3 100644 --- a/HOWTO/INSTALL.md +++ b/HOWTO/INSTALL.md @@ -68,7 +68,7 @@ also find the utilities needed for building the documentation. Required for building the application `crypto`. Further, `ssl` and `ssh` require a working crypto application and will also be skipped if OpenSSL is missing. The `public_key` - application will available without `crypto`, but the functionality + application is available without `crypto`, but the functionality will be very limited. The development package of OpenSSL including the header files are needed as well @@ -343,10 +343,12 @@ use the `--prefix` argument like this: `./configure --prefix=<Dir>`. Some of the available `configure` options are: * `--prefix=PATH` - Specify installation prefix. - -* `--{enable,disable}-threads` - Thread support. This is enabled by default if possible. -* `--{enable,disable}-smp-support` - SMP support (enabled by default if - a usable POSIX thread library or native Windows threads is found) +* `--enable-plain-emulator` - Build a threaded emulator that only + uses one scheduler. This emulator type is deprecated and will be + removed in a future release. +* `--disable-threads` - Build a non-threaded emulator. This emulator type + is deprecated and will be + removed in a future release. * `--{enable,disable}-kernel-poll` - Kernel poll support (enabled by default if possible) * `--{enable,disable}-hipe` - HiPE support (enabled by default on supported @@ -356,8 +358,6 @@ Some of the available `configure` options are: depending on operating system and hardware platform. Note that by enabling this you might get a seemingly working system that sometimes fail on floating point operations. -* `--enable-darwin-universal` - Build universal binaries on darwin i386. -* `--enable-darwin-64bit` - Build 64-bit binaries on darwin * `--enable-m64-build` - Build 64-bit binaries using the `-m64` flag to `(g)cc` * `--enable-m32-build` - Build 32-bit binaries using the `-m32` flag to @@ -566,6 +566,10 @@ as before, but the build process will take a much longer time. > automatically when `make` is invoked from `$ERL_TOP` with either the > `clean` target, or the default target. It is also automatically invoked > if `./otp_build remove_prebuilt_files` is invoked. +> +> If you need to verify the bootstrap beam files match the provided +> source files, use `./otp_build update_primary` to create a new commit that +> contains differences, if any exist. #### How to Build a Debug Enabled Erlang RunTime System #### @@ -776,133 +780,6 @@ Use `hipe:help_options/0` to print out the available options. 1> hipe:help_options(). -#### Running with GS #### - -The `gs` application requires the GUI toolkit Tcl/Tk to run. At least -version 8.4 is required. - -Known platform issues ---------------------- - -* Suse linux 9.1 is shipped with a patched GCC version 3.3.3, having the - rpm named `gcc-3.3.3-41`. That version has a serious optimization bug - that makes it unusable for building the Erlang emulator. Please - upgrade GCC to a newer version before building on Suse 9.1. Suse Linux - Enterprise edition 9 (SLES9) has `gcc-3.3.3-43` and is not affected. - -* `gcc-4.3.0` has a serious optimizer bug. It produces an Erlang emulator - that will crash immediately. The bug is supposed to be fixed in - `gcc-4.3.1`. - -* FreeBSD had a bug which caused `kqueue`/`poll`/`select` to fail to detect - that a `writev()` on a pipe has been made. This bug should have been fixed - in FreeBSD 6.3 and FreeBSD 7.0. NetBSD and DragonFlyBSD probably have or - have had the same bug. More information can be found at: - - * <http://www.freebsd.org/cgi/cvsweb.cgi/src/sys/kern/sys_pipe.c> - * <http://lists.freebsd.org/pipermail/freebsd-arch/2007-September/006790.html> - -* `getcwd()` on Solaris 9 can cause an emulator crash. If you have - async-threads enabled you can increase the stack size of the - async-threads as a temporary workaround. See the `+a` command-line - argument in the documentation of `erl(1)`. Without async-threads the - emulator is not as vulnerable to this bug, but if you hit it without - async-threads the only workaround available is to enable async-threads - and increase the stack size of the async-threads. Oracle has however - released patches that fixes the issue: - - > Problem Description: 6448300 large mnttab can cause stack overrun - > during Solaris 9 getcwd - - More information can be found at: - * <https://getupdates.oracle.com/readme/112874-40> - * <https://getupdates.oracle.com/readme/114432-29> - -* `sed` on Solaris seem to have some problems. For example on - Solaris 8, the BSD `sed` and XPG4 `sed` should be avoided. - Make sure `/bin/sed` or `/usr/bin/sed` is used on the Solaris - platform. - - -Daily Build and Test --------------------- -At Ericsson we have a "Daily Build and Test" that runs on: - -* Solaris 8, 9 - * Sparc32 - * Sparc64 -* Solaris 10 - * Sparc32 - * Sparc64 - * x86 -* SuSE Linux/GNU 9.4, 10.1 - * x86 -* SuSE Linux/GNU 10.0, 10.1, 11.0 - * x86 - * x86\_64 -* openSuSE 11.4 (Celadon) - * x86\_64 (valgrind) -* Fedora 7 - * PowerPC -* Fedora 16 - * x86\_64 -* Gentoo Linux/GNU 1.12.11.1 - * x86 -* Ubuntu Linux/GNU 7.04, 10.04, 10.10, 11.04, 12.04 - * x86\_64 -* MontaVista Linux/GNU 4.0.1 - * PowerPC -* FreeBSD 10.0 - * x86 -* OpenBSD 5.4 - * x86\_64 -* OS X 10.5.8 (Leopard), 10.7.5 (Lion), 10.9.1 (Mavericks) - * x86 -* Windows XP SP3, 2003, Vista, 7 - * x86 -* Windows 7 - * x86\_64 - -We also have the following "Daily Cross Builds": - -* SuSE Linux/GNU 10.1 x86 -> SuSE Linux/GNU 10.1 x86\_64 -* SuSE Linux/GNU 10.1 x86\_64 -> Linux/GNU TILEPro64 - -and the following "Daily Cross Build Tests": - -* SuSE Linux/GNU 10.1 x86\_64 - - -Authors -------- - -Authors are mostly listed in the application's `AUTHORS` files, -that is `$ERL_TOP/lib/*/AUTHORS` and `$ERL_TOP/erts/AUTHORS`, -not in the individual source files. - - -Copyright and License ---------------------- - -%CopyrightBegin% - -Copyright Ericsson AB 1998-2015. All Rights Reserved. - -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. - -%CopyrightEnd% - - diff --git a/HOWTO/MARKDOWN.md b/HOWTO/MARKDOWN.md index 2df0460dab..e6773a0a8e 100644 --- a/HOWTO/MARKDOWN.md +++ b/HOWTO/MARKDOWN.md @@ -70,6 +70,9 @@ in the future. * Lists aren't supported inside block quotes. +* Nested block quotes can be generated, but current DTD does not + support it. + * Link and image definition names *are* case sensitive. #### Additional Features #### @@ -126,7 +129,7 @@ places. Appropriate attributes to the `X` tag will also be generated. <icaption>...</icaption> </image>` sequence where the "title" will be placed between `<icaption>` and `</icaption>`. -* Block quotes generate `<blockquote>` tags. +* Block quotes generate `<quote>` tags. * If the first line of a top level block quote begins with a `> *NOTE*:` character sequence, a `<note>` tag will be generated instead of a @@ -152,7 +155,7 @@ places. Appropriate attributes to the `X` tag will also be generated. * Emphasis (single `*` or `_`) will generate `<em>` tags. -* Strong emphasis (double `*` or `_`) will generate `<b>` tags. +* Strong emphasis (double `*` or `_`) will generate `<strong>` tags. * The level 1 heading will cause the following to be generated: @@ -180,11 +183,11 @@ places. Appropriate attributes to the `X` tag will also be generated. contain information from a \%CopyrightBegin\%, \%CopyrightEnd\% block if such exist (see below). -* A level `X` heading where `1 < X <= 3` will cause the the following +* A level `X` heading where `1 < X <= 6` will cause the the following to be generated: - <marker id="..."/> <section> + <marker id="..."/> <title>...</title> ... </section> @@ -206,11 +209,11 @@ places. Appropriate attributes to the `X` tag will also be generated. other documents. That is, *be careful* when changing headings in an existing document. -* A level `X` heading where `3 < X` will cause the the following +* A level `X` heading where `6 < X` will cause the the following to be generated: <marker id="..."/> - <p><b>...</b></p> + <p><strong>...</strong></p> ... Current DTD:s used don't support deeper levels of sections, and we |