From aab8156f22f62c11bbd0cf83d40be385c6411b3d Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Tue, 4 Mar 2014 15:06:53 +0100 Subject: stdlib: Improve the doc of the supervisor's via reference Most of the updates have already been made in 'Fix alternative registry type annotations in supervisor', a5412706f4185fddbac29216a49affd1e9f11da0. Thanks to MaximMinin. --- lib/stdlib/doc/src/supervisor.xml | 6 +++--- lib/stdlib/src/gen.erl | 6 ++++-- 2 files changed, 7 insertions(+), 5 deletions(-) (limited to 'lib/stdlib') diff --git a/lib/stdlib/doc/src/supervisor.xml b/lib/stdlib/doc/src/supervisor.xml index 8197684d2d..3a5027d595 100644 --- a/lib/stdlib/doc/src/supervisor.xml +++ b/lib/stdlib/doc/src/supervisor.xml @@ -4,7 +4,7 @@
- 19962013 + 19962014 Ericsson AB. All Rights Reserved. @@ -262,12 +262,12 @@ child_spec() = {Id,StartFunc,Restart,Shutdown,Type,Modules} locally as Name using register/2. If SupName={global,Name} the supervisor is registered globally as Name using global:register_name/2. If - SupName={via,Module,Name} the supervisor + SupName={via,Module,Name} the supervisor is registered as Name using the registry represented by Module. The Module callback should export the functions register_name/2, unregister_name/1 and send/2, which should behave like the corresponding functions in global. - Thus, {via,global,Name} is a valid reference.

+ Thus, {via,global,Name} is a valid reference.

If no name is provided, the supervisor is not registered.

Module is the name of the callback module.

Args is an arbitrary term which is passed as diff --git a/lib/stdlib/src/gen.erl b/lib/stdlib/src/gen.erl index 7281549ea7..63116fa16e 100644 --- a/lib/stdlib/src/gen.erl +++ b/lib/stdlib/src/gen.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 1996-2013. All Rights Reserved. +%% Copyright Ericsson AB 1996-2014. All Rights Reserved. %% %% The contents of this file are subject to the Erlang Public License, %% Version 1.1, (the "License"); you may not use this file except in @@ -37,7 +37,9 @@ %%----------------------------------------------------------------- -type linkage() :: 'link' | 'nolink'. --type emgr_name() :: {'local', atom()} | {'global', term()} | {via, atom(), term()}. +-type emgr_name() :: {'local', atom()} + | {'global', term()} + | {'via', Module :: module(), Name :: term()}. -type start_ret() :: {'ok', pid()} | 'ignore' | {'error', term()}. -- cgit v1.2.3