aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTristan Sloughter <[email protected]>2013-09-21 14:37:35 -0500
committerTristan Sloughter <[email protected]>2013-09-21 14:37:35 -0500
commit4eb9311016cb9a885694819acdc22816186fce59 (patch)
tree872fd476fa97f4b62d090cd27c8eb05c706c5d44
parentd74834732981b416209eb3f6739b630e9904f14e (diff)
downloadrelx-4eb9311016cb9a885694819acdc22816186fce59.tar.gz
relx-4eb9311016cb9a885694819acdc22816186fce59.tar.bz2
relx-4eb9311016cb9a885694819acdc22816186fce59.zip
fix highlighting
-rw-r--r--configuration/index.md20
-rw-r--r--overlays/index.md2
-rw-r--r--overview/index.md7
3 files changed, 17 insertions, 12 deletions
diff --git a/configuration/index.md b/configuration/index.md
index 22e41b9..08c209a 100644
--- a/configuration/index.md
+++ b/configuration/index.md
@@ -19,7 +19,7 @@ App directories specify where `relx` will search for OTP applications to resolve
The app directory configuration element looks as follows:
-{% highlight erl %}
+{% highlight erlang %}
{lib_dirs, [<path1>, <path2>, ...]}.
{% endhighlight %}
@@ -33,14 +33,14 @@ provide a non-resolvable path for additional providers.
The path configuration element looks as follows:
-{% highlight erl %}
+{% highlight erlang %}
{paths, [<list of directory paths>]}.
{% endhighlight %}
So if we wanted to add `/usr/local/lib` and `/opt/lib` to the code
paths for the system we could add the following:
-{% highlight erl %}
+{% highlight erlang %}
{paths, ["/usr/local/lib", "/opt/lib"]}.
{% endhighlight %}
@@ -58,7 +58,7 @@ differences. The first is that you don't have to specify a complete
list of applications and you may specify version constraints instead
of hard versions.
-{% highlight erl %}
+{% highlight erlang %}
{release, {relname, vsn},
<app goals>}
{release, {relname, vsn},
@@ -76,7 +76,7 @@ release. However, there may be times when you want to provide a custom
start script. In those situations you may disable automatic start
script creation by adding the following to your `relx.config`.
-{% highlight erl %}
+{% highlight erlang %}
{generate_start_script, false}.
{% endhighlight %}
@@ -105,7 +105,7 @@ The `providers` element provides a completely new list of providers,
replacing any providers that may already exist. The provider element
is as follows:
-{% highlight erl %}
+{% highlight erlang %}
{providers, <list of module names>}.
{% endhighlight %}
@@ -113,7 +113,7 @@ Lets say I have three providers; `my_custom_assembler`,
`my_rpm_assembler` and `my_deb_assembler`. I could make these the
complete list of providers by doing the following in my config:
-{% highlight erl %}
+{% highlight erlang %}
{providers, [my_custom_assembler,
my_rpm_assembler,
my_deb_assembler]}.
@@ -129,7 +129,7 @@ the listed providers are added to the end of the current list of
providers rather then replacing the list all together. Add providres
looks as follows::
-{% highlight erl %}
+{% highlight erlang %}
{add_providers, <list of module names>}.
{% endhighlight %}
@@ -137,7 +137,7 @@ Lets take our previous example but only add `my_rpm_assembler` and
`my_deb_assembler` to the existing list of providers. We do this by
adding the following::
-{% highlight erl %}
+{% highlight erlang %}
{add_providers, [my_rpm_assembler,
my_deb_assembler]}.
{% endhighlight %}
@@ -145,7 +145,7 @@ adding the following::
Example Configuration
---------------------
-{% highlight erl %}
+{% highlight erlang %}
%% -*- mode: Erlang; fill-column: 80; comment-column: 75; -*-
%% Example Relx Config
%% ======================
diff --git a/overlays/index.md b/overlays/index.md
index dece340..863ae28 100644
--- a/overlays/index.md
+++ b/overlays/index.md
@@ -11,7 +11,7 @@ can take your Overlay configuration and move it to your
`relx.config` and it should just work. For example, you could take
the following:
-{% highlight erl %}
+{% highlight erlang %}
{overlay_vars, "vars.config"}.
{overlay, [{mkdir, "log/sasl"},
{copy, "files/erl", "{{erts_vsn}}/bin/erl"},
diff --git a/overview/index.md b/overview/index.md
index 66e1a5f..c00ac71 100644
--- a/overview/index.md
+++ b/overview/index.md
@@ -16,6 +16,7 @@ work in package management systems. So lets look at an example.
Lets say that you have the following OTP Applications
+{% highlight erlang %}
app1-1.2
with dependencies
app2
@@ -39,26 +40,30 @@ Lets say that you have the following OTP Applications
with dependencies
app3
app7-2.0
+{% endhighlight %}
This is the world of OTP Apps your Relx knows about (basically OTP
Apps in the Library Directories you have specified). You have set a
config that looks like the following:
+{% highlight erlang %}
{release, {awesome_supercool, "1.0"},
[{app1, "1.3", '>='},
{app2, "2.0", '>'},
app3]}
+{% endhighlight %}
When the Relx process has run you will end up with a complete
release as follows
+{% highlight erlang %}
{release, {awesome_supercool, "1.0"},
[{app1, "1.3"},
{app2, "2.1"},
{app3, "2.0"},
{app6, "1.0"},
{app7, "2.0"}]}
-
+{% endhighlight %}
As you can see that is a fully realied view of your direct and
transative dependencies based on the world that Relx knows about
and the constraints that you specified in your configuration.