Permalink
Browse files

Added README note about conditional deps fetch

  • Loading branch information...
1 parent 301ccd2 commit 1460cc100d8c18dd6ef53f9ac1b760364ffea136 @uwiger uwiger committed Jan 11, 2013
Showing with 49 additions and 13 deletions.
  1. +25 −13 README.md
  2. +12 −0 doc/README.md
  3. +12 −0 doc/overview.edoc
View
@@ -7,6 +7,18 @@ __Authors:__ Ulf Wiger ([`ulf.wiger@erlang-solutions.com`](mailto:ulf.wiger@erla
Extended process dictionary
+##Note##
+
+
+Gproc has two dependencies: `gen_leader` and `edown`. Since most people don't
+actively use either, they are no longer fetched by default.
+* To enable fetching of `gen_leader`, export the OS environment variable`GPROC_DIST=true` (this can be done e.g. from a GNU Makefile)
+
+* `edown` is fetched on-demand whenver `rebar get-deps doc` is called (which
+ happens when you call `make doc`)
+
+
+
##Introduction##
@@ -62,8 +74,8 @@ alternative sources, and cache them for efficient lookup. Caching also provides
a way to see which processes rely on certain configuration values, as well as
which values they actually ended up using.
-See [`gproc:get_env/4`](http://github.com/esl/gproc/blob/0.2.14/doc/gproc.md#get_env-4), [`gproc:get_set_env/4`](http://github.com/esl/gproc/blob/0.2.14/doc/gproc.md#get_set_env-4) and
-[`gproc:set_env/5`](http://github.com/esl/gproc/blob/0.2.14/doc/gproc.md#set_env-5) for details.
+See [`gproc:get_env/4`](http://github.com/esl/gproc/blob/master/doc/gproc.md#get_env-4), [`gproc:get_set_env/4`](http://github.com/esl/gproc/blob/master/doc/gproc.md#get_set_env-4) and
+[`gproc:set_env/5`](http://github.com/esl/gproc/blob/master/doc/gproc.md#set_env-5) for details.
##Testing##
@@ -82,21 +94,21 @@ global gproc.
By default, `./rebar doc` generates Github-flavored Markdown files.
If you want to change this, remove the `edoc_opts` line from `rebar.config`.Gproc was first introduced at the ACM SIGPLAN Erlang Workshop in
-Freiburg 2007 ([Paper available here](http://github.com/esl/gproc/blob/0.2.14/doc/erlang07-wiger.pdf)).
+Freiburg 2007 ([Paper available here](http://github.com/esl/gproc/blob/master/doc/erlang07-wiger.pdf)).
##Modules##
<table width="100%" border="0" summary="list of modules">
-<tr><td><a href="http://github.com/esl/gproc/blob/0.2.14/doc/gproc.md" class="module">gproc</a></td></tr>
-<tr><td><a href="http://github.com/esl/gproc/blob/0.2.14/doc/gproc_app.md" class="module">gproc_app</a></td></tr>
-<tr><td><a href="http://github.com/esl/gproc/blob/0.2.14/doc/gproc_bcast.md" class="module">gproc_bcast</a></td></tr>
-<tr><td><a href="http://github.com/esl/gproc/blob/0.2.14/doc/gproc_dist.md" class="module">gproc_dist</a></td></tr>
-<tr><td><a href="http://github.com/esl/gproc/blob/0.2.14/doc/gproc_info.md" class="module">gproc_info</a></td></tr>
-<tr><td><a href="http://github.com/esl/gproc/blob/0.2.14/doc/gproc_init.md" class="module">gproc_init</a></td></tr>
-<tr><td><a href="http://github.com/esl/gproc/blob/0.2.14/doc/gproc_lib.md" class="module">gproc_lib</a></td></tr>
-<tr><td><a href="http://github.com/esl/gproc/blob/0.2.14/doc/gproc_monitor.md" class="module">gproc_monitor</a></td></tr>
-<tr><td><a href="http://github.com/esl/gproc/blob/0.2.14/doc/gproc_ps.md" class="module">gproc_ps</a></td></tr>
-<tr><td><a href="http://github.com/esl/gproc/blob/0.2.14/doc/gproc_sup.md" class="module">gproc_sup</a></td></tr></table>
+<tr><td><a href="http://github.com/esl/gproc/blob/master/doc/gproc.md" class="module">gproc</a></td></tr>
+<tr><td><a href="http://github.com/esl/gproc/blob/master/doc/gproc_app.md" class="module">gproc_app</a></td></tr>
+<tr><td><a href="http://github.com/esl/gproc/blob/master/doc/gproc_bcast.md" class="module">gproc_bcast</a></td></tr>
+<tr><td><a href="http://github.com/esl/gproc/blob/master/doc/gproc_dist.md" class="module">gproc_dist</a></td></tr>
+<tr><td><a href="http://github.com/esl/gproc/blob/master/doc/gproc_info.md" class="module">gproc_info</a></td></tr>
+<tr><td><a href="http://github.com/esl/gproc/blob/master/doc/gproc_init.md" class="module">gproc_init</a></td></tr>
+<tr><td><a href="http://github.com/esl/gproc/blob/master/doc/gproc_lib.md" class="module">gproc_lib</a></td></tr>
+<tr><td><a href="http://github.com/esl/gproc/blob/master/doc/gproc_monitor.md" class="module">gproc_monitor</a></td></tr>
+<tr><td><a href="http://github.com/esl/gproc/blob/master/doc/gproc_ps.md" class="module">gproc_ps</a></td></tr>
+<tr><td><a href="http://github.com/esl/gproc/blob/master/doc/gproc_sup.md" class="module">gproc_sup</a></td></tr></table>
View
@@ -7,6 +7,18 @@ __Authors:__ Ulf Wiger ([`ulf.wiger@erlang-solutions.com`](mailto:ulf.wiger@erla
Extended process dictionary
+##Note##
+
+
+Gproc has two dependencies: `gen_leader` and `edown`. Since most people don't
+actively use either, they are no longer fetched by default.
+* To enable fetching of `gen_leader`, export the OS environment variable`GPROC_DIST=true` (this can be done e.g. from a GNU Makefile)
+
+* `edown` is fetched on-demand whenver `rebar get-deps doc` is called (which
+ happens when you call `make doc`)
+
+
+
##Introduction##
View
@@ -3,6 +3,18 @@
@doc Extended process dictionary
+<h2>Note</h2>
+
+Gproc has two dependencies: `gen_leader' and `edown'. Since most people don't
+actively use either, they are no longer fetched by default.
+
+<ul>
+<li>To enable fetching of `gen_leader', export the OS environment variable
+ `GPROC_DIST=true' (this can be done e.g. from a GNU Makefile)</li>
+<li>`edown' is fetched on-demand whenver `rebar get-deps doc' is called (which
+ happens when you call `make doc')</li>
+</ul>
+
<h2>Introduction</h2>
Gproc is a process dictionary for Erlang, which provides a number of useful features beyond what the built-in dictionary has:

0 comments on commit 1460cc1

Please sign in to comment.