diff options
| author | Rickard Green <[email protected]> | 2014-02-21 11:34:48 +0100 |
|---|---|---|
| committer | Rickard Green <[email protected]> | 2014-02-21 11:34:48 +0100 |
| commit | 2b7d4bebe6d7ecf79d78ead792237a458798be5f (patch) | |
| tree | 41f7e09f26207eee7c7f4a2123583dd07d7a506a /HOWTO | |
| parent | dd298cc2d6b21e8c387ac525bd678f0dfa8853f3 (diff) | |
| parent | f51da9be40b578cdf386264312eb9b37d18ce778 (diff) | |
| download | otp-2b7d4bebe6d7ecf79d78ead792237a458798be5f.tar.gz otp-2b7d4bebe6d7ecf79d78ead792237a458798be5f.tar.bz2 otp-2b7d4bebe6d7ecf79d78ead792237a458798be5f.zip | |
Merge branch 'rickard/doc-build/OTP-11713'
* rickard/doc-build/OTP-11713:
Build documentation with bootstrap system
Diffstat (limited to 'HOWTO')
| -rw-r--r-- | HOWTO/INSTALL-CROSS.md | 16 | ||||
| -rw-r--r-- | HOWTO/INSTALL.md | 20 |
2 files changed, 14 insertions, 22 deletions
diff --git a/HOWTO/INSTALL-CROSS.md b/HOWTO/INSTALL-CROSS.md index 03ea4c6e76..b01de12e44 100644 --- a/HOWTO/INSTALL-CROSS.md +++ b/HOWTO/INSTALL-CROSS.md @@ -103,14 +103,6 @@ has to be provided in the `$PATH`. The Erlang/OTP for the target system will be built using this Erlang system, together with the cross compilation tools provided. -If you want to build the documentation out of the same source tree as you are -cross compiling in, you currently need a full Erlang/OTP system of the same -release as the one being built for the build machine. If this is the case, -build and install one for the build machine (or use one already built) and add -it to the `$PATH` before cross building, and building the documentation. See -the [How to Build the Documentation][] section in the [$ERL_TOP/HOWTO/INSTALL.md][] -document for information on how to build the documentation. - If you want to build using a compatible Erlang/OTP system in the `$PATH`, jump to (3). @@ -284,6 +276,14 @@ and then do the cross build of the system. `otp_build release -a` will do the same as (5), and you will after this have to do a manual install either by doing (6), or (7). +Building and Installing the Documentation +----------------------------------------- + +After the system has been cross built you can build and install the +documentation the same way as after a native build of the system. See the +[How to Build the Documentation][] section in the [$ERL_TOP/HOWTO/INSTALL.md][] +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 diff --git a/HOWTO/INSTALL.md b/HOWTO/INSTALL.md index 2a4abedfcf..c9f4062b83 100644 --- a/HOWTO/INSTALL.md +++ b/HOWTO/INSTALL.md @@ -500,21 +500,11 @@ The Erlang/OTP Documentation ### How to Build the Documentation ### - $ cd $ERL_TOP - -If you have just built Erlang/OTP in the current source tree, you have -already ran `configure` and do not need to do this again; otherwise, run -`configure`. - - $ ./configure [Configure Args] - -When building the documentation you need a full Erlang/OTP-%OTP-REL% system in -the `$PATH`. - - $ export PATH=<Erlang/OTP-%OTP-REL% bin dir>:$PATH # Assuming bash/sh - -Build the documentation. +Before you can build the documentation you need to either [native build][] +or [cross build][] the Erlang/OTP system. After this you can build the +documentation as follows. + $ cd $ERL_TOP $ make docs The documentation can be installed either using the `install-docs` target, @@ -806,6 +796,8 @@ Before modifying this document you need to have a look at the [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 + [native build]: #How-to-Build-and-Install-ErlangOTP + [cross build]: INSTALL-CROSS.md [$ERL_TOP/HOWTO/MARKDOWN.md]: MARKDOWN.md [?TOC]: true |