diff options
Diffstat (limited to 'docs/en/erlang.mk')
31 files changed, 632 insertions, 197 deletions
diff --git a/docs/en/erlang.mk/1/guide/app/index.html b/docs/en/erlang.mk/1/guide/app/index.html index 670e898b..598d725e 100644 --- a/docs/en/erlang.mk/1/guide/app/index.html +++ b/docs/en/erlang.mk/1/guide/app/index.html @@ -7,7 +7,7 @@ <meta name="description" content=""> <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> - <meta name="generator" content="Hugo 0.30.2" /> + <meta name="generator" content="Hugo 0.37.1" /> <title>Nine Nines: Building</title> @@ -77,7 +77,7 @@ using a project <a href="../getting_started">generated by Erlang.mk</a>.</p></di <div class="sectionbody"> <div class="paragraph"><p>To build a project, all you have to do is type <code>make</code>:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -114,7 +114,7 @@ up generating releases.</p></div> <div class="paragraph"><p>You can build your application and dependencies without generating a release by running the following command:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -122,7 +122,7 @@ http://www.gnu.org/software/src-highlite --> <div class="paragraph"><p>To build your application without touching dependencies at all, you can use the <code>SKIP_DEPS</code> variable:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -138,7 +138,7 @@ is missing.</p></div> <div class="paragraph"><p>You can build all dependencies, and nothing else, by running the following command:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -158,7 +158,7 @@ a normal Erlang.mk. A separate target is however available, and will take care of building the release, after building the application and all dependencies:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -271,7 +271,7 @@ your situation.</p></div> <div class="paragraph"><p>There’s no need for quotes or anything. The relevant part of the Cowboy Makefile follows, if you need an example:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -304,7 +304,7 @@ reason or another, worry not; Erlang.mk will support it. And if you need to create a new project that uses this method, you just have to say so when bootstrapping:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -336,7 +336,7 @@ as it allows you to know which version they run exactly by asking them to look in the file, or by running a simple command on their production server:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -464,7 +464,7 @@ the <a href="http://www.erlang.org/doc/man/erlc.html">erlc Manual</a> for the full list.</p></div> <div class="paragraph"><p>By default, Erlang.mk will set the following options:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -475,7 +475,7 @@ obsolete guard functions.</p></div> <div class="paragraph"><p>You can redefine this variable in your Makefile to change it completely, either before or after including Erlang.mk:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -484,7 +484,7 @@ http://www.gnu.org/software/src-highlite --> sets, by defining ERLC_OPTS after including Erlang.mk using the <code>:=</code> operator.</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -509,7 +509,7 @@ not normally need it.</p></div> <div class="paragraph"><p>To exclude a module, simply list it in the variable, either before or after including Erlang.mk:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -559,7 +559,7 @@ when you have behaviors used by other modules in your project.</p></div> the dependency tracking file every time you compile. You can do this by adding the following line to your <em>Makefile</em>:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -571,7 +571,7 @@ this value when you do make substantial changes to your project and want to rebuild the dependency tracking file. You’ll be able to use the following command:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -593,7 +593,7 @@ file is generated. To do this, you would add your hook before or after including the <em>erlang.mk</em> file.</p></div> <div class="paragraph"><p>The easiest way is after:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -616,7 +616,7 @@ modified.</p></div> Erlang.mk, don’t forget to set the <code>.DEFAULT_GOAL</code> variable, otherwise nothing will get built:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -648,14 +648,14 @@ putting your directory back to the state it was before you started working on it.</p></div> <div class="paragraph"><p>To clean:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt>$ make clean</tt></pre></div></div> <div class="paragraph"><p>Or distclean:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> diff --git a/docs/en/erlang.mk/1/guide/asciidoc/index.html b/docs/en/erlang.mk/1/guide/asciidoc/index.html index 0a51ddeb..ad9c8406 100644 --- a/docs/en/erlang.mk/1/guide/asciidoc/index.html +++ b/docs/en/erlang.mk/1/guide/asciidoc/index.html @@ -7,7 +7,7 @@ <meta name="description" content=""> <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> - <meta name="generator" content="Hugo 0.30.2" /> + <meta name="generator" content="Hugo 0.37.1" /> <title>Nine Nines: AsciiDoc documentation</title> @@ -111,35 +111,35 @@ inside the files themselves.</p></div> <div class="sectionbody"> <div class="paragraph"><p>To build all documentation:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt>$ make docs</tt></pre></div></div> <div class="paragraph"><p>To build only the AsciiDoc documentation:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt>$ make asciidoc</tt></pre></div></div> <div class="paragraph"><p>To build only the user guide:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt>$ make asciidoc-guide</tt></pre></div></div> <div class="paragraph"><p>To build only the manual:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt>$ make asciidoc-manual</tt></pre></div></div> <div class="paragraph"><p>To install man pages on Unix:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -151,7 +151,7 @@ defines where man pages will be installed. It defaults to which manual sections are to be installed. It defaults to <code>3 7</code>.</p></div> <div class="paragraph"><p>To install man pages to a custom location:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> diff --git a/docs/en/erlang.mk/1/guide/ci/index.html b/docs/en/erlang.mk/1/guide/ci/index.html index 950eca18..3a325146 100644 --- a/docs/en/erlang.mk/1/guide/ci/index.html +++ b/docs/en/erlang.mk/1/guide/ci/index.html @@ -7,7 +7,7 @@ <meta name="description" content=""> <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> - <meta name="generator" content="Hugo 0.30.2" /> + <meta name="generator" content="Hugo 0.37.1" /> <title>Nine Nines: Continuous integration</title> @@ -82,7 +82,7 @@ OTP release, a HiPE-enabled release or an ErLLVM-enabled release.</p></div> <div class="paragraph"><p>At the time of writing, this is how you would test against all the most recent patch releases of Erlang/OTP 19 and above:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -90,7 +90,7 @@ http://www.gnu.org/software/src-highlite --> <div class="paragraph"><p>If you want to test against HiPE and ErLLVM but only with the latest version of Erlang/OTP, the following could work:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -108,7 +108,7 @@ Erlang/OTP builds.</p></div> <code>-k</code>. It will ensure that tests are run for all configured Erlang/OTP versions, even if there are errors:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -121,7 +121,7 @@ http://www.gnu.org/software/src-highlite --> <div class="paragraph"><p>The <code>ci</code> target can be extended. For example to run Dialyzer at the end of CI:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -132,7 +132,7 @@ Erlang/OTP version.</p></div> <div class="paragraph"><p>For example, to ensure dependencies are re-fetched/built before testing individual Erlang/OTP releases:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> diff --git a/docs/en/erlang.mk/1/guide/common_test/index.html b/docs/en/erlang.mk/1/guide/common_test/index.html index faf90773..25a0f2e5 100644 --- a/docs/en/erlang.mk/1/guide/common_test/index.html +++ b/docs/en/erlang.mk/1/guide/common_test/index.html @@ -7,7 +7,7 @@ <meta name="description" content=""> <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> - <meta name="generator" content="Hugo 0.30.2" /> + <meta name="generator" content="Hugo 0.37.1" /> <title>Nine Nines: Common Test</title> @@ -88,7 +88,7 @@ options. Options are documented in the <a href="http://www.erlang.org/doc/apps/common_test/run_test_chapter.html">Common Test user guide</a>. You can use it to set Common Test hooks, for example:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -101,7 +101,7 @@ test suites automatically.</p></div> If the file is named <em>http_SUITE.erl</em>, the test suite is <code>http</code>:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -109,7 +109,7 @@ http://www.gnu.org/software/src-highlite --> <div class="paragraph"><p>The <code>CT_LOGS_DIR</code> variable can be used to set where HTML log files are to be written. This defaults to <em>logs/</em>.</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -121,21 +121,21 @@ http://www.gnu.org/software/src-highlite --> <div class="sectionbody"> <div class="paragraph"><p>To run all tests (including Common Test):</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt>$ make tests</tt></pre></div></div> <div class="paragraph"><p>To run all tests and static checks (including Common Test):</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt>$ make check</tt></pre></div></div> <div class="paragraph"><p>You can also run Common Test separately:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -144,7 +144,7 @@ http://www.gnu.org/software/src-highlite --> If you have a file named <em>test/http_SUITE.erl</em>, then the target <code>ct-http</code> will run that specific test suite:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -156,14 +156,14 @@ suite-specific targets, like the <code>ct-http</code> example above.</p></div> <div class="paragraph"><p>To run all tests from the <code>http_compress</code> group in the <code>http_SUITE</code> test suite, write:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt>$ make ct-http <span style="color: #009900">t</span><span style="color: #990000">=</span>http_compress</tt></pre></div></div> <div class="paragraph"><p>Similarly, to run a specific test case in that group:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -171,7 +171,7 @@ http://www.gnu.org/software/src-highlite --> <div class="paragraph"><p>To do the same against a multi-application repository, you can use the <code>-C</code> option:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -179,7 +179,7 @@ http://www.gnu.org/software/src-highlite --> <div class="paragraph"><p>Note that this also applies to dependencies. When using Cowboy as a dependency, you can run the following directly:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> diff --git a/docs/en/erlang.mk/1/guide/compat/index.html b/docs/en/erlang.mk/1/guide/compat/index.html index 788e2fac..6e0e408b 100644 --- a/docs/en/erlang.mk/1/guide/compat/index.html +++ b/docs/en/erlang.mk/1/guide/compat/index.html @@ -7,7 +7,7 @@ <meta name="description" content=""> <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> - <meta name="generator" content="Hugo 0.30.2" /> + <meta name="generator" content="Hugo 0.37.1" /> <title>Nine Nines: Compatibility with other build tools</title> @@ -103,7 +103,7 @@ and the application resource file, found either at <div class="paragraph"><p>Erlang.mk comes with a target that generates a <em>rebar.config</em> file when invoked:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -123,7 +123,7 @@ issues.</p></div> your application, by making it a dependency of the <code>app</code> target:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> diff --git a/docs/en/erlang.mk/1/guide/contributing/index.html b/docs/en/erlang.mk/1/guide/contributing/index.html index 661ff55a..9d7bca3a 100644 --- a/docs/en/erlang.mk/1/guide/contributing/index.html +++ b/docs/en/erlang.mk/1/guide/contributing/index.html @@ -7,7 +7,7 @@ <meta name="description" content=""> <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> - <meta name="generator" content="Hugo 0.30.2" /> + <meta name="generator" content="Hugo 0.37.1" /> <title>Nine Nines: Contributing</title> @@ -147,7 +147,7 @@ command. This can be done both from an Erlang.mk project or directly from the Erlang.mk repository.</p></div> <div class="paragraph"><p>Packages can be added to the index using the <code>pkg_add.sh</code> script.</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> diff --git a/docs/en/erlang.mk/1/guide/coverage/index.html b/docs/en/erlang.mk/1/guide/coverage/index.html index 4c0aa76c..d033c604 100644 --- a/docs/en/erlang.mk/1/guide/coverage/index.html +++ b/docs/en/erlang.mk/1/guide/coverage/index.html @@ -7,7 +7,7 @@ <meta name="description" content=""> <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> - <meta name="generator" content="Hugo 0.30.2" /> + <meta name="generator" content="Hugo 0.37.1" /> <title>Nine Nines: Code coverage</title> diff --git a/docs/en/erlang.mk/1/guide/deps/index.html b/docs/en/erlang.mk/1/guide/deps/index.html index f74a5842..98fe2cd5 100644 --- a/docs/en/erlang.mk/1/guide/deps/index.html +++ b/docs/en/erlang.mk/1/guide/deps/index.html @@ -7,7 +7,7 @@ <meta name="description" content=""> <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> - <meta name="generator" content="Hugo 0.30.2" /> + <meta name="generator" content="Hugo 0.37.1" /> <title>Nine Nines: Packages and dependencies</title> @@ -84,7 +84,7 @@ in a single repository.</p></div> being added regularly.</p></div> <div class="paragraph"><p>To find a package, search for it:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -94,7 +94,7 @@ pool and acceptor pool projects.</p></div> <div class="paragraph"><p>You can also list everything and use regular command line tools to find what you need, for example:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -107,7 +107,7 @@ http://www.gnu.org/software/src-highlite --> <div class="paragraph"><p>Once you find the package you need, adding it as a dependency to your project is a one-liner:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -126,7 +126,7 @@ dependencies.</p></div> <div class="paragraph"><p>For example, you could add a parse transform project like this to make it available only at build time:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -134,7 +134,7 @@ http://www.gnu.org/software/src-highlite --> <div class="paragraph"><p>Or you could depend on a C project directly, if you are building a NIF:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -153,7 +153,7 @@ Do note that there is no way to choose the version, the application used will be the one already on your system.</p></div> <div class="paragraph"><p>You could depend on the Crypto application, for example:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -161,7 +161,7 @@ http://www.gnu.org/software/src-highlite --> <div class="paragraph"><p>Erlang.mk comes with additional types of dependencies. It has <code>TEST_DEPS</code> for dependencies used only for testing:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -169,7 +169,7 @@ http://www.gnu.org/software/src-highlite --> <span style="color: #009900">dep_ct_helper =</span> git https<span style="color: #990000">:</span>//github.com/ninenines/ct_helper master</tt></pre></div></div> <div class="paragraph"><p><code>DOC_DEPS</code> for dependencies used only when building documentation:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -177,7 +177,7 @@ http://www.gnu.org/software/src-highlite --> <div class="paragraph"><p><code>REL_DEPS</code> for dependencies required to build the release, or to include extra applications in the release:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -185,7 +185,7 @@ http://www.gnu.org/software/src-highlite --> <div class="paragraph"><p>And <code>SHELL_DEPS</code> for dependencies to make available when running the <code>make shell</code> command:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -198,7 +198,7 @@ chapters.</p></div> find the project you are looking for, if you only provide its name. This is this case:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -210,7 +210,7 @@ for different reasons.</p></div> need to do is to define the <code>dep_$(DEP_NAME)_commit</code> variable. In the case of Cowboy, this would look like this:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -223,7 +223,7 @@ too, for example because you want to use your own fork, or simply because the project is missing from the index, you can define the <code>dep_$(DEP_NAME)</code> variable with everything:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -307,14 +307,14 @@ You can use any valid commit, tag or branch in that repository for the commit value.</p></div> <div class="paragraph"><p>For example, to fetch Cowboy with tag 2.0.0-pre.2 from Git:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt><span style="color: #009900">dep_cowboy =</span> git https<span style="color: #990000">:</span>//github.com/ninenines/cowboy 2.0.0-pre.2</tt></pre></div></div> <div class="paragraph"><p>Or to fetch Ehsa tag 4.0.3 from Mercurial:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -323,7 +323,7 @@ http://www.gnu.org/software/src-highlite --> automatically initializes and updates submodules for dependencies, as long as they were added beforehand using <code>git submodule add</code>:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -333,7 +333,7 @@ simply because the SVN repository URL can also contain the path and commit.</p></div> <div class="paragraph"><p>This would fetch an example project from the trunk:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -341,7 +341,7 @@ http://www.gnu.org/software/src-highlite --> <div class="paragraph"><p>And this would fetch a separate example project from a specific commit:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -349,7 +349,7 @@ http://www.gnu.org/software/src-highlite --> <div class="paragraph"><p>You can copy a directory from your machine using the <code>cp</code> method. It only takes the path to copy from:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -357,7 +357,7 @@ http://www.gnu.org/software/src-highlite --> <div class="paragraph"><p>Finally, you can use a package from the <a href="https://hex.pm/">Hex repository</a>:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -374,7 +374,7 @@ Or in layman terms, if your dependency is Cowboy, this would become <em>deps/cowboy</em>.</p></div> <div class="paragraph"><p>To give an example, this is what the Git method does:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -509,7 +509,7 @@ on your system.</p></div> <div class="paragraph"><p>To ignore a dependency, simply add it to the <code>IGNORE_DEPS</code> variable:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -517,7 +517,7 @@ http://www.gnu.org/software/src-highlite --> <div class="paragraph"><p>This will only ignore dependencies that are needed for building. It is therefore safe to write:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -540,7 +540,7 @@ own dependencies.</p></div> if you know you will never use this project as a dependency, <code>=</code> will work. But to avoid it biting you later on, do this:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -609,14 +609,14 @@ the application.</p></div> <div class="paragraph"><p>For example, to create a full fledged OTP application as a local dependency:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt>$ make new-app <span style="font-weight: bold"><span style="color: #0000FF">in</span></span><span style="color: #990000">=</span>webchat</tt></pre></div></div> <div class="paragraph"><p>Or, the same as an OTP library:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -625,7 +625,7 @@ http://www.gnu.org/software/src-highlite --> directory of the project. You do need however to tell Erlang.mk to create the files in the correct application:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -724,7 +724,7 @@ Other projects with no Makefile are left untouched. <div class="paragraph"><p>You can disable the replacing of the <em>erlang.mk</em> file by defining the <code>NO_AUTOPATCH_ERLANG_MK</code> variable:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -732,7 +732,7 @@ http://www.gnu.org/software/src-highlite --> <div class="paragraph"><p>You can also disable autopatch entirely for a few select projects using the <code>NO_AUTOPATCH</code> variable:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -748,7 +748,7 @@ include being somewhere with no connection to download them, or perhaps a peculiar setup.</p></div> <div class="paragraph"><p>A typical usage would be:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> diff --git a/docs/en/erlang.mk/1/guide/dialyzer/index.html b/docs/en/erlang.mk/1/guide/dialyzer/index.html index 4472dbe4..411b24ca 100644 --- a/docs/en/erlang.mk/1/guide/dialyzer/index.html +++ b/docs/en/erlang.mk/1/guide/dialyzer/index.html @@ -7,7 +7,7 @@ <meta name="description" content=""> <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> - <meta name="generator" content="Hugo 0.30.2" /> + <meta name="generator" content="Hugo 0.37.1" /> <title>Nine Nines: Dialyzer</title> @@ -118,7 +118,7 @@ to run, you may want to disable it on larger projects.</p></div> <div class="sectionbody"> <div class="paragraph"><p>To perform an analysis, run the following command:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -127,7 +127,7 @@ http://www.gnu.org/software/src-highlite --> <div class="paragraph"><p>The analysis will also be performed when you run the following command, alongside tests:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> diff --git a/docs/en/erlang.mk/1/guide/edoc/index.html b/docs/en/erlang.mk/1/guide/edoc/index.html index 4d73d7ff..7e787579 100644 --- a/docs/en/erlang.mk/1/guide/edoc/index.html +++ b/docs/en/erlang.mk/1/guide/edoc/index.html @@ -7,7 +7,7 @@ <meta name="description" content=""> <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> - <meta name="generator" content="Hugo 0.30.2" /> + <meta name="generator" content="Hugo 0.37.1" /> <title>Nine Nines: EDoc comments</title> @@ -85,7 +85,7 @@ EDoc options. Options are documented in the <div class="paragraph"><p>A common use for this variable is to enable Markdown in doc comments, using the <code>edown</code> application:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -98,7 +98,7 @@ http://www.gnu.org/software/src-highlite --> <div class="sectionbody"> <div class="paragraph"><p>To build all documentation, you would typically use:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -109,7 +109,7 @@ do not want that file and still want to generate doc comments, two solutions are available.</p></div> <div class="paragraph"><p>You can generate EDoc documentation directly:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -117,7 +117,7 @@ http://www.gnu.org/software/src-highlite --> <div class="paragraph"><p>You can enable automatic generation on <code>make docs</code> by adding the following to your Makefile:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -142,8 +142,8 @@ http://www.gnu.org/software/src-highlite --> - <a style="float:right" href="https://ninenines.eu/docs/en/erlang.mk/1/guide/shell/"> - Erlang shell + <a style="float:right" href="https://ninenines.eu/docs/en/erlang.mk/1/guide/sphinx/"> + Sphinx documentation </a> </nav> diff --git a/docs/en/erlang.mk/1/guide/escripts/index.html b/docs/en/erlang.mk/1/guide/escripts/index.html index cccddf83..120c8e81 100644 --- a/docs/en/erlang.mk/1/guide/escripts/index.html +++ b/docs/en/erlang.mk/1/guide/escripts/index.html @@ -7,7 +7,7 @@ <meta name="description" content=""> <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> - <meta name="generator" content="Hugo 0.30.2" /> + <meta name="generator" content="Hugo 0.37.1" /> <title>Nine Nines: Escripts</title> @@ -82,7 +82,7 @@ package is named <code>p7zip</code>; on Ubuntu you need <code>p7zip-full</code>. <div class="paragraph"><p>If <code>p7zip</code> is unavailable, <code>zip</code> may be used by setting the <code>ESCRIPT_ZIP</code> variable. For example:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -94,7 +94,7 @@ http://www.gnu.org/software/src-highlite --> <div class="sectionbody"> <div class="paragraph"><p>Run the following command to generate an escript:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -104,7 +104,7 @@ the project, in the project’s directory. If the project is called <code>relx</code> then the escript will be in <code>./relx</code>.</p></div> <div class="paragraph"><p>You can run the escript as you would any executable:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -138,7 +138,7 @@ added to this file to create the escript.</p></div> the two steps. You can for example add extra files to the zip archive:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> diff --git a/docs/en/erlang.mk/1/guide/eunit/index.html b/docs/en/erlang.mk/1/guide/eunit/index.html index 97c4ee49..ab93373a 100644 --- a/docs/en/erlang.mk/1/guide/eunit/index.html +++ b/docs/en/erlang.mk/1/guide/eunit/index.html @@ -7,7 +7,7 @@ <meta name="description" content=""> <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> - <meta name="generator" content="Hugo 0.30.2" /> + <meta name="generator" content="Hugo 0.37.1" /> <title>Nine Nines: EUnit</title> @@ -86,7 +86,7 @@ the code you ship to production. With Erlang.mk, you can do this thanks to the <code>TEST</code> macro. It is only defined when running tests:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -100,7 +100,7 @@ as it also defines the <code>TEST</code> macro. Make sure to only include it inside an <code>ifdef</code> block, otherwise tests will always be compiled.</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -123,7 +123,7 @@ EUnit options. Options are documented in the <a href="http://www.erlang.org/doc/man/eunit.html#test-2">EUnit manual</a>. At the time of writing, the only available option is <code>verbose</code>:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -132,7 +132,7 @@ http://www.gnu.org/software/src-highlite --> to be passed to <code>erl</code> when running EUnit tests. For example, you can load the <em>vm.args</em> and <em>sys.config</em> files:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -144,21 +144,21 @@ http://www.gnu.org/software/src-highlite --> <div class="sectionbody"> <div class="paragraph"><p>To run all tests (including EUnit):</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt>$ make tests</tt></pre></div></div> <div class="paragraph"><p>To run all tests and static checks (including EUnit):</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt>$ make check</tt></pre></div></div> <div class="paragraph"><p>You can also run EUnit separately:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -166,7 +166,7 @@ http://www.gnu.org/software/src-highlite --> <div class="paragraph"><p>EUnit will be quiet by default, only outputting errors. You can easily make it verbose for a single invocation:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -178,14 +178,14 @@ the variable <code>t</code>.</p></div> module (instead of all tests from the entire project), one could write:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt>$ make eunit <span style="color: #009900">t</span><span style="color: #990000">=</span>cow_http_hd</tt></pre></div></div> <div class="paragraph"><p>Similarly, to run a specific test case:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -193,7 +193,7 @@ http://www.gnu.org/software/src-highlite --> <div class="paragraph"><p>To do the same against a multi-application repository, you can use the <code>-C</code> option:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -201,7 +201,7 @@ http://www.gnu.org/software/src-highlite --> <div class="paragraph"><p>Note that this also applies to dependencies. From Cowboy, you can run the following directly:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> diff --git a/docs/en/erlang.mk/1/guide/external_plugins/index.html b/docs/en/erlang.mk/1/guide/external_plugins/index.html index 3a8a1100..c1d61145 100644 --- a/docs/en/erlang.mk/1/guide/external_plugins/index.html +++ b/docs/en/erlang.mk/1/guide/external_plugins/index.html @@ -7,7 +7,7 @@ <meta name="description" content=""> <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> - <meta name="generator" content="Hugo 0.30.2" /> + <meta name="generator" content="Hugo 0.37.1" /> <title>Nine Nines: External plugins</title> @@ -88,7 +88,7 @@ of dependencies.</p></div> <div class="paragraph"><p>For example, if you have <code>cowboy</code> in <code>DEPS</code>, add <code>cowboy</code> in <code>DEP_PLUGINS</code> also:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -111,7 +111,7 @@ writing <code>DEP_PLUGINS = cowboy/plugins.mk</code>.</p></div> from Cowboy and no other, we would write the following in our Makefile:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -133,7 +133,7 @@ individual plugins in <em>plugins.mk</em>.</p></div> <em>mk/templates.mk</em>, you could write the following <em>plugins.mk</em> file:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -161,7 +161,7 @@ the same.</p></div> <em>early-plugins.mk</em>. You can specify a filename exactly like you would have done it with regular plugins.</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -169,7 +169,7 @@ http://www.gnu.org/software/src-highlite --> <span style="color: #009900">BUILD_DEPS =</span> common_deps <span style="color: #009900">DEP_EARLY_PLUGINS =</span> common_deps</tt></pre></div></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -189,14 +189,14 @@ library.</p></div> <div class="paragraph"><p>For example, the following Makefile loads a plugin in the <em>mk</em> subdirectory:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt><span style="color: #009900">DEP_PLUGINS =</span> <span style="color: #009900">$(PROJECT)</span>/mk/dist.mk</tt></pre></div></div> <div class="paragraph"><p>This also works with early-stage plugins:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -205,7 +205,7 @@ http://www.gnu.org/software/src-highlite --> defaults to <em>plugins.mk</em> or <em>early-plugins.mk</em>, located at the root of your application:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> diff --git a/docs/en/erlang.mk/1/guide/external_plugins_list/index.html b/docs/en/erlang.mk/1/guide/external_plugins_list/index.html index a72c4cfc..2c2564ea 100644 --- a/docs/en/erlang.mk/1/guide/external_plugins_list/index.html +++ b/docs/en/erlang.mk/1/guide/external_plugins_list/index.html @@ -7,7 +7,7 @@ <meta name="description" content=""> <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> - <meta name="generator" content="Hugo 0.30.2" /> + <meta name="generator" content="Hugo 0.37.1" /> <title>Nine Nines: List of plugins</title> diff --git a/docs/en/erlang.mk/1/guide/getting_started/index.html b/docs/en/erlang.mk/1/guide/getting_started/index.html index fe8532bf..ab67a6df 100644 --- a/docs/en/erlang.mk/1/guide/getting_started/index.html +++ b/docs/en/erlang.mk/1/guide/getting_started/index.html @@ -7,7 +7,7 @@ <meta name="description" content=""> <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> - <meta name="generator" content="Hugo 0.30.2" /> + <meta name="generator" content="Hugo 0.37.1" /> <title>Nine Nines: Getting started</title> @@ -74,7 +74,7 @@ <div class="paragraph"><p>The first step is always to create a new folder that will contain your project.</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -95,14 +95,14 @@ the Cowboy project.</p></div> in your Erlang distribution, or even in your OS packages.</p></div> <div class="paragraph"><p>The next step is therefore to download it:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt>$ wget https<span style="color: #990000">:</span>//erlang<span style="color: #990000">.</span>mk/erlang<span style="color: #990000">.</span>mk</tt></pre></div></div> <div class="paragraph"><p>Or:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -119,7 +119,7 @@ tree. In other words, it will always have processes running.</p></div> <div class="paragraph"><p>This kind of project can be automatically generated by Erlang.mk. All you need to do is use the <code>bootstrap</code> target:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -127,7 +127,7 @@ http://www.gnu.org/software/src-highlite --> <div class="paragraph"><p>Something similar to the following snippet will then appear on your screen:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -154,7 +154,7 @@ to bootstrap. This operation is done only once. Consult the information.</p></div> <div class="paragraph"><p>Of course, the generated project can now be compiled:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -170,7 +170,7 @@ tree. In other words, it is nothing but modules.</p></div> <div class="paragraph"><p>This kind of project can also be generated by Erlang.mk, using the <code>bootstrap-lib</code> target:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -178,7 +178,7 @@ http://www.gnu.org/software/src-highlite --> <div class="paragraph"><p>Erlang.mk will once again bootstrap itself and generate all the files for your project. You can now compile it:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -196,7 +196,7 @@ to your production system and run without any extra setup.</p></div> <div class="paragraph"><p>Erlang.mk can of course bootstrap your project to generate releases. You can use the <code>bootstrap-rel</code> target for this purpose:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -204,7 +204,7 @@ http://www.gnu.org/software/src-highlite --> <div class="paragraph"><p>This target can be combined with <code>bootstrap</code> or <code>bootstrap-lib</code> to create a project that will build a release:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -217,7 +217,7 @@ chapter for more information.</p></div> <div class="paragraph"><p>When you run <code>make</code> from now on, Erlang.mk will compile your project and build the release:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -244,7 +244,7 @@ development.</p></div> script, or simply run <code>make run</code>. The latter will also compile your project and build the release if it wasn’t already:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -280,14 +280,14 @@ manually.</p></div> create a folder, put Erlang.mk in it, and write a one line Makefile containing:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt>include erlang.mk</tt></pre></div></div> <div class="paragraph"><p>For a step by step:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -311,7 +311,7 @@ opposite.</p></div> of spaces per indentation level you want.</p></div> <div class="paragraph"><p>For example, if you prefer two spaces per indentation level:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -331,7 +331,7 @@ templates for generating projects, but also individual modules!</p></div> <div class="paragraph"><p>You can list all available templates with the <code>list-templates</code> target:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -340,7 +340,7 @@ Available templates<span style="color: #990000">:</span> cowboy_http cowboy_loop <div class="paragraph"><p>To generate a module, let’s say a <code>gen_server</code>, all you need to do is to call <code>make new</code> with the appropriate arguments:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -350,7 +350,7 @@ using the <code>gen_server</code> template.</p></div> <div class="paragraph"><p>This module is automatically compiled the next time you run <code>make</code>:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -384,7 +384,7 @@ anymore.</p></div> <div class="paragraph"><p>During development, if you don’t remember the name of a target, you can always run <code>make help</code>:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> diff --git a/docs/en/erlang.mk/1/guide/history/index.html b/docs/en/erlang.mk/1/guide/history/index.html index bdef70e6..82343e48 100644 --- a/docs/en/erlang.mk/1/guide/history/index.html +++ b/docs/en/erlang.mk/1/guide/history/index.html @@ -7,7 +7,7 @@ <meta name="description" content=""> <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> - <meta name="generator" content="Hugo 0.30.2" /> + <meta name="generator" content="Hugo 0.37.1" /> <title>Nine Nines: Short history</title> diff --git a/docs/en/erlang.mk/1/guide/index.html b/docs/en/erlang.mk/1/guide/index.html index 6b7d7fd1..629691ae 100644 --- a/docs/en/erlang.mk/1/guide/index.html +++ b/docs/en/erlang.mk/1/guide/index.html @@ -7,7 +7,7 @@ <meta name="description" content=""> <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> - <meta name="generator" content="Hugo 0.30.2" /> + <meta name="generator" content="Hugo 0.37.1" /> <title>Nine Nines: Erlang.mk User Guide</title> @@ -155,6 +155,11 @@ <a href="edoc/">EDoc comments</a> </p> </li> +<li> +<p> +<a href="sphinx/">Sphinx documentation</a> +</p> +</li> </ul></div> </div> </div> diff --git a/docs/en/erlang.mk/1/guide/installation.asciidoc b/docs/en/erlang.mk/1/guide/installation.asciidoc index bd191efe..3298db2d 100644 --- a/docs/en/erlang.mk/1/guide/installation.asciidoc +++ b/docs/en/erlang.mk/1/guide/installation.asciidoc @@ -24,6 +24,10 @@ The commands to install packages vary between distributions: [source,bash] $ pacman -S erlang git make +Alpine Linux and other distributions based on BusyBox come +with an incompatible `awk` program. Installing the GNU Awk +(`gawk` on Alpine) solves this issue. + ==== FreeBSD FreeBSD comes with binary and source packages: diff --git a/docs/en/erlang.mk/1/guide/installation/index.html b/docs/en/erlang.mk/1/guide/installation/index.html index fd886c96..27f76c1d 100644 --- a/docs/en/erlang.mk/1/guide/installation/index.html +++ b/docs/en/erlang.mk/1/guide/installation/index.html @@ -7,7 +7,7 @@ <meta name="description" content=""> <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> - <meta name="generator" content="Hugo 0.30.2" /> + <meta name="generator" content="Hugo 0.37.1" /> <title>Nine Nines: Installation</title> @@ -84,18 +84,21 @@ have further requirements depending on your needs.</p></div> <div class="paragraph"><p>The commands to install packages vary between distributions:</p></div> <div class="listingblock"> <div class="title">Arch Linux</div> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt>$ pacman -S erlang git make</tt></pre></div></div> +<div class="paragraph"><p>Alpine Linux and other distributions based on BusyBox come +with an incompatible <code>awk</code> program. Installing the GNU Awk +(<code>gawk</code> on Alpine) solves this issue.</p></div> </div> <div class="sect3"> <h4 id="_freebsd">FreeBSD</h4> <div class="paragraph"><p>FreeBSD comes with binary and source packages:</p></div> <div class="listingblock"> <div class="title">Install binary packages</div> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -110,7 +113,7 @@ to install a more recent version from either Homebrew or MacPorts:</p></div> <div class="listingblock"> <div class="title">Homebrew</div> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -119,7 +122,7 @@ http://www.gnu.org/software/src-highlite --> is the one provided by Apple.</p></div> <div class="listingblock"> <div class="title">MacPorts</div> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -198,7 +201,7 @@ C:\> C:\msys64\usr\bin\bash -lc "pacman --noconfirm -Syu"</code></pre> Git and any other required softwares. From an MSYS2 shell, you can call <code>pacman</code> directly:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -206,7 +209,7 @@ http://www.gnu.org/software/src-highlite --> <div class="paragraph"><p>You can use <code>pacman -Ss</code> to search packages. For example, to find all packages related to GCC:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -215,7 +218,7 @@ http://www.gnu.org/software/src-highlite --> install this package, as Erlang.mk cannot use the normal "gcc" package:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> diff --git a/docs/en/erlang.mk/1/guide/kerl/index.html b/docs/en/erlang.mk/1/guide/kerl/index.html index be6b2e46..124b08b5 100644 --- a/docs/en/erlang.mk/1/guide/kerl/index.html +++ b/docs/en/erlang.mk/1/guide/kerl/index.html @@ -7,7 +7,7 @@ <meta name="description" content=""> <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> - <meta name="generator" content="Hugo 0.30.2" /> + <meta name="generator" content="Hugo 0.37.1" /> <title>Nine Nines: OTP version management</title> @@ -104,7 +104,7 @@ ensure this version is used by everyone in your team.</p></div> <code>ERLANG_OTP</code> variable in your Makefile before including Erlang.mk. For example, to use <code>OTP-20.0.4</code>:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -135,7 +135,7 @@ to change the installation directory for the Erlang/OTP versions managed by Kerl, you could add the following to your Makefile:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> diff --git a/docs/en/erlang.mk/1/guide/limitations/index.html b/docs/en/erlang.mk/1/guide/limitations/index.html index 9620e115..d165d205 100644 --- a/docs/en/erlang.mk/1/guide/limitations/index.html +++ b/docs/en/erlang.mk/1/guide/limitations/index.html @@ -7,7 +7,7 @@ <meta name="description" content=""> <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> - <meta name="generator" content="Hugo 0.30.2" /> + <meta name="generator" content="Hugo 0.37.1" /> <title>Nine Nines: Limitations</title> diff --git a/docs/en/erlang.mk/1/guide/overview/index.html b/docs/en/erlang.mk/1/guide/overview/index.html index cc2278e3..b416f77e 100644 --- a/docs/en/erlang.mk/1/guide/overview/index.html +++ b/docs/en/erlang.mk/1/guide/overview/index.html @@ -7,7 +7,7 @@ <meta name="description" content=""> <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> - <meta name="generator" content="Hugo 0.30.2" /> + <meta name="generator" content="Hugo 0.37.1" /> <title>Nine Nines: Overview</title> @@ -97,7 +97,7 @@ shortcut over plain dependencies.</p></div> <div class="paragraph"><p>You can get a list of all packages known to Erlang.mk by using the <code>search</code> target:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -105,7 +105,7 @@ http://www.gnu.org/software/src-highlite --> <div class="paragraph"><p>You can also use this target to search across all packages, for example to find all packages related to Cowboy:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> diff --git a/docs/en/erlang.mk/1/guide/ports/index.html b/docs/en/erlang.mk/1/guide/ports/index.html index 246f574d..71a55fb9 100644 --- a/docs/en/erlang.mk/1/guide/ports/index.html +++ b/docs/en/erlang.mk/1/guide/ports/index.html @@ -7,7 +7,7 @@ <meta name="description" content=""> <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> - <meta name="generator" content="Hugo 0.30.2" /> + <meta name="generator" content="Hugo 0.37.1" /> <title>Nine Nines: NIFs and port drivers</title> @@ -80,7 +80,7 @@ It defaults to <em>c_src/</em>. Should you need to modify it, all you need to do is to set the variable in your Makefile before including Erlang.mk:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -89,7 +89,7 @@ http://www.gnu.org/software/src-highlite --> file named <em>$(C_SRC_ENV)</em>. This file defaults to <em>$(C_SRC_DIR)/env.mk</em>. This can also be changed:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -135,7 +135,7 @@ it.</p></div> <div class="paragraph"><p>You can include the <em>env.mk</em> file to benefit from the Erlang environment detection:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -152,7 +152,7 @@ executables, using the source files it finds in <em>$(C_SRC_DIR)</em>.</p></div> this and create an executable instead, put this in your Makefile before including Erlang.mk:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -234,7 +234,7 @@ impacting other build steps.</p></div> <div class="paragraph"><p>By adding this to your Makefile all five variables will be made available to sub-Makefiles when building C code:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -247,7 +247,7 @@ http://www.gnu.org/software/src-highlite --> because Makefiles expect an assignment for target-specific exports. Alternatively you can set a new value:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> diff --git a/docs/en/erlang.mk/1/guide/releases/index.html b/docs/en/erlang.mk/1/guide/releases/index.html index 0ee51c52..494c27c3 100644 --- a/docs/en/erlang.mk/1/guide/releases/index.html +++ b/docs/en/erlang.mk/1/guide/releases/index.html @@ -7,7 +7,7 @@ <meta name="description" content=""> <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> - <meta name="generator" content="Hugo 0.30.2" /> + <meta name="generator" content="Hugo 0.37.1" /> <title>Nine Nines: Releases</title> @@ -78,7 +78,7 @@ file in the <em>$(RELX_CONFIG)</em> location. This defaults to <em>$(CURDIR)/relx.config</em>. You can override it by defining the variable before including Erlang.mk:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -95,7 +95,7 @@ location defaults to <em>$(CURDIR)/relx</em> and can be overriden.</p></div> <div class="paragraph"><p>You can specify additional Relx options using the <code>RELX_OPTS</code> variable. For example, to enable <code>dev_mode</code>:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -105,7 +105,7 @@ in the Relx options directly, Erlang.mk provides a specific variable for it: <code>RELX_OUTPUT_DIR</code>. It defaults to the <em>_rel</em> directory. You can also override it:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -120,7 +120,7 @@ release. As mentioned before, Erlang.mk will automatically generate it when it detects the <em>$(RELX_CONFIG)</em> file. This means the following command will also build the release:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -128,7 +128,7 @@ http://www.gnu.org/software/src-highlite --> <div class="paragraph"><p>If you need to generate the release, and only the release, the <code>rel</code> target can be used:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -144,7 +144,7 @@ located at <code>$(RELX_OUTPUT_DIR)/<name>/<name>-<vsn>.tar.gz <div class="paragraph"><p>Erlang.mk provides a convenience function for running the release with one simple command:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -174,7 +174,7 @@ release will be <code>example</code>.</p></div> <div class="paragraph"><p>Once all this is done, you can build the tarball for the release upgrade:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -184,7 +184,7 @@ release, <code>$RELX_OUTPUT_DIR/example/example-2.tar.gz</code>.</p></div> <div class="paragraph"><p>Move the archive to the correct location on the running node. From the release’s root directory:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -192,14 +192,14 @@ http://www.gnu.org/software/src-highlite --> $ mv path/to/example-<span style="color: #993399">2</span><span style="color: #990000">.</span>tar<span style="color: #990000">.</span>gz releases<span style="color: #990000">/</span><span style="color: #993399">2</span><span style="color: #990000">/</span></tt></pre></div></div> <div class="paragraph"><p>Finally, upgrade the release:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt>$ bin/example_release upgrade <span style="color: #FF0000">"2/example_release"</span></tt></pre></div></div> <div class="paragraph"><p>Or on Windows:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -214,14 +214,14 @@ http://www.gnu.org/software/src-highlite --> generated by Relx based on VCS history.</p></div> <div class="paragraph"><p>Create a file <em>rel/version</em> with only one line inside:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt>{{ <span style="color: #FF6600">release_version</span> }}</tt></pre></div></div> <div class="paragraph"><p>Add/Update the <code>overlay</code> section of your <code>relx.config</code>:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -231,7 +231,7 @@ http://www.gnu.org/software/src-highlite --> <div class="paragraph"><p>When you run <code>make rel</code> it creates the file <em>$(RELX_OUTPUT_DIR)/example/version</em> which contains the version value generated by Relx.</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -240,14 +240,14 @@ http://www.gnu.org/software/src-highlite --> <div class="paragraph"><p>In your <code>Makefile</code> you can use this simple snippet to get the version, but please keep in mind that this should depend on the <code>rel</code> target:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt><span style="color: #009900">$(</span>shell cat <span style="color: #009900">$(RELX_OUTPUT_DIR)/$(RELX_REL_NAME)/version)</span></tt></pre></div></div> <div class="paragraph"><p>For example:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -258,7 +258,7 @@ http://www.gnu.org/software/src-highlite --> echo APP_VERSION <span style="color: #990000">=</span> <span style="color: #009900">$(APP_VERSION)</span></tt></pre></div></div> <div class="paragraph"><p>Would output:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> diff --git a/docs/en/erlang.mk/1/guide/sfx/index.html b/docs/en/erlang.mk/1/guide/sfx/index.html index 5ef06d47..2877244e 100644 --- a/docs/en/erlang.mk/1/guide/sfx/index.html +++ b/docs/en/erlang.mk/1/guide/sfx/index.html @@ -7,7 +7,7 @@ <meta name="description" content=""> <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> - <meta name="generator" content="Hugo 0.30.2" /> + <meta name="generator" content="Hugo 0.37.1" /> <title>Nine Nines: Self-extracting releases</title> @@ -82,7 +82,7 @@ appreciated.</p></div> is pass the <code>SFX=1</code> variable to Make when you build the release:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -98,7 +98,7 @@ the file will be located at <code>_rel/hello_world.run</code>.</p></div> <div class="sectionbody"> <div class="paragraph"><p>Simply execute the script to get started:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> diff --git a/docs/en/erlang.mk/1/guide/shell/index.html b/docs/en/erlang.mk/1/guide/shell/index.html index 95cc3da1..1d87f835 100644 --- a/docs/en/erlang.mk/1/guide/shell/index.html +++ b/docs/en/erlang.mk/1/guide/shell/index.html @@ -7,7 +7,7 @@ <meta name="description" content=""> <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> - <meta name="generator" content="Hugo 0.30.2" /> + <meta name="generator" content="Hugo 0.37.1" /> <title>Nine Nines: Erlang shell</title> @@ -76,7 +76,7 @@ with all the paths set properly to experiment with your code.</p></div> that are only to be used when the <code>make shell</code> command is called. For example, if you want to use <em>kjell</em> as your shell:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -88,7 +88,7 @@ To continue with our example, if you want to use <em>kjell</em> as your shell, you also need to change <code>SHELL_ERL</code> and point it to the <code>kjell</code> executable:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -96,14 +96,14 @@ http://www.gnu.org/software/src-highlite --> <div class="paragraph"><p>You can specify additional options to be used when starting the shell using the <code>SHELL_OPTS</code> variable:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt><span style="color: #009900">SHELL_OPTS =</span> -setcookie chocolate</tt></pre></div></div> <div class="paragraph"><p>Any of the usual <code>erl</code> options can be used, including <code>-eval</code>:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -115,7 +115,7 @@ http://www.gnu.org/software/src-highlite --> <div class="sectionbody"> <div class="paragraph"><p>To start the shell, all you need is the following command:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -136,8 +136,8 @@ command <code>q().</code>.</p></div> <nav style="margin:1em 0"> - <a style="float:left" href="https://ninenines.eu/docs/en/erlang.mk/1/guide/edoc/"> - EDoc comments + <a style="float:left" href="https://ninenines.eu/docs/en/erlang.mk/1/guide/sphinx/"> + Sphinx documentation </a> diff --git a/docs/en/erlang.mk/1/guide/sphinx.asciidoc b/docs/en/erlang.mk/1/guide/sphinx.asciidoc new file mode 100644 index 00000000..d4de20dd --- /dev/null +++ b/docs/en/erlang.mk/1/guide/sphinx.asciidoc @@ -0,0 +1,129 @@ +[[sphinx]] +== Sphinx documentation + +Erlang.mk includes targets for running the +http://www.sphinx-doc.org/[Sphinx documentation generator], which can produce +documentation in various formats, like HTML, man pages, Texinfo, LaTeX, and +others. + +=== Writing Sphinx documentation + +Sphinx generates documentation from a set of +http://www.sphinx-doc.org/en/stable/rest.html[reST] documents. There is +a http://www.sphinx-doc.org/en/stable/tutorial.html[quick start guide] on +Sphinx' website. For Erlang.mk, we'll set up a minimal environment instead. + +=== Basic setup + +By default, Erlang.mk expects Sphinx documentation to be placed in the 'doc' +directory, with 'doc/conf.py' config file in particular. The file contains +information about the project, among the other things. + +A minimal 'doc/conf.py' will look similar to this: + +[source,python] +---- +project = 'My Project' +version = '0.0' +release = '0.0.1' +master_doc = 'index' +source_suffix = '.rst' +---- + +It points to a 'doc/index.rst' document. A simple skeleton includes a table of +contents for all documentation, and links to generated index of terms and +a search page: + +---- +My Project +========== + +Contents: + +.. toctree:: + :maxdepth: 2 + + other_page + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search` +---- + +The skeleton above has a link to one other page, 'doc/other_page.rst'. Simple +header with some text will do for now: + +---- +Other Page +========== + +Lorem ipsum dolor sit amet... +---- + +The files above are enough to build HTML documentation to the 'html' directory. + +[source,bash] +$ make docs # all the docs, including EDoc and AsciiDoc if applicable +$ make sphinx # Sphinx docs specifically + +=== Erlang.mk configuration + +Erlang.mk defaults to the following configuration: + +[source,make] +SPHINX_FORMATS = html +SPHINX_SOURCE = doc + +To change the location of Sphinx sources, you need to set the `$(SPHINX_SOURCE)` +variable. The 'conf.py' file should also be placed in that directory, unless you +specify `$(SPHINX_CONFDIR)`. + +The variable `$(SPHINX_OPTS)` allows to provide options to `sphinx-build`, which +is particularly useful for `-D name=value` options. You can even forego +'doc/conf.py' file, using `-D name=value` in combination with the `-C` option, +though in this case you will need to manually call `make sphinx` or add the +`sphinx` target to dependencies of `docs`. + +The `$(SPHINX_FORMATS)` variable lists formats to generate. By default only HTML +is generated, but it can also build man pages or LaTeX documents which can later +be converted to PDF. See the +http://www.sphinx-doc.org/en/stable/invocation.html#cmdoption-sphinx-build-b[description of the `-b` option] +for `sphinx-build` for a list of known formats. + +Formats are by default generated to a directory called after the format +('html' for HTML, 'man' for man pages, and so on). To change this behaviour +for a specific format, you can set the `$(sphinx_$(format)_output)` variable, e.g. +`$(sphinx_html_output)` for 'html' or `$(sphinx_man_output)` for 'man'. +There are also `$(sphinx_$(format)_opts)` variables for setting `sphinx-build` +options for a single format only. + +=== Generating man pages + +To generate man pages, you need to include `man` in `$(SPHINX_FORMATS)` in +your Makefile and define the `man_pages` option in 'doc/conf.py': + +[source,python] +---- +man_pages = [ + ('doc_name', 'page_name', 'Manpage Title', ['Page Author'], 1), +] +---- + +As the +http://www.sphinx-doc.org/en/stable/config.html#options-for-manual-page-output[Sphinx documentation] +indicates, the structure is: + +* `doc_name` is the path to the man page's source (relative `$(SPHINX_SOURCE)`), + without the '.rst' suffix +* `page_name` is the name of the resulting man page, which will be used as a base + for the output file name and will be included in the generated man page +* `Manpage Title` is a short, one-line description, which will be included in + the generated man page on a position that's used by the `apropos` command +* `Page Author` (or more of them) will be included in the autogenerated `AUTHOR` + section. Leaving this field empty disables generating the `AUTHOR` section +* `1` is the man page section number + +With the above configuration (and Erlang.mk's defaults), 'doc/doc_name.rst' will +be used to generate 'man/page_name.1'. diff --git a/docs/en/erlang.mk/1/guide/sphinx/index.html b/docs/en/erlang.mk/1/guide/sphinx/index.html new file mode 100644 index 00000000..3d275b12 --- /dev/null +++ b/docs/en/erlang.mk/1/guide/sphinx/index.html @@ -0,0 +1,294 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <meta name="generator" content="Hugo 0.37.1" /> + + <title>Nine Nines: Sphinx documentation</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=1" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Keep in touch!" href="http://twitter.com/lhoguin"><img src="/img/ico_microblog.png" data-hover="/img/ico_microblog_alt.png"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Sphinx documentation</span></h1> + +<div class="paragraph"><p>Erlang.mk includes targets for running the +<a href="http://www.sphinx-doc.org/">Sphinx documentation generator</a>, which can produce +documentation in various formats, like HTML, man pages, Texinfo, LaTeX, and +others.</p></div> +<div class="sect1"> +<h2 id="_writing_sphinx_documentation">Writing Sphinx documentation</h2> +<div class="sectionbody"> +<div class="paragraph"><p>Sphinx generates documentation from a set of +<a href="http://www.sphinx-doc.org/en/stable/rest.html">reST</a> documents. There is +a <a href="http://www.sphinx-doc.org/en/stable/tutorial.html">quick start guide</a> on +Sphinx' website. For Erlang.mk, we’ll set up a minimal environment instead.</p></div> +</div> +</div> +<div class="sect1"> +<h2 id="_basic_setup">Basic setup</h2> +<div class="sectionbody"> +<div class="paragraph"><p>By default, Erlang.mk expects Sphinx documentation to be placed in the <em>doc</em> +directory, with <em>doc/conf.py</em> config file in particular. The file contains +information about the project, among the other things.</p></div> +<div class="paragraph"><p>A minimal <em>doc/conf.py</em> will look similar to this:</p></div> +<div class="listingblock"> +<div class="content"></div></div> +<div class="paragraph"><p>It points to a <em>doc/index.rst</em> document. A simple skeleton includes a table of +contents for all documentation, and links to generated index of terms and +a search page:</p></div> +<div class="listingblock"> +<div class="content"> +<pre><code>My Project +========== + +Contents: + +.. toctree:: + :maxdepth: 2 + + other_page + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search`</code></pre> +</div></div> +<div class="paragraph"><p>The skeleton above has a link to one other page, <em>doc/other_page.rst</em>. Simple +header with some text will do for now:</p></div> +<div class="listingblock"> +<div class="content"> +<pre><code>Other Page +========== + +Lorem ipsum dolor sit amet...</code></pre> +</div></div> +<div class="paragraph"><p>The files above are enough to build HTML documentation to the <em>html</em> directory.</p></div> +<div class="listingblock"> +<div class="content"><!-- Generator: GNU source-highlight +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>$ make docs <span style="font-style: italic"><span style="color: #9A1900"># all the docs, including EDoc and AsciiDoc if applicable</span></span> +$ make sphinx <span style="font-style: italic"><span style="color: #9A1900"># Sphinx docs specifically</span></span></tt></pre></div></div> +</div> +</div> +<div class="sect1"> +<h2 id="_erlang_mk_configuration">Erlang.mk configuration</h2> +<div class="sectionbody"> +<div class="paragraph"><p>Erlang.mk defaults to the following configuration:</p></div> +<div class="listingblock"> +<div class="content"><!-- Generator: GNU source-highlight +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><span style="color: #009900">SPHINX_FORMATS =</span> html +<span style="color: #009900">SPHINX_SOURCE =</span> doc</tt></pre></div></div> +<div class="paragraph"><p>To change the location of Sphinx sources, you need to set the <code>$(SPHINX_SOURCE)</code> +variable. The <em>conf.py</em> file should also be placed in that directory, unless you +specify <code>$(SPHINX_CONFDIR)</code>.</p></div> +<div class="paragraph"><p>The variable <code>$(SPHINX_OPTS)</code> allows to provide options to <code>sphinx-build</code>, which +is particularly useful for <code>-D name=value</code> options. You can even forego +<em>doc/conf.py</em> file, using <code>-D name=value</code> in combination with the <code>-C</code> option, +though in this case you will need to manually call <code>make sphinx</code> or add the +<code>sphinx</code> target to dependencies of <code>docs</code>.</p></div> +<div class="paragraph"><p>The <code>$(SPHINX_FORMATS)</code> variable lists formats to generate. By default only HTML +is generated, but it can also build man pages or LaTeX documents which can later +be converted to PDF. See the +<a href="http://www.sphinx-doc.org/en/stable/invocation.html#cmdoption-sphinx-build-b">description of the <code>-b</code> option</a> +for <code>sphinx-build</code> for a list of known formats.</p></div> +<div class="paragraph"><p>Formats are by default generated to a directory called after the format +(<em>html</em> for HTML, <em>man</em> for man pages, and so on). To change this behaviour +for a specific format, you can set the <code>$(sphinx_$(format)_output)</code> variable, e.g. +<code>$(sphinx_html_output)</code> for <em>html</em> or <code>$(sphinx_man_output)</code> for <em>man</em>. +There are also <code>$(sphinx_$(format)_opts)</code> variables for setting <code>sphinx-build</code> +options for a single format only.</p></div> +</div> +</div> +<div class="sect1"> +<h2 id="_generating_man_pages">Generating man pages</h2> +<div class="sectionbody"> +<div class="paragraph"><p>To generate man pages, you need to include <code>man</code> in <code>$(SPHINX_FORMATS)</code> in +your Makefile and define the <code>man_pages</code> option in <em>doc/conf.py</em>:</p></div> +<div class="listingblock"> +<div class="content"></div></div> +<div class="paragraph"><p>As the +<a href="http://www.sphinx-doc.org/en/stable/config.html#options-for-manual-page-output">Sphinx documentation</a> +indicates, the structure is:</p></div> +<div class="ulist"><ul> +<li> +<p> +<code>doc_name</code> is the path to the man page’s source (relative <code>$(SPHINX_SOURCE)</code>), + without the <em>.rst</em> suffix +</p> +</li> +<li> +<p> +<code>page_name</code> is the name of the resulting man page, which will be used as a base + for the output file name and will be included in the generated man page +</p> +</li> +<li> +<p> +<code>Manpage Title</code> is a short, one-line description, which will be included in + the generated man page on a position that’s used by the <code>apropos</code> command +</p> +</li> +<li> +<p> +<code>Page Author</code> (or more of them) will be included in the autogenerated <code>AUTHOR</code> + section. Leaving this field empty disables generating the <code>AUTHOR</code> section +</p> +</li> +<li> +<p> +<code>1</code> is the man page section number +</p> +</li> +</ul></div> +<div class="paragraph"><p>With the above configuration (and Erlang.mk’s defaults), <em>doc/doc_name.rst</em> will +be used to generate <em>man/page_name.1</em>.</p></div> +</div> +</div> + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/erlang.mk/1/guide/edoc/"> + EDoc comments + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/erlang.mk/1/guide/shell/"> + Erlang shell + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Erlang.mk + 1 + + User Guide +</h3> + +<ul> + + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/erlang.mk/1/guide">1</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2016</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/erlang.mk/1/guide/updating/index.html b/docs/en/erlang.mk/1/guide/updating/index.html index 06a96bfc..37c58d30 100644 --- a/docs/en/erlang.mk/1/guide/updating/index.html +++ b/docs/en/erlang.mk/1/guide/updating/index.html @@ -7,7 +7,7 @@ <meta name="description" content=""> <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> - <meta name="generator" content="Hugo 0.30.2" /> + <meta name="generator" content="Hugo 0.37.1" /> <title>Nine Nines: Updating Erlang.mk</title> @@ -87,7 +87,7 @@ from this.</p></div> <div class="paragraph"><p>That’s why updating Erlang.mk is so simple. All you need to do is to call <code>make erlang-mk</code>:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -124,7 +124,7 @@ and in what order.</p></div> the build. For example, to exclude the package index and the EDoc plugin when bootstrapping your application:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> @@ -133,7 +133,7 @@ http://www.gnu.org/software/src-highlite --> you update it, until you change your mind and use the <code>WITHOUT</code> variable again when you upgrade:</p></div> <div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +<div class="content"><!-- Generator: GNU source-highlight by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> diff --git a/docs/en/erlang.mk/1/guide/why/index.html b/docs/en/erlang.mk/1/guide/why/index.html index 7aed235e..c7e18c6d 100644 --- a/docs/en/erlang.mk/1/guide/why/index.html +++ b/docs/en/erlang.mk/1/guide/why/index.html @@ -7,7 +7,7 @@ <meta name="description" content=""> <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> - <meta name="generator" content="Hugo 0.30.2" /> + <meta name="generator" content="Hugo 0.37.1" /> <title>Nine Nines: Why Erlang.mk</title> diff --git a/docs/en/erlang.mk/1/guide/xref/index.html b/docs/en/erlang.mk/1/guide/xref/index.html index 2dc4951c..4f0a27c6 100644 --- a/docs/en/erlang.mk/1/guide/xref/index.html +++ b/docs/en/erlang.mk/1/guide/xref/index.html @@ -7,7 +7,7 @@ <meta name="description" content=""> <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> - <meta name="generator" content="Hugo 0.30.2" /> + <meta name="generator" content="Hugo 0.37.1" /> <title>Nine Nines: Xref</title> |