diff options
| author | Loïc Hoguin <[email protected]> | 2018-11-28 16:02:21 +0100 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2018-11-28 16:02:21 +0100 |
| commit | d3abb447a118aecf23afddbec9b83a61ae8d1670 (patch) | |
| tree | 8e3320f64452ac2aa76d68ce50fd8487893929e5 /docs/en | |
| parent | 3edee0ace8f3f12653381e8038461689363c9541 (diff) | |
| download | ninenines.eu-d3abb447a118aecf23afddbec9b83a61ae8d1670.tar.gz ninenines.eu-d3abb447a118aecf23afddbec9b83a61ae8d1670.tar.bz2 ninenines.eu-d3abb447a118aecf23afddbec9b83a61ae8d1670.zip | |
Ranch 1.7.1 and Cowboy 2.6.1
Diffstat (limited to 'docs/en')
27 files changed, 503 insertions, 19 deletions
diff --git a/docs/en/cowboy/2.6/guide/getting_started.asciidoc b/docs/en/cowboy/2.6/guide/getting_started.asciidoc index 75022df7..3215fb9c 100644 --- a/docs/en/cowboy/2.6/guide/getting_started.asciidoc +++ b/docs/en/cowboy/2.6/guide/getting_started.asciidoc @@ -69,7 +69,7 @@ fetch and compile Cowboy: PROJECT = hello_erlang DEPS = cowboy -dep_cowboy_commit = 2.6.0 +dep_cowboy_commit = 2.6.1 DEP_PLUGINS = cowboy diff --git a/docs/en/cowboy/2.6/guide/getting_started/index.html b/docs/en/cowboy/2.6/guide/getting_started/index.html index b0efe72e..6a6f7528 100644 --- a/docs/en/cowboy/2.6/guide/getting_started/index.html +++ b/docs/en/cowboy/2.6/guide/getting_started/index.html @@ -109,7 +109,7 @@ http://www.gnu.org/software/src-highlite --> <pre><tt><font color="#009900">PROJECT =</font> hello_erlang <font color="#009900">DEPS =</font> cowboy -<font color="#009900">dep_cowboy_commit =</font> 2.6.0 +<font color="#009900">dep_cowboy_commit =</font> 2.6.1 <font color="#009900">DEP_PLUGINS =</font> cowboy diff --git a/docs/en/cowboy/2.6/guide/index.html b/docs/en/cowboy/2.6/guide/index.html index 1dd2f094..a90060ad 100644 --- a/docs/en/cowboy/2.6/guide/index.html +++ b/docs/en/cowboy/2.6/guide/index.html @@ -129,7 +129,9 @@ </li> </ul> <h2 id="_additional_information">Additional information</h2> -<ul><li><a href="migrating_from_2.5/">Migrating from Cowboy 2.5 to 2.6</a> +<ul><li><a href="migrating_from_2.6/">Changes since Cowboy 2.6</a> +</li> +<li><a href="migrating_from_2.5/">Migrating from Cowboy 2.5 to 2.6</a> </li> <li><a href="migrating_from_2.4/">Migrating from Cowboy 2.4 to 2.5</a> </li> diff --git a/docs/en/cowboy/2.6/guide/middlewares/index.html b/docs/en/cowboy/2.6/guide/middlewares/index.html index 1f6588da..effc0dd7 100644 --- a/docs/en/cowboy/2.6/guide/middlewares/index.html +++ b/docs/en/cowboy/2.6/guide/middlewares/index.html @@ -112,8 +112,8 @@ - <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.5/"> - Migrating from Cowboy 2.5 to 2.6 + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.6/"> + Changes since Cowboy 2.6 </a> </nav> diff --git a/docs/en/cowboy/2.6/guide/migrating_from_2.5/index.html b/docs/en/cowboy/2.6/guide/migrating_from_2.5/index.html index b301b745..5c024b59 100644 --- a/docs/en/cowboy/2.6/guide/migrating_from_2.5/index.html +++ b/docs/en/cowboy/2.6/guide/migrating_from_2.5/index.html @@ -151,8 +151,8 @@ <nav style="margin:1em 0"> - <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/middlewares/"> - Middlewares + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.6/"> + Changes since Cowboy 2.6 </a> diff --git a/docs/en/cowboy/2.6/guide/migrating_from_2.6.asciidoc b/docs/en/cowboy/2.6/guide/migrating_from_2.6.asciidoc new file mode 100644 index 00000000..0adab3e9 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/migrating_from_2.6.asciidoc @@ -0,0 +1,12 @@ +[appendix] +== Changes since Cowboy 2.6 + +The following patch versions were released since Cowboy 2.6: + +=== Cowboy 2.6.1 + +This release updates Ranch to 1.7.1. + +It fixes an issue with the PROXY protocol where the wrong +CRC32 algorithm was used and would cause checksum +verification to fail. diff --git a/docs/en/cowboy/2.6/guide/migrating_from_2.6/index.html b/docs/en/cowboy/2.6/guide/migrating_from_2.6/index.html new file mode 100644 index 00000000..f8ba26c3 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/migrating_from_2.6/index.html @@ -0,0 +1,173 @@ +<!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"> + + <title>Nine Nines: Changes since Cowboy 2.6</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=2" 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="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>Changes since Cowboy 2.6</span></h1> + +<p>The following patch versions were released since Cowboy 2.6:</p> +<h2 id="_cowboy_2_6_1">Cowboy 2.6.1</h2> +<p>This release updates Ranch to 1.7.1.</p> +<p>It fixes an issue with the PROXY protocol where the wrong CRC32 algorithm was used and would cause checksum verification to fail.</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/middlewares/"> + Middlewares + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.5/"> + Migrating from Cowboy 2.5 to 2.6 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</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-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/erlang.mk/1/guide/app.asciidoc b/docs/en/erlang.mk/1/guide/app.asciidoc index 9d5e9488..226f24c4 100644 --- a/docs/en/erlang.mk/1/guide/app.asciidoc +++ b/docs/en/erlang.mk/1/guide/app.asciidoc @@ -25,6 +25,20 @@ and conventions. Most of the conventions come from Erlang/OTP itself so any seasoned Erlang developers should feel right at home. +Erlang.mk supports multi-threaded building. Parallel execution +is supported for all targets. To execute Erlang.mk in parallel +the `-j` option must be used: + +[source,bash] +$ make -j8 + +The `MAKEFLAGS` variable can be used to enable parallel +building permanently on your system. It can be set in +your `.zshrc`, `.bashrc` or equivalent file. + +[source,bash] +MAKEFLAGS="-j8" + === What to build Erlang.mk gives you control over three steps of the build diff --git a/docs/en/erlang.mk/1/guide/app/index.html b/docs/en/erlang.mk/1/guide/app/index.html index 13875dda..205542e0 100644 --- a/docs/en/erlang.mk/1/guide/app/index.html +++ b/docs/en/erlang.mk/1/guide/app/index.html @@ -74,6 +74,20 @@ http://www.gnu.org/software/src-highlite --> </div></div> <p>It will work regardless of your project: OTP applications, library applications, NIFs, port drivers or even releases. Erlang.mk also automatically downloads and compiles the dependencies for your project.</p> <p>All this is possible thanks to a combination of configuration and conventions. Most of the conventions come from Erlang/OTP itself so any seasoned Erlang developers should feel right at home.</p> +<p>Erlang.mk supports multi-threaded building. Parallel execution is supported for all targets. To execute Erlang.mk in parallel the <code>-j</code> option must be used:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>$ make -j<font color="#993399">8</font></tt></pre> +</div></div> +<p>The <code>MAKEFLAGS</code> variable can be used to enable parallel building permanently on your system. It can be set in your <code>.zshrc</code>, <code>.bashrc</code> or equivalent file.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">MAKEFLAGS</font><font color="#990000">=</font><font color="#FF0000">"-j8"</font></tt></pre> +</div></div> <h2 id="_what_to_build">What to build</h2> <p>Erlang.mk gives you control over three steps of the build process, allowing you to do a partial build if needed.</p> <p>A build has three phases: first any dependency is fetched and built, then the project itself is built and finally a release may be generated when applicable. A release is only generated for projects specifically configured to do so.</p> diff --git a/docs/en/erlang.mk/1/guide/common_test.asciidoc b/docs/en/erlang.mk/1/guide/common_test.asciidoc index f8f0de3d..993bb8cd 100644 --- a/docs/en/erlang.mk/1/guide/common_test.asciidoc +++ b/docs/en/erlang.mk/1/guide/common_test.asciidoc @@ -93,5 +93,11 @@ as a dependency, you can run the following directly: [source,bash] $ make -C deps/cowboy ct-http t=http_compress +The variable `c` can be used to run a specific test when +the test suite does not group test cases: + +[source,bash] +$ make ct-http c=headers_dupe + Finally, xref:coverage[code coverage] is available, but covered in its own chapter. 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 8c4c66d2..c50f40be 100644 --- a/docs/en/erlang.mk/1/guide/common_test/index.html +++ b/docs/en/erlang.mk/1/guide/common_test/index.html @@ -146,6 +146,13 @@ http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt>$ make -C deps/cowboy ct-http <font color="#009900">t</font><font color="#990000">=</font>http_compress</tt></pre> </div></div> +<p>The variable <code>c</code> can be used to run a specific test when the test suite does not group test cases:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>$ make ct-http <font color="#009900">c</font><font color="#990000">=</font>headers_dupe</tt></pre> +</div></div> <p>Finally, <a href="../coverage">code coverage</a> is available, but covered in its own chapter.</p> diff --git a/docs/en/erlang.mk/1/guide/deps.asciidoc b/docs/en/erlang.mk/1/guide/deps.asciidoc index 84a53de1..3ba7a398 100644 --- a/docs/en/erlang.mk/1/guide/deps.asciidoc +++ b/docs/en/erlang.mk/1/guide/deps.asciidoc @@ -163,6 +163,7 @@ The following table lists all existing methods: |=== | Name | Format | Description | git | git repo commit | Clone the Git repository and checkout the given version +| git-subfolder | git repo commit subfolder | Clone the Git repository, checkout the given version and use one of its subfolders as a dependency | git-submodule | git-submodule | Initialize and update the Git submodule | hg | hg repo commit | Clone the Mercurial repository and update to the given version | svn | svn repo | Checkout the given SVN repository @@ -514,6 +515,28 @@ projects using the `NO_AUTOPATCH` variable: [source,make] NO_AUTOPATCH = cowboy ranch cowlib +=== Dealing with duplicate modules + +When there are duplicate modules found in both applications +and their dependencies, some tasks may fail. Erlang expects +modules to be unique in general. + +When the duplicates are found in dependencies, you will need +to remove one of the duplicates at fetch time. To do so, you +can add a rule similar to this to your Makefile before including +'erlang.mk': + +[source,make] +---- +DEPS_DIR = $(CURDIR)/deps + +deps:: $(DEPS_DIR)/cowlib + $(verbose) rm -f $(DEPS_DIR)/cowlib/src/cow_ws.erl +---- + +This must be done from the application that has this dependency. +Only define the `DEPS_DIR` variable if necessary. + === Skipping deps It is possible to temporarily skip all dependency operations. diff --git a/docs/en/erlang.mk/1/guide/deps/index.html b/docs/en/erlang.mk/1/guide/deps/index.html index 44c325d0..11e9171f 100644 --- a/docs/en/erlang.mk/1/guide/deps/index.html +++ b/docs/en/erlang.mk/1/guide/deps/index.html @@ -187,6 +187,10 @@ http://www.gnu.org/software/src-highlite --> <td>git repo commit</td> <td>Clone the Git repository and checkout the given version</td> </tr> +<tr><td>git-subfolder</td> +<td>git repo commit subfolder</td> +<td>Clone the Git repository, checkout the given version and use one of its subfolders as a dependency</td> +</tr> <tr><td>git-submodule</td> <td>git-submodule</td> <td>Initialize and update the Git submodule</td> @@ -426,6 +430,19 @@ http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt><font color="#009900">NO_AUTOPATCH =</font> cowboy ranch cowlib</tt></pre> </div></div> +<h2 id="_dealing_with_duplicate_modules">Dealing with duplicate modules</h2> +<p>When there are duplicate modules found in both applications and their dependencies, some tasks may fail. Erlang expects modules to be unique in general.</p> +<p>When the duplicates are found in dependencies, you will need to remove one of the duplicates at fetch time. To do so, you can add a rule similar to this to your Makefile before including <em>erlang.mk</em>:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">DEPS_DIR =</font> <font color="#009900">$(CURDIR)</font>/deps + +<font color="#990000">deps::</font> <font color="#009900">$(DEPS_DIR)</font>/cowlib + <font color="#009900">$(verbose)</font> rm -f <font color="#009900">$(DEPS_DIR)</font>/cowlib/src/cow_ws.erl</tt></pre> +</div></div> +<p>This must be done from the application that has this dependency. Only define the <code>DEPS_DIR</code> variable if necessary.</p> <h2 id="_skipping_deps">Skipping deps</h2> <p>It is possible to temporarily skip all dependency operations. This is done by defining the <code>SKIP_DEPS</code> variable. Use cases include being somewhere with no connection to download them, or perhaps a peculiar setup.</p> <p>A typical usage would be:</p> diff --git a/docs/en/erlang.mk/1/guide/edoc.asciidoc b/docs/en/erlang.mk/1/guide/edoc.asciidoc index 9fc1a740..2992a37d 100644 --- a/docs/en/erlang.mk/1/guide/edoc.asciidoc +++ b/docs/en/erlang.mk/1/guide/edoc.asciidoc @@ -46,3 +46,16 @@ the following to your Makefile: ---- docs:: edoc ---- + +=== Running EDoc on all applications + +In a multi-application project you may want to run EDoc +against all applications at the same time, instead of +against each applications independently. To do so, you +need to configure the `EDOC_SRC_DIRS` at the end of +your Makefile, after including 'erlang.mk': + +[source,make] +---- +EDOC_SRC_DIRS = $(ALL_APPS_DIRS) +---- diff --git a/docs/en/erlang.mk/1/guide/edoc/index.html b/docs/en/erlang.mk/1/guide/edoc/index.html index 513cb07f..ff876b37 100644 --- a/docs/en/erlang.mk/1/guide/edoc/index.html +++ b/docs/en/erlang.mk/1/guide/edoc/index.html @@ -98,6 +98,14 @@ http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt><font color="#990000">docs::</font> edoc</tt></pre> </div></div> +<h2 id="_running_edoc_on_all_applications">Running EDoc on all applications</h2> +<p>In a multi-application project you may want to run EDoc against all applications at the same time, instead of against each applications independently. To do so, you need to configure the <code>EDOC_SRC_DIRS</code> at the end of your Makefile, after including <em>erlang.mk</em>:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">EDOC_SRC_DIRS =</font> <font color="#009900">$(ALL_APPS_DIRS)</font></tt></pre> +</div></div> diff --git a/docs/en/erlang.mk/1/guide/eunit.asciidoc b/docs/en/erlang.mk/1/guide/eunit.asciidoc index 496b6749..41e26e39 100644 --- a/docs/en/erlang.mk/1/guide/eunit.asciidoc +++ b/docs/en/erlang.mk/1/guide/eunit.asciidoc @@ -65,7 +65,7 @@ to be passed to `erl` when running EUnit tests. For example, you can load the 'vm.args' and 'sys.config' files: [source,make] -EUNIT_ERL_OPTS = -args_file rel/vm.args -config rel/sys.config +EUNIT_ERL_OPTS = -args_file config/vm.args -config config/sys.config === Usage diff --git a/docs/en/erlang.mk/1/guide/eunit/index.html b/docs/en/erlang.mk/1/guide/eunit/index.html index ba47b6c2..502c76da 100644 --- a/docs/en/erlang.mk/1/guide/eunit/index.html +++ b/docs/en/erlang.mk/1/guide/eunit/index.html @@ -104,7 +104,7 @@ http://www.gnu.org/software/src-highlite --> by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt><font color="#009900">EUNIT_ERL_OPTS =</font> -args_file rel/vm.args -config rel/sys.config</tt></pre> +<pre><tt><font color="#009900">EUNIT_ERL_OPTS =</font> -args_file config/vm.args -config config/sys.config</tt></pre> </div></div> <h2 id="_usage">Usage</h2> <p>To run all tests (including EUnit):</p> diff --git a/docs/en/erlang.mk/1/guide/installation.asciidoc b/docs/en/erlang.mk/1/guide/installation.asciidoc index 3298db2d..254b461d 100644 --- a/docs/en/erlang.mk/1/guide/installation.asciidoc +++ b/docs/en/erlang.mk/1/guide/installation.asciidoc @@ -28,6 +28,9 @@ Alpine Linux and other distributions based on BusyBox come with an incompatible `awk` program. Installing the GNU Awk (`gawk` on Alpine) solves this issue. +Parallel builds may require the program `flock` that can +be found in the package `util-linux`. + ==== FreeBSD FreeBSD comes with binary and source packages: @@ -56,6 +59,11 @@ is the one provided by Apple. [source,bash] $ sudo port install erlang git gmake +Parallel builds may require the program `flock` which can +be installed via Homebrew or manually. The instructions +to install are available from its repository: +https://github.com/discoteq/flock + === On Windows Erlang.mk can be used on Windows inside an MSYS2 environment. diff --git a/docs/en/erlang.mk/1/guide/installation/index.html b/docs/en/erlang.mk/1/guide/installation/index.html index 3d49f35e..981bab8d 100644 --- a/docs/en/erlang.mk/1/guide/installation/index.html +++ b/docs/en/erlang.mk/1/guide/installation/index.html @@ -77,6 +77,7 @@ http://www.gnu.org/software/src-highlite --> <pre><tt>$ pacman -S erlang git make</tt></pre> </div></div> <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> +<p>Parallel builds may require the program <code>flock</code> that can be found in the package <code>util-linux</code>.</p> <h4 id="_freebsd">FreeBSD</h4> <p>FreeBSD comes with binary and source packages:</p> <div class="listingblock"><div class="title">Install binary packages</div> @@ -104,6 +105,7 @@ http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt>$ sudo port install erlang git gmake</tt></pre> </div></div> +<p>Parallel builds may require the program <code>flock</code> which can be installed via Homebrew or manually. The instructions to install are available from its repository: <a href="https://github.com/discoteq/flock">https://github.com/discoteq/flock</a></p> <h2 id="_on_windows">On Windows</h2> <p>Erlang.mk can be used on Windows inside an MSYS2 environment. Cygwin, MSYS (the original) and native Windows (both Batch and PowerShell) are currently not supported.</p> <p>NOTE: Erlang.mk expects Unix line breaks in most of the files (LF instead of CRLF). Make sure to configure your text editor adequately.</p> diff --git a/docs/en/erlang.mk/1/guide/releases.asciidoc b/docs/en/erlang.mk/1/guide/releases.asciidoc index f1e20e6b..92968ff8 100644 --- a/docs/en/erlang.mk/1/guide/releases.asciidoc +++ b/docs/en/erlang.mk/1/guide/releases.asciidoc @@ -124,7 +124,7 @@ Your release was upgraded! There is a *workaround* to get the semver value which is generated by Relx based on VCS history. -Create a file 'rel/version' with only one line inside: +Create a file 'config/version' with only one line inside: [source,erlang] {{ release_version }} @@ -133,7 +133,7 @@ Add/Update the `overlay` section of your `relx.config`: [source,erlang] {overlay, [ - {template, "rel/version", "version"} + {template, "config/version", "version"} ]}. When you run `make rel` it creates the file '$(RELX_OUTPUT_DIR)/example/version' diff --git a/docs/en/erlang.mk/1/guide/releases/index.html b/docs/en/erlang.mk/1/guide/releases/index.html index 3224897f..86dc56f1 100644 --- a/docs/en/erlang.mk/1/guide/releases/index.html +++ b/docs/en/erlang.mk/1/guide/releases/index.html @@ -152,7 +152,7 @@ http://www.gnu.org/software/src-highlite --> <p>Your release was upgraded!</p> <h2 id="_getting_relx_semver_value">Getting Relx semver value</h2> <p>There is a <strong>workaround</strong> to get the semver value which is generated by Relx based on VCS history.</p> -<p>Create a file <em>rel/version</em> with only one line inside:</p> +<p>Create a file <em>config/version</em> with only one line inside:</p> <div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it @@ -165,7 +165,7 @@ by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt>{<font color="#FF6600">overlay</font>, [ - {<font color="#FF6600">template</font>, <font color="#FF0000">"rel/version"</font>, <font color="#FF0000">"version"</font>} + {<font color="#FF6600">template</font>, <font color="#FF0000">"config/version"</font>, <font color="#FF0000">"version"</font>} ]}<font color="#990000">.</font></tt></pre> </div></div> <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> diff --git a/docs/en/ranch/1.7/guide/index.html b/docs/en/ranch/1.7/guide/index.html index c18bddee..74208489 100644 --- a/docs/en/ranch/1.7/guide/index.html +++ b/docs/en/ranch/1.7/guide/index.html @@ -87,6 +87,8 @@ <h2 id="_additional_information">Additional information</h2> <ul><li><a href="upcoming_2.0_changes/">Upcoming changes in Ranch 2.0</a> </li> +<li><a href="migrating_from_1.7/">Changes since Ranch 1.7</a> +</li> <li><a href="migrating_from_1.6/">Migrating from Ranch 1.6 to 1.7</a> </li> <li><a href="migrating_from_1.5/">Migrating from Ranch 1.5 to 1.6</a> diff --git a/docs/en/ranch/1.7/guide/migrating_from_1.6/index.html b/docs/en/ranch/1.7/guide/migrating_from_1.6/index.html index 9e87dc6e..1db7386a 100644 --- a/docs/en/ranch/1.7/guide/migrating_from_1.6/index.html +++ b/docs/en/ranch/1.7/guide/migrating_from_1.6/index.html @@ -97,8 +97,8 @@ <nav style="margin:1em 0"> - <a style="float:left" href="https://ninenines.eu/docs/en/ranch/1.7/guide/upcoming_2.0_changes/"> - Upcoming changes in Ranch 2.0 + <a style="float:left" href="https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.7/"> + Changes since Ranch 1.7 </a> diff --git a/docs/en/ranch/1.7/guide/migrating_from_1.7.asciidoc b/docs/en/ranch/1.7/guide/migrating_from_1.7.asciidoc new file mode 100644 index 00000000..a4ce981c --- /dev/null +++ b/docs/en/ranch/1.7/guide/migrating_from_1.7.asciidoc @@ -0,0 +1,14 @@ +[appendix] +== Changes since Ranch 1.7 + +The following patch versions were released since Ranch 1.7: + +=== Ranch 1.7.1 + +This release fixes an issue with the PROXY protocol where +the wrong CRC32 algorithm was used and would cause checksum +verification to fail. + +Because the plain `crc32` checksum is not supported by the +PROXY protocol, the configuration value when building PROXY +headers has been changed to `crc32c`. diff --git a/docs/en/ranch/1.7/guide/migrating_from_1.7/index.html b/docs/en/ranch/1.7/guide/migrating_from_1.7/index.html new file mode 100644 index 00000000..180eb0e8 --- /dev/null +++ b/docs/en/ranch/1.7/guide/migrating_from_1.7/index.html @@ -0,0 +1,169 @@ +<!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"> + + <title>Nine Nines: Changes since Ranch 1.7</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=2" 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="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>Changes since Ranch 1.7</span></h1> + +<p>The following patch versions were released since Ranch 1.7:</p> +<h2 id="_ranch_1_7_1">Ranch 1.7.1</h2> +<p>This release fixes an issue with the PROXY protocol where the wrong CRC32 algorithm was used and would cause checksum verification to fail.</p> +<p>Because the plain <code>crc32</code> checksum is not supported by the PROXY protocol, the configuration value when building PROXY headers has been changed to <code>crc32c</code>.</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/ranch/1.7/guide/upcoming_2.0_changes/"> + Upcoming changes in Ranch 2.0 + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.6/"> + Migrating from Ranch 1.6 to 1.7 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 1.7 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/ranch/1.7/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/1.7/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/1.7/guide">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/guide">1.6</a></li> + + <li><a href="/docs/en/ranch/1.5/guide">1.5</a></li> + + <li><a href="/docs/en/ranch/1.4/guide">1.4</a></li> + + <li><a href="/docs/en/ranch/1.3/guide">1.3</a></li> + + <li><a href="/docs/en/ranch/1.2/guide">1.2</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-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/ranch/1.7/guide/upcoming_2.0_changes/index.html b/docs/en/ranch/1.7/guide/upcoming_2.0_changes/index.html index cfab3a1f..96d78760 100644 --- a/docs/en/ranch/1.7/guide/upcoming_2.0_changes/index.html +++ b/docs/en/ranch/1.7/guide/upcoming_2.0_changes/index.html @@ -97,8 +97,8 @@ - <a style="float:right" href="https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.6/"> - Migrating from Ranch 1.6 to 1.7 + <a style="float:right" href="https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.7/"> + Changes since Ranch 1.7 </a> </nav> diff --git a/docs/en/ranch/1.7/manual/ranch_proxy_header.header/index.html b/docs/en/ranch/1.7/manual/ranch_proxy_header.header/index.html index 1710494c..6fad5c4d 100644 --- a/docs/en/ranch/1.7/manual/ranch_proxy_header.header/index.html +++ b/docs/en/ranch/1.7/manual/ranch_proxy_header.header/index.html @@ -74,7 +74,7 @@ http://www.gnu.org/software/src-highlite --> <font color="#009900">ProxyInfo</font> <font color="#990000">::</font> <b><font color="#000000">ranch_proxy_header:proxy_info</font></b>() <font color="#009900">BuildOpts</font> <font color="#990000">::</font> #{ - <font color="#0000FF">checksum</font> <font color="#990000">=></font> <font color="#FF6600">crc32</font>, + <font color="#0000FF">checksum</font> <font color="#990000">=></font> <font color="#FF6600">crc32c</font>, <font color="#0000FF">padding</font> <font color="#990000">=></font> <b><font color="#000000">pos_integer</font></b>() <i><font color="#9A1900">%% >= 3</font></i> }</tt></pre> </div></div> @@ -119,7 +119,7 @@ by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt><font color="#009900">Data</font> <font color="#990000">=</font> <b><font color="#000000">ranch_proxy_header:parse</font></b>(<font color="#009900">ProxyInfo</font>, #{ - <font color="#0000FF">checksum</font> <font color="#990000">=></font> <font color="#FF6600">crc32</font>, + <font color="#0000FF">checksum</font> <font color="#990000">=></font> <font color="#FF6600">crc32c</font>, <font color="#0000FF">padding</font> <font color="#990000">=></font> <font color="#993399">7</font> })<font color="#990000">.</font></tt></pre> </div></div> |