summaryrefslogtreecommitdiff
path: root/HOWTO/INSTALL.md
diff options
context:
space:
mode:
Diffstat (limited to 'HOWTO/INSTALL.md')
-rw-r--r--HOWTO/INSTALL.md68
1 files changed, 26 insertions, 42 deletions
diff --git a/HOWTO/INSTALL.md b/HOWTO/INSTALL.md
index e7fb4ad27a..e4e343aca3 100644
--- a/HOWTO/INSTALL.md
+++ b/HOWTO/INSTALL.md
@@ -47,7 +47,6 @@ Build the same way as when building the unpacked tar file.
* An `install` program that can take multiple file names.
-
Optional Utilities
------------------
@@ -85,8 +84,6 @@ also find the utilities needed for building the documentation.
Further instructions on wxWidgets, read [Building with wxErlang][].
-
-
### Building Documentation ###
* `xsltproc` -- A command line XSLT processor.
@@ -98,8 +95,6 @@ also find the utilities needed for building the documentation.
* `fop` -- Apache FOP print formatter (requires Java). Can be downloaded
from <http://xmlgraphics.apache.org/fop>.
-
-
How to Build and Install Erlang/OTP
-----------------------------------
@@ -137,14 +132,12 @@ set. If you get errors when building, try setting the LANG variable:
$ export LANG=C # Assuming bash/sh
-
### Building ###
Build the Erlang/OTP release.
$ make
-
### Testing ###
Before installation you should test whether your build is working properly
@@ -173,13 +166,11 @@ The following command will install the release on your system.
$ make install
-
### Running ###
You should now have a working release of Erlang/OTP!
Jump to [System Principles][] for instructions on running Erlang/OTP.
-
### How to Build the Documentation ###
Make sure you're in the top directory in the source tree.
@@ -396,11 +387,10 @@ Some of the available `configure` options are:
that do not support dynamic linking of libraries it is possible to statically
link nifs and drivers with the main Erlang VM binary. This is done by passing
a comma separated list to the archives that you want to statically link. e.g.
- `--enable-static-nifs=/home/$USER/my_nif.a`. The path has to be absolute and the
- name of the archive has to be the same as the module, i.e. `my_nif` in the
- example above. This is also true for drivers, but then it is the driver name
- that has to be the same as the filename. You also have to define
- `STATIC_ERLANG_{NIF,DRIVER}` when compiling the .o files for the nif/driver.
+ `--enable-static-nifs=/home/$USER/my_nif.a`. The paths have to be absolute.
+ For drivers, the driver name has to be the same as the filename. You also
+ have to define `STATIC_ERLANG_NIF_LIBNAME` (see `erl_nif` documentation) or
+ `STATIC_ERLANG_DRIVER` when compiling the .o files for the nif/driver.
If your nif/driver depends on some other dynamic library, you now have to link
that to the Erlang VM binary. This is easily achieved by passing `LIBS=-llibname`
to configure.
@@ -409,7 +399,7 @@ Some of the available `configure` options are:
should be compiled without one or more applications, i.e. `--without-wx`. There is
no automatic dependency handling between applications. If you disable
an application that another application depends on, you also have to disable the
- dependant application.
+ dependent application.
* `--enable-gettimeofday-as-os-system-time` - Force usage of `gettimeofday()` for
OS system time.
* `--enable-prefer-elapsed-monotonic-time-during-suspend` - Prefer an OS monotonic
@@ -751,33 +741,9 @@ passed to `configure`. One can force relative, or absolute links by passing
phase. Note that such a request might cause a failure if the request cannot
be satisfied.
+## Erlang/OTP test architectures ##
-### Running ###
-
- [$ERL_TOP/HOWTO/INSTALL-CROSS.md]: INSTALL-CROSS.md
- [$ERL_TOP/HOWTO/INSTALL-WIN32.md]: INSTALL-WIN32.md
- [DESTDIR]: http://www.gnu.org/prep/standards/html_node/DESTDIR.html
- [Building in Git]: #Advanced-configuration-and-build-of-ErlangOTP_Building_Within-Git
- [Advanced Configure]: #Advanced-configuration-and-build-of-ErlangOTP_Configuring
- [Pre-built Source Release]: #Advanced-configuration-and-build-of-ErlangOTP_Building_Prebuilt-Source-Release
- [make and $ERL_TOP]: #Advanced-configuration-and-build-of-ErlangOTP_make-and-ERLTOP
- [html documentation]: http://www.erlang.org/download/otp_doc_html_%OTP-VSN%.tar.gz
- [man pages]: http://www.erlang.org/download/otp_doc_man_%OTP-VSN%.tar.gz
- [the released source tar ball]: http://www.erlang.org/download/otp_src_%OTP-VSN%.tar.gz
- [System Principles]: system/system_principles:system_principles
- [native build]: #How-to-Build-and-Install-ErlangOTP
- [cross build]: INSTALL-CROSS.md
- [Required Utilities]: #Required-Utilities
- [Optional Utilities]: #Optional-Utilities
- [Building on a Mac]: #Advanced-configuration-and-build-of-ErlangOTP_Building_OS-X-Darwin
- [Building with wxErlang]: #Advanced-configuration-and-build-of-ErlangOTP_Building_Building-with-wxErlang
- [libatomic_ops]: https://github.com/ivmai/libatomic_ops/
-
-
-### Erlang/OTP test architectures ###
-
-
-Erlang/OTP are currently tested on the following hardware and Opererating systems.
+Erlang/OTP are currently tested on the following hardware and operating systems.
This is not an exhaustive list, but we try to keep it as up to date as possible.
Architecture
@@ -786,7 +752,7 @@ Architecture
* Aarch32, Aarch64
* powerpc, powerpc64le
-Operating System
+Operating system
* Fedora 31
* FreeBSD
@@ -799,3 +765,21 @@ Operating System
* Ubuntu 10.04 - 20.04
* Windows 10, Windows Server 2019
+ [$ERL_TOP/HOWTO/INSTALL-CROSS.md]: INSTALL-CROSS.md
+ [$ERL_TOP/HOWTO/INSTALL-WIN32.md]: INSTALL-WIN32.md
+ [DESTDIR]: http://www.gnu.org/prep/standards/html_node/DESTDIR.html
+ [Building in Git]: #Advanced-configuration-and-build-of-ErlangOTP_Building_Within-Git
+ [Advanced Configure]: #Advanced-configuration-and-build-of-ErlangOTP_Configuring
+ [Pre-built Source Release]: #Advanced-configuration-and-build-of-ErlangOTP_Building_Prebuilt-Source-Release
+ [make and $ERL_TOP]: #Advanced-configuration-and-build-of-ErlangOTP_make-and-ERLTOP
+ [html documentation]: https://github.com/erlang/otp/releases/download/OTP-%OTP-VSN%/otp_doc_html_%OTP-VSN%.tar.gz
+ [man pages]: https://github.com/erlang/otp/releases/download/OTP-%OTP-VSN%/otp_doc_man_%OTP-VSN%.tar.gz
+ [the released source tar ball]: https://github.com/erlang/otp/releases/download/OTP-%OTP-VSN%/otp_src_%OTP-VSN%.tar.gz
+ [System Principles]: system/system_principles:system_principles
+ [native build]: #How-to-Build-and-Install-ErlangOTP
+ [cross build]: INSTALL-CROSS.md
+ [Required Utilities]: #Required-Utilities
+ [Optional Utilities]: #Optional-Utilities
+ [Building on a Mac]: #Advanced-configuration-and-build-of-ErlangOTP_Building_OS-X-Darwin
+ [Building with wxErlang]: #Advanced-configuration-and-build-of-ErlangOTP_Building_Building-with-wxErlang
+ [libatomic_ops]: https://github.com/ivmai/libatomic_ops/