diff options
112 files changed, 3331 insertions, 5328 deletions
diff --git a/Makefile.in b/Makefile.in index 7596a82720..8e97edfd84 100644 --- a/Makefile.in +++ b/Makefile.in @@ -214,14 +214,15 @@ endif # --------------------------------------------------------------- # Target only used when building commercial ERTS patches # --------------------------------------------------------------- -release_docs: +release_docs docs: ifeq ($(OTP_SMALL_BUILD),true) - cd $(ERL_TOP)/lib && $(MAKE) TESTROOT=$(RELEASE_ROOT) release_docs + cd $(ERL_TOP)/lib && $(MAKE) TESTROOT=$(RELEASE_ROOT) $@ else - cd $(ERL_TOP)/lib && $(MAKE) BUILD_ALL=1 TESTROOT=$(RELEASE_ROOT) release_docs - cd $(ERL_TOP)/lib/dialyzer && $(MAKE) BUILD_ALL=1 TESTROOT=$(RELEASE_ROOT) release_docs + cd $(ERL_TOP)/lib && $(MAKE) BUILD_ALL=1 TESTROOT=$(RELEASE_ROOT) $@ + cd $(ERL_TOP)/lib/dialyzer && $(MAKE) BUILD_ALL=1 TESTROOT=$(RELEASE_ROOT) $@ endif - cd $(ERL_TOP)/erts && $(MAKE) BUILD_ALL=1 TESTROOT=$(RELEASE_ROOT) release_docs + cd $(ERL_TOP)/erts && $(MAKE) BUILD_ALL=1 TESTROOT=$(RELEASE_ROOT) $@ + cd $(ERL_TOP)/system/doc && $(MAKE) TESTROOT=$(RELEASE_ROOT) $@ # ---------------------------------------------------------------------- @@ -730,6 +731,11 @@ bootstrap_nc_for_ne_no_debug_sym: # install: install.dirs install.emulator install.libs install.Install install.bin +install-docs: + ERL_TOP=$(ERL_TOP) INSTALLROOT=$(ERLANG_LIBDIR) PATH=$(BOOT_PREFIX)$${PATH} \ + $(MAKE) RELEASE_ROOT=$(ERLANG_LIBDIR) release_docs + + install.emulator: cd erts && \ ERL_TOP=$(ERL_TOP) PATH=$(BOOT_PREFIX)$${PATH} \ diff --git a/erts/doc/src/erl.xml b/erts/doc/src/erl.xml index 6f5dd248ce..b01d187b01 100644 --- a/erts/doc/src/erl.xml +++ b/erts/doc/src/erl.xml @@ -410,7 +410,7 @@ <tag><c><![CDATA[-setcookie Cookie]]></c></tag> <item> <p>Sets the magic cookie of the node to <c><![CDATA[Cookie]]></c>, see - <seealso marker="erlang#erlang:set_cookie/2">erlang:set_cookie/2</seealso>.</p> + <seealso marker="erlang#set_cookie/2">erlang:set_cookie/2</seealso>.</p> </item> <tag><c><![CDATA[-shutdown_time Time]]></c></tag> <item> diff --git a/erts/doc/src/erl_driver.xml b/erts/doc/src/erl_driver.xml index 0b11f4bbcb..5d7a11b70a 100644 --- a/erts/doc/src/erl_driver.xml +++ b/erts/doc/src/erl_driver.xml @@ -4,7 +4,7 @@ <cref> <header> <copyright> - <year>2001</year><year>2009</year> + <year>2001</year><year>2010</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -13,12 +13,12 @@ compliance with the License. You should have received a copy of the Erlang Public License along with this software. If not, it can be retrieved online at http://www.erlang.org/. - + Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License. - + </legalnotice> <title>erl_driver</title> @@ -1292,7 +1292,7 @@ typedef struct ErlIOVec { has been set in the <seealso marker="driver_entry">driver_entry</seealso>, data can be forced into the driver via - <seealso marker="erlang#erlang:port_command/3">port_command(Port, Data, [force])</seealso> + <seealso marker="erlang#port_command/3">port_command(Port, Data, [force])</seealso> even though the driver has signaled that it is busy. </p> </desc> diff --git a/erts/doc/src/erl_nif.xml b/erts/doc/src/erl_nif.xml index 2033ba8a66..2902d70976 100644 --- a/erts/doc/src/erl_nif.xml +++ b/erts/doc/src/erl_nif.xml @@ -148,7 +148,7 @@ ok that the library needs in able to keep a state between NIF calls. <c>enif_get_data()</c> will return this pointer.</p> <p><c>load_info</c> is the second argument to <seealso - marker="erlang#erlang:load_nif-2">erlang:load_nif/2</seealso>.</p> + marker="erlang#load_nif-2">erlang:load_nif/2</seealso>.</p> <p>The library will fail to load if <c>load</c> returns anything other than 0. <c>load</c> can be NULL in case no initialization is needed.</p> @@ -397,7 +397,7 @@ typedef struct { </funcs> <section> <title>SEE ALSO</title> - <p><seealso marker="erlang#erlang:load_nif-2">load_nif(3)</seealso></p> + <p><seealso marker="erlang#load_nif-2">load_nif(3)</seealso></p> </section> </cref> diff --git a/erts/doc/src/erlang.xml b/erts/doc/src/erlang.xml index 28b040a441..207aabca35 100644 --- a/erts/doc/src/erlang.xml +++ b/erts/doc/src/erlang.xml @@ -452,19 +452,19 @@ iolist() = [char() | binary() | iolist()] <desc> <p>Cancels a timer, where <c>TimerRef</c> was returned by either - <seealso marker="#erlang:send_after/3">erlang:send_after/3</seealso> + <seealso marker="#send_after/3">erlang:send_after/3</seealso> or - <seealso marker="#erlang:start_timer/3">erlang:start_timer/3</seealso>. + <seealso marker="#start_timer/3">erlang:start_timer/3</seealso>. If the timer is there to be removed, the function returns the time in milliseconds left until the timer would have expired, otherwise <c>false</c> (which means that <c>TimerRef</c> was never a timer, that it has already been cancelled, or that it has already delivered its message).</p> <p>See also - <seealso marker="#erlang:send_after/3">erlang:send_after/3</seealso>, - <seealso marker="#erlang:start_timer/3">erlang:start_timer/3</seealso>, + <seealso marker="#send_after/3">erlang:send_after/3</seealso>, + <seealso marker="#start_timer/3">erlang:start_timer/3</seealso>, and - <seealso marker="#erlang:read_timer/1">erlang:read_timer/1</seealso>.</p> + <seealso marker="#read_timer/1">erlang:read_timer/1</seealso>.</p> <p>Note: Cancelling a timer does not guarantee that the message has not already been delivered to the message queue.</p> </desc> @@ -715,7 +715,7 @@ false</pre> <desc> <p>If <c>MonitorRef</c> is a reference which the calling process obtained by calling - <seealso marker="#erlang:monitor/2">erlang:monitor/2</seealso>, + <seealso marker="#monitor/2">erlang:monitor/2</seealso>, this monitoring is turned off. If the monitoring is already turned off, nothing happens.</p> <p>Once <c>erlang:demonitor(MonitorRef)</c> has returned it is @@ -726,7 +726,7 @@ false</pre> the call, though. Therefore, in most cases, it is advisable to remove such a <c>'DOWN'</c> message from the message queue after monitoring has been stopped. - <seealso marker="#erlang:demonitor/2">erlang:demonitor(MonitorRef, [flush])</seealso> can be used instead of + <seealso marker="#demonitor/2">erlang:demonitor(MonitorRef, [flush])</seealso> can be used instead of <c>erlang:demonitor(MonitorRef)</c> if this cleanup is wanted.</p> <note> <p>Prior to OTP release R11B (erts version 5.5) <c>erlang:demonitor/1</c> @@ -760,7 +760,7 @@ false</pre> of <c>OptionList</c>. </p> <p><c>erlang:demonitor(MonitorRef, [])</c> is equivalent to - <seealso marker="#erlang:demonitor/1">erlang:demonitor(MonitorRef)</seealso>.</p> + <seealso marker="#demonitor/1">erlang:demonitor(MonitorRef)</seealso>.</p> <p>Currently the following <c>Option</c>s are valid:</p> <taglist> <tag><c>flush</c></tag> @@ -810,7 +810,7 @@ false</pre> </note> <p>Failure: <c>badarg</c> if <c>OptionList</c> is not a list, or if <c>Option</c> is not a valid option, or the same failure as for - <seealso marker="#erlang:demonitor/1">erlang:demonitor/1</seealso></p> + <seealso marker="#demonitor/1">erlang:demonitor/1</seealso></p> </desc> </func> <func> @@ -1129,7 +1129,7 @@ b</pre> <c>uniq</c>, and <c>pid</c>. For an external fun, the value of any of these items is always the atom <c>undefined</c>.</p> <p>See - <seealso marker="#erlang:fun_info/1">erlang:fun_info/1</seealso>.</p> + <seealso marker="#fun_info/1">erlang:fun_info/1</seealso>.</p> </desc> </func> <func> @@ -1275,8 +1275,8 @@ b</pre> returns, for example:</p> <p><c>{'EXIT',{badarg,Stacktrace}} = catch abs(x)</c></p> <p>See also - <seealso marker="#erlang:error/1">erlang:error/1</seealso> and - <seealso marker="#erlang:error/2">erlang:error/2</seealso>.</p> + <seealso marker="#error/1">erlang:error/1</seealso> and + <seealso marker="#error/2">erlang:error/2</seealso>.</p> </desc> </func> <func> @@ -2387,7 +2387,7 @@ os_prompt%</pre> <item> If <c>Type</c> is not one of the memory types listed in the documentation of - <seealso marker="#erlang:memory/0">erlang:memory/0</seealso>. + <seealso marker="#memory/0">erlang:memory/0</seealso>. </item> <tag><c>badarg</c></tag> <item> @@ -2401,7 +2401,7 @@ os_prompt%</pre> </item> </taglist> <p>See also - <seealso marker="#erlang:memory/0">erlang:memory/0</seealso>.</p> + <seealso marker="#memory/0">erlang:memory/0</seealso>.</p> </desc> </func> <func> @@ -2510,7 +2510,7 @@ os_prompt%</pre> </note> <p>The monitoring is turned off either when the <c>'DOWN'</c> message is sent, or when - <seealso marker="#erlang:demonitor/1">erlang:demonitor/1</seealso> + <seealso marker="#demonitor/1">erlang:demonitor/1</seealso> is called.</p> <p>If an attempt is made to monitor a process on an older node (where remote process monitoring is not implemented or one @@ -3379,7 +3379,7 @@ os_prompt%</pre> registered name, [] is returned.</p> <p>For valid values of <c>Item</c>, and corresponding values of <c>Info</c>, see - <seealso marker="#erlang:port_info/1">erlang:port_info/1</seealso>.</p> + <seealso marker="#port_info/1">erlang:port_info/1</seealso>.</p> <p>Failure: <c>badarg</c> if <c>Port</c> is not a local port.</p> </desc> </func> @@ -3868,9 +3868,9 @@ os_prompt%</pre> ActiveSuspendCount, OutstandingSuspendCount}</c> tuples. <c>Suspendee</c> is the pid of a process that have been or is to be suspended by the process identified by <c>Pid</c> via the - <seealso marker="#erlang:suspend_process/2">erlang:suspend_process/2</seealso> + <seealso marker="#suspend_process/2">erlang:suspend_process/2</seealso> BIF, or the - <seealso marker="#erlang:suspend_process/1">erlang:suspend_process/1</seealso> + <seealso marker="#suspend_process/1">erlang:suspend_process/1</seealso> BIF. <c>ActiveSuspendCount</c> is the number of times the <c>Suspendee</c> has been suspended by <c>Pid</c>. <c>OutstandingSuspendCount</c> is the number of not yet @@ -4021,19 +4021,19 @@ os_prompt%</pre> </type> <desc> <p><c>TimerRef</c> is a timer reference returned by - <seealso marker="#erlang:send_after/3">erlang:send_after/3</seealso> + <seealso marker="#send_after/3">erlang:send_after/3</seealso> or - <seealso marker="#erlang:start_timer/3">erlang:start_timer/3</seealso>. + <seealso marker="#start_timer/3">erlang:start_timer/3</seealso>. If the timer is active, the function returns the time in milliseconds left until the timer will expire, otherwise <c>false</c> (which means that <c>TimerRef</c> was never a timer, that it has been cancelled, or that it has already delivered its message).</p> <p>See also - <seealso marker="#erlang:send_after/3">erlang:send_after/3</seealso>, - <seealso marker="#erlang:start_timer/3">erlang:start_timer/3</seealso>, + <seealso marker="#send_after/3">erlang:send_after/3</seealso>, + <seealso marker="#start_timer/3">erlang:start_timer/3</seealso>, and - <seealso marker="#erlang:cancel_timer/1">erlang:cancel_timer/1</seealso>.</p> + <seealso marker="#cancel_timer/1">erlang:cancel_timer/1</seealso>.</p> </desc> </func> <func> @@ -4098,9 +4098,9 @@ true</pre> <p>Decreases the suspend count on the process identified by <c>Suspendee</c>. <c>Suspendee</c> should previously have been suspended via - <seealso marker="#erlang:suspend_process/2">erlang:suspend_process/2</seealso>, + <seealso marker="#suspend_process/2">erlang:suspend_process/2</seealso>, or - <seealso marker="#erlang:suspend_process/1">erlang:suspend_process/1</seealso> + <seealso marker="#suspend_process/1">erlang:suspend_process/1</seealso> by the process calling <c>erlang:resume_process(Suspendee)</c>. When the suspend count on <c>Suspendee</c> reach zero, <c>Suspendee</c> will be resumed, i.e., the state of the <c>Suspendee</c> is changed @@ -4186,9 +4186,9 @@ true</pre> <p>Sends a message and returns <c>ok</c>, or does not send the message but returns something else (see below). Otherwise the same as - <seealso marker="#erlang:send/2">erlang:send/2</seealso>. See + <seealso marker="#send/2">erlang:send/2</seealso>. See also - <seealso marker="#erlang:send_nosuspend/2">erlang:send_nosuspend/2,3</seealso>. + <seealso marker="#send_nosuspend/2">erlang:send_nosuspend/2,3</seealso>. for more detailed explanation and warnings.</p> <p>The possible options are:</p> <taglist> @@ -4234,10 +4234,10 @@ true</pre> erts version 5.4.11. Note that timers will not be automatically canceled when <c>Dest</c> is an atom.</p> <p>See also - <seealso marker="#erlang:start_timer/3">erlang:start_timer/3</seealso>, - <seealso marker="#erlang:cancel_timer/1">erlang:cancel_timer/1</seealso>, + <seealso marker="#start_timer/3">erlang:start_timer/3</seealso>, + <seealso marker="#cancel_timer/1">erlang:cancel_timer/1</seealso>, and - <seealso marker="#erlang:read_timer/1">erlang:read_timer/1</seealso>.</p> + <seealso marker="#read_timer/1">erlang:read_timer/1</seealso>.</p> <p>Failure: <c>badarg</c> if the arguments does not satisfy the requirements specified above.</p> </desc> @@ -4253,7 +4253,7 @@ true</pre> </type> <desc> <p>The same as - <seealso marker="#erlang:send/3">erlang:send(Dest, Msg, [nosuspend])</seealso>, but returns <c>true</c> if + <seealso marker="#send/3">erlang:send(Dest, Msg, [nosuspend])</seealso>, but returns <c>true</c> if the message was sent and <c>false</c> if the message was not sent because the sender would have had to be suspended.</p> <p>This function is intended for send operations towards an @@ -4305,10 +4305,10 @@ true</pre> </type> <desc> <p>The same as - <seealso marker="#erlang:send/3">erlang:send(Dest, Msg, [nosuspend | Options])</seealso>, + <seealso marker="#send/3">erlang:send(Dest, Msg, [nosuspend | Options])</seealso>, but with boolean return value.</p> <p>This function behaves like - <seealso marker="#erlang:send_nosuspend/2">erlang:send_nosuspend/2)</seealso>, + <seealso marker="#send_nosuspend/2">erlang:send_nosuspend/2)</seealso>, but takes a third parameter, a list of options. The only currently implemented option is <c>noconnect</c>. The option <c>noconnect</c> makes the function return <c>false</c> if @@ -4610,7 +4610,7 @@ true</pre> <tag><c>monitor</c></tag> <item> <p>Monitor the new process (just like - <seealso marker="#erlang:monitor/2">erlang:monitor/2</seealso> does).</p> + <seealso marker="#monitor/2">erlang:monitor/2</seealso> does).</p> </item> <tag><c>{priority, Level}</c></tag> <item> @@ -4653,7 +4653,7 @@ true</pre> and no virtual memory, one might want to preserve memory by setting <c>Number</c> to zero. (The value may be set globally, see - <seealso marker="#erlang:system_flag/2">erlang:system_flag/2</seealso>.)</p> + <seealso marker="#system_flag/2">erlang:system_flag/2</seealso>.)</p> </item> <tag><c>{min_heap_size, Size}</c></tag> <item> @@ -4764,10 +4764,10 @@ true</pre> erts version 5.4.11. Note that timers will not be automatically canceled when <c>Dest</c> is an atom.</p> <p>See also - <seealso marker="#erlang:send_after/3">erlang:send_after/3</seealso>, - <seealso marker="#erlang:cancel_timer/1">erlang:cancel_timer/1</seealso>, + <seealso marker="#send_after/3">erlang:send_after/3</seealso>, + <seealso marker="#cancel_timer/1">erlang:cancel_timer/1</seealso>, and - <seealso marker="#erlang:read_timer/1">erlang:read_timer/1</seealso>.</p> + <seealso marker="#read_timer/1">erlang:read_timer/1</seealso>.</p> <p>Failure: <c>badarg</c> if the arguments does not satisfy the requirements specified above.</p> </desc> @@ -4872,7 +4872,7 @@ true</pre> process will not leave the suspended state until its suspend count reach zero. The suspend count of <c>Suspendee</c> is decreased when - <seealso marker="#erlang:resume_process/1">erlang:resume_process(Suspendee)</seealso> + <seealso marker="#resume_process/1">erlang:resume_process(Suspendee)</seealso> is called by the same process that called <c>erlang:suspend_process(Suspendee)</c>. All increased suspend counts on other processes acquired by a process will automatically be @@ -4961,7 +4961,7 @@ true</pre> <desc> <p>Suspends the process identified by <c>Suspendee</c>. The same as calling - <seealso marker="#erlang:suspend_process/2">erlang:suspend_process(Suspendee, [])</seealso>. For more information see the documentation of <seealso marker="#erlang:suspend_process/2">erlang:suspend_process/2</seealso>. + <seealso marker="#suspend_process/2">erlang:suspend_process(Suspendee, [])</seealso>. For more information see the documentation of <seealso marker="#suspend_process/2">erlang:suspend_process/2</seealso>. </p> <warning> <p>This BIF is intended for debugging only.</p> @@ -5272,7 +5272,7 @@ true</pre> Some values are part of other values, and some memory areas are not part of the result. If you are interested in the total amount of memory allocated by the emulator - see <seealso marker="#erlang:memory/0">erlang:memory/0,1</seealso>.</p> + see <seealso marker="#memory/0">erlang:memory/0,1</seealso>.</p> </item> <tag><c>allocator</c></tag> <item> @@ -5587,7 +5587,7 @@ true</pre> <c>spawn</c> or <c>spawn_link</c> will use these garbage collection settings. The default settings can be changed by use of - <seealso marker="#erlang:system_flag/2">system_flag/2</seealso>. + <seealso marker="#system_flag/2">system_flag/2</seealso>. <seealso marker="#spawn_opt/4">spawn_opt/4</seealso> can spawn a process that does not use the default settings.</p> @@ -5900,7 +5900,7 @@ true</pre> </type> <desc> <p>Returns the current system monitoring settings set by - <seealso marker="#erlang:system_monitor/2">erlang:system_monitor/2</seealso> + <seealso marker="#system_monitor/2">erlang:system_monitor/2</seealso> as <c>{MonitorPid, Options}</c>, or <c>undefined</c> if there are no settings. The order of the options may be different from the one that was set.</p> @@ -5918,9 +5918,9 @@ true</pre> system performance monitoring settings are cleared.</p> <p>Calling the function with <c>{MonitorPid, Options}</c> as argument, is the same as calling - <seealso marker="#erlang:system_monitor/2">erlang:system_monitor(MonitorPid, Options)</seealso>.</p> + <seealso marker="#system_monitor/2">erlang:system_monitor(MonitorPid, Options)</seealso>.</p> <p>Returns the previous system monitor settings just like - <seealso marker="#erlang:system_monitor/0">erlang:system_monitor/0</seealso>.</p> + <seealso marker="#system_monitor/0">erlang:system_monitor/0</seealso>.</p> </desc> </func> @@ -5956,7 +5956,7 @@ true</pre> explained in the documentation of the <seealso marker="#gc_start">gc_start</seealso> trace message (see - <seealso marker="#erlang:trace/3">erlang:trace/3</seealso>). + <seealso marker="#trace/3">erlang:trace/3</seealso>). New tuples may be added, and the order of the tuples in the <c>Info</c> list may be changed at any time without prior notice. @@ -5998,7 +5998,7 @@ true</pre> </item> </taglist> <p>Returns the previous system monitor settings just like - <seealso marker="#erlang:system_monitor/0">erlang:system_monitor/0</seealso>.</p> + <seealso marker="#system_monitor/0">erlang:system_monitor/0</seealso>.</p> <note> <p>If a monitoring process gets so large that it itself starts to cause system monitor messages when garbage @@ -6022,7 +6022,7 @@ true</pre> </type> <desc> <p>Returns the current system profiling settings set by - <seealso marker="#erlang:system_profile/2">erlang:system_profile/2</seealso> + <seealso marker="#system_profile/2">erlang:system_profile/2</seealso> as <c>{ProfilerPid, Options}</c>, or <c>undefined</c> if there are no settings. The order of the options may be different from the one that was set.</p> @@ -6250,7 +6250,7 @@ true</pre> <item> <p>Trace certain function calls. Specify which function calls to trace by calling - <seealso marker="#erlang:trace_pattern/3">erlang:trace_pattern/3</seealso>.</p> + <seealso marker="#trace_pattern/3">erlang:trace_pattern/3</seealso>.</p> <p>Message tags: <c>call</c>, <c>return_from</c>.</p> </item> <tag><c>silent</c></tag> @@ -6279,7 +6279,7 @@ true</pre> Trace the actual return from a traced function back to its caller. Only works for functions traced with the <c>local</c> option to - <seealso marker="#erlang:trace_pattern/3">erlang:trace_pattern/3</seealso>.</p> + <seealso marker="#trace_pattern/3">erlang:trace_pattern/3</seealso>.</p> <p>The semantics is that a trace message is sent when a call traced function actually returns, that is, when a chain of tail recursive calls is ended. There will be @@ -6667,7 +6667,7 @@ true</pre> <c>true</c> for the pseudo function <c>on_load</c> if call count tracing is active. Return <c>false</c> otherwise. See also - <seealso marker="#erlang:trace_pattern/3">erlang:trace_pattern/3</seealso>.</p> + <seealso marker="#trace_pattern/3">erlang:trace_pattern/3</seealso>.</p> </item> <tag><c>all</c></tag> <item> @@ -6690,7 +6690,7 @@ true</pre> <fsummary>Set trace patterns for global call tracing</fsummary> <desc> <p>The same as - <seealso marker="#erlang:trace_pattern/3">erlang:trace_pattern(MFA, MatchSpec, [])</seealso>, + <seealso marker="#trace_pattern/3">erlang:trace_pattern(MFA, MatchSpec, [])</seealso>, retained for backward compatibility.</p> </desc> </func> @@ -6703,7 +6703,7 @@ true</pre> <desc> <p>This BIF is used to enable or disable call tracing for exported functions. It must be combined with - <seealso marker="#erlang:trace/3">erlang:trace/3</seealso> + <seealso marker="#trace/3">erlang:trace/3</seealso> to set the <c>call</c> trace flag for one or more processes.</p> <p>Conceptually, call tracing works like this: Inside the Erlang virtual machine there is a set of processes to be @@ -6713,7 +6713,7 @@ true</pre> in the traced function set, the trace action will be taken. Otherwise, nothing will happen.</p> <p>Use - <seealso marker="#erlang:trace/3">erlang:trace/3</seealso> to + <seealso marker="#trace/3">erlang:trace/3</seealso> to add or remove one or more processes to the set of traced processes. Use <c>erlang:trace_pattern/2</c> to add or remove exported functions to the set of traced functions.</p> @@ -6830,7 +6830,7 @@ true</pre> counters can be restarted from zero with <c>MatchSpec == restart</c>.</p> <p>The counter value can be read with - <seealso marker="#erlang:trace_info/2">erlang:trace_info/2</seealso>.</p> + <seealso marker="#trace_info/2">erlang:trace_info/2</seealso>.</p> </item> </taglist> <p>The <c>global</c> and <c>local</c> options are mutually @@ -6850,7 +6850,7 @@ true</pre> specification list. If a function has a match specification, you can replace it with a completely new one. If you need to change an existing match specification, use the - <seealso marker="#erlang:trace_info/2">erlang:trace_info/2</seealso> + <seealso marker="#trace_info/2">erlang:trace_info/2</seealso> BIF to retrieve the existing match specification.</p> <p>Returns the number of exported functions that matched the <c>MFA</c> argument. This will be zero if none matched at diff --git a/erts/doc/src/notes.xml b/erts/doc/src/notes.xml index 2252358e0d..5fe414841e 100644 --- a/erts/doc/src/notes.xml +++ b/erts/doc/src/notes.xml @@ -4,7 +4,7 @@ <chapter> <header> <copyright> - <year>2004</year><year>2009</year> + <year>2004</year><year>2010</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -13,12 +13,12 @@ compliance with the License. You should have received a copy of the Erlang Public License along with this software. If not, it can be retrieved online at http://www.erlang.org/. - + Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License. - + </legalnotice> <title>ERTS Release Notes</title> @@ -242,7 +242,7 @@ <item> <p> The <seealso - marker="erlang#erlang:port_command/3">erlang:port_command/3</seealso> + marker="erlang#port_command/3">erlang:port_command/3</seealso> BIF has been added. <c>erlang:port_command/3</c> is currently not auto imported, but it is planned to be auto imported in OTP R14. For more information see the diff --git a/erts/lib_src/Makefile.in b/erts/lib_src/Makefile.in index 1d2cc7cb0c..49f5b1f048 100644 --- a/erts/lib_src/Makefile.in +++ b/erts/lib_src/Makefile.in @@ -24,7 +24,6 @@ OMIT_OMIT_FP=no CC=@CC@ -GCC=@GCC@ LD=@LD@ AR=@AR@ RANLIB=@RANLIB@ @@ -115,7 +114,7 @@ endif CREATE_DIRS= -ifeq ($(GCC)-$(OMIT_FP),yes-true) +ifeq ($(CC)-$(OMIT_FP), gcc-true) CFLAGS += -fomit-frame-pointer endif @@ -484,6 +483,8 @@ ifneq ($(strip $(INTERNAL_RELEASE_LIBS)),) $(INSTALL_DATA) $(INTERNAL_RELEASE_LIBS) $(RELSYSDIR)/lib/internal endif +docs: + release_docs_spec: diff --git a/lib/appmon/doc/src/Makefile b/lib/appmon/doc/src/Makefile index ece0977810..743f123c06 100644 --- a/lib/appmon/doc/src/Makefile +++ b/lib/appmon/doc/src/Makefile @@ -1,19 +1,19 @@ # # %CopyrightBegin% -# -# Copyright Ericsson AB 1997-2009. All Rights Reserved. -# +# +# Copyright Ericsson AB 1997-2010. 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 # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. -# +# # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. -# +# # %CopyrightEnd% include $(ERL_TOP)/make/target.mk include $(ERL_TOP)/make/$(TARGET)/otp.mk @@ -46,6 +46,9 @@ XML_CHAPTER_FILES = \ BOOK_FILES = book.xml +XML_FILES = $(BOOK_FILES) $(XML_APPLICATION_FILES) $(XML_REF3_FILES) \ + $(XML_PART_FILES) $(XML_CHAPTER_FILES) + GIF_FILES = \ app_win.gif \ listbox_win.gif \ diff --git a/lib/common_test/doc/src/Makefile b/lib/common_test/doc/src/Makefile index a6ece5af28..a2c014418d 100644 --- a/lib/common_test/doc/src/Makefile +++ b/lib/common_test/doc/src/Makefile @@ -1,19 +1,19 @@ # # %CopyrightBegin% -# -# Copyright Ericsson AB 2003-2009. All Rights Reserved. -# +# +# Copyright Ericsson AB 2003-2010. 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 # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. -# +# # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. -# +# # %CopyrightEnd% # @@ -112,18 +112,16 @@ DVIPS_FLAGS += CT_SRC_DIR = $(ERL_TOP)/../internal_tools/common_test/src -EDOC_ARGS=[{preprocess,true},{includes,["$(XMERL_DIR)/include","../../../test_server/include","../../include","../../../../erts/lib/kernel/include","../../../../lib/kernel/include","../../../../erts/lib/snmp/include","../../../../lib/snmp/include"]}] - - $(HTMLDIR)/%.gif: %.gif $(INSTALL_DATA) $< $@ docs: pdf html man $(CT_XML_FILES): - erl -boot start_clean -noshell \ - -eval 'docb_gen:module("../../src/$(@:%.xml=%.erl)",$(EDOC_ARGS))' \ - -s erlang halt + escript $(DOCGEN)/priv/bin/xml_from_edoc.escript -preprocess true -i $(XMERL_DIR)/include \ + -i ../../../test_server/include -i ../../include \ + -i ../../../../erts/lib/kernel/include -i ../../../../lib/kernel/include \ + -i ../../../../erts/lib/snmp/include -i ../../../../lib/snmp/include ../../src/$(@:%.xml=%.erl) $(TOP_PDF_FILE): $(XML_FILES) diff --git a/lib/crypto/doc/src/Makefile b/lib/crypto/doc/src/Makefile index d2cec9b11b..03aaba939b 100644 --- a/lib/crypto/doc/src/Makefile +++ b/lib/crypto/doc/src/Makefile @@ -42,6 +42,9 @@ XML_CHAPTER_FILES = notes.xml licenses.xml BOOK_FILES = book.xml +XML_FILES = $(BOOK_FILES) $(XML_APPLICATION_FILES) $(XML_REF3_FILES) $(XML_REF6_FILES) \ + $(XML_PART_FILES) $(XML_CHAPTER_FILES) + GIF_FILES = # ---------------------------------------------------- diff --git a/lib/docbuilder/doc/src/inline_tags.xml b/lib/docbuilder/doc/src/inline_tags.xml index e1d392076a..10afbf143f 100644 --- a/lib/docbuilder/doc/src/inline_tags.xml +++ b/lib/docbuilder/doc/src/inline_tags.xml @@ -4,7 +4,7 @@ <chapter> <header> <copyright> - <year>1997</year><year>2009</year> + <year>1997</year><year>2010</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -13,12 +13,12 @@ compliance with the License. You should have received a copy of the Erlang Public License along with this software. If not, it can be retrieved online at http://www.erlang.org/. - + Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License. - + </legalnotice> <title>Inline Tags</title> @@ -157,7 +157,7 @@ <p>The default behaviour can be modified by using the callback module option to <c>docb_transform:file/1,2</c> and defining a callback function - <seealso marker="docb_transform#Module:seealso/1">Module:seealso/1</seealso>. + <seealso marker="docb_transform#Module:seealso-1">Module:seealso/1</seealso>. This possibility is for example used in OTP to resolve cross references between applications.</p> </section> diff --git a/lib/edoc/Makefile b/lib/edoc/Makefile index 2b011b55cc..e512e390e3 100644 --- a/lib/edoc/Makefile +++ b/lib/edoc/Makefile @@ -86,13 +86,13 @@ SYNTAX_TOOLS_DIR=$(ERL_TOP)/lib/syntax_tools XMERL_DIR=$(ERL_TOP)/lib/xmerl INCDIR=$(XMERL_DIR)/include -docs: +# The overriding docs target have been removed so the default make rules work properly. + +edocs: erl -noshell -pa $(BINDIR) -pa $(SYNTAX_TOOLS_DIR)/ebin \ -pa $(XMERL_DIR)/ebin -run edoc_run application \ "'$(APPNAME)'" '"."' '$(DOC_OPTS)' -edocs: docs - info: @echo $(HTML_FILES) diff --git a/lib/edoc/doc/src/Makefile b/lib/edoc/doc/src/Makefile index 8d22e1c1da..748691d173 100644 --- a/lib/edoc/doc/src/Makefile +++ b/lib/edoc/doc/src/Makefile @@ -103,11 +103,10 @@ html: gifs $(HTML_REF_MAN_FILE) man: $(MAN3_FILES) $(XML_REF3_FILES): - docb_gen -def vsn $(EDOC_VSN) -includes $(INC_DIR) \ - $(SRC_DIR)/$(@:%.xml=%.erl) + escript $(DOCGEN)/priv/bin/xml_from_edoc.escript -def vsn $(EDOC_VSN) -i $(ERL_TOP)/lib/edoc/include $(SRC_DIR)/$(@:%.xml=%.erl) $(XML_CHAPTER_FILES): - docb_gen -chapter -def vsn $(EDOC_VSN) ../overview.edoc + escript $(DOCGEN)/priv/bin/xml_from_edoc.escript -def vsn $(EDOC_VSN) -chapter ../overview.edoc gifs: $(GIF_FILES:%=$(HTMLDIR)/%) diff --git a/lib/edoc/src/Makefile b/lib/edoc/src/Makefile index fd0fbac37d..ca95c4cdad 100644 --- a/lib/edoc/src/Makefile +++ b/lib/edoc/src/Makefile @@ -55,6 +55,8 @@ all: $(OBJECTS) $(OBJECTS): $(HRL_FILES) $(XMERL)/include/xmerl.hrl +docs: + clean: rm -f $(OBJECTS) edoc_parser.erl rm -f core *~ diff --git a/lib/erl_docgen/priv/bin/Makefile b/lib/erl_docgen/priv/bin/Makefile index bd59675003..95ad36216a 100644 --- a/lib/erl_docgen/priv/bin/Makefile +++ b/lib/erl_docgen/priv/bin/Makefile @@ -1,19 +1,19 @@ # # %CopyrightBegin% -# -# Copyright Ericsson AB 2009. All Rights Reserved. -# +# +# Copyright Ericsson AB 2009-2010. 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 # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. -# +# # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. -# +# # %CopyrightEnd% # # @@ -38,7 +38,8 @@ RELSYSDIR = $(RELEASE_PATH)/lib/erl_docgen-$(VSN) ESCRIPT_FILES= \ - codeline_preprocessing.escript + codeline_preprocessing.escript \ + xml_from_edoc.escript # ---------------------------------------------------- # FLAGS diff --git a/lib/erl_docgen/priv/bin/codeline_preprocessing.escript b/lib/erl_docgen/priv/bin/codeline_preprocessing.escript index 33a678d3a4..592b3985e4 100755 --- a/lib/erl_docgen/priv/bin/codeline_preprocessing.escript +++ b/lib/erl_docgen/priv/bin/codeline_preprocessing.escript @@ -1,20 +1,20 @@ #!/usr/bin/env escript %% -*- erlang -*- %% %CopyrightBegin% -%% -%% Copyright Ericsson AB 2009. All Rights Reserved. -%% +%% +%% Copyright Ericsson AB 2009-2010. 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 %% compliance with the License. You should have received a copy of the %% Erlang Public License along with this software. If not, it can be %% retrieved online at http://www.erlang.org/. -%% +%% %% Software distributed under the License is distributed on an "AS IS" %% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See %% the License for the specific language governing rights and limitations %% under the License. -%% +%% %% %CopyrightEnd% %%---------------------------------------------------------------------- %% File : codeline_preprocessing.escript @@ -54,13 +54,16 @@ main([InFile, OutFile]) -> main(_) -> usage(). +%%====================================================================== +%% Internal functions +%%====================================================================== %%---------------------------------------------------------------------- -%% Function: main/1 +%% Function: usage/0 %% Description: %%---------------------------------------------------------------------- usage() -> - io:format("usage: codeline_preprocessing <infile> <outfile>\n"), + io:format("usage: codeline_preprocessing.escript <infile> <outfile>\n"), halt(1). diff --git a/lib/erl_docgen/priv/bin/xml_from_edoc.escript b/lib/erl_docgen/priv/bin/xml_from_edoc.escript new file mode 100755 index 0000000000..ee79e82c3a --- /dev/null +++ b/lib/erl_docgen/priv/bin/xml_from_edoc.escript @@ -0,0 +1,149 @@ +#!/usr/bin/env escript +%% -*- erlang -*- +%% %CopyrightBegin% +%% +%% Copyright Ericsson AB 2010. 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 +%% compliance with the License. You should have received a copy of the +%% Erlang Public License along with this software. If not, it can be +%% retrieved online at http://www.erlang.org/. +%% +%% Software distributed under the License is distributed on an "AS IS" +%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +%% the License for the specific language governing rights and limitations +%% under the License. +%% +%% %CopyrightEnd% +%%---------------------------------------------------------------------- +%% File : xml_from_edoc.escript +%% +%% Created : 12 Dec 2009 by Lars Thorsen +%%---------------------------------------------------------------------- + + +%%====================================================================== +%% Records +%%====================================================================== +-record(args, {suffix=".xml", + layout=docb_edoc_xml_cb, + def=[], + includes=[], + preprocess=false, + sort_functions=true}). + + +%%====================================================================== +%% External functions +%%====================================================================== +%%---------------------------------------------------------------------- +%% Function: main/1 +%% Description: +%%---------------------------------------------------------------------- +main(RawOpts) -> + case catch parse(RawOpts, erlref, #args{}) of + {ok, File, Type, Args} -> + case Type of + erlref -> + module(File, Args); + chapter -> + users_guide(File, Args) + end; + {error, Msg} -> + io:format("~p\n", [Msg]), + usage() + end; +main(_) -> + usage(). + +%%====================================================================== +%% Internal functions +%%====================================================================== + +%%---------------------------------------------------------------------- +%% Function: usage/0 +%% Description: +%%---------------------------------------------------------------------- +usage() -> + io:format("usage: xml_from_edoc.escript [<options>] <file> \n"), + halt(1). + + +%%---------------------------------------------------------------------- +%% Function: module/2 +%% Description: +%%---------------------------------------------------------------------- +module(File, Args) -> + case filelib:is_regular(File) of + true -> + Opts = [{def, Args#args.def}, + {includes, Args#args.includes}, + {preprocess, Args#args.preprocess}, + {sort_functions, Args#args.sort_functions}, + + {app_default, "OTPROOT"}, + {file_suffix, Args#args.suffix}, + {dir, "."}, + {layout, Args#args.layout}], + edoc:file(File, Opts); + false -> + io:format("~s: not a regular file\n", [File]), + usage() + end. + + +%%---------------------------------------------------------------------- +%% Function: users_guide/2 +%% Description: +%%---------------------------------------------------------------------- +users_guide(File, Args) -> + case filelib:is_regular(File) of + true -> + Opts = [{def, Args#args.def}, + {app_default, "OTPROOT"}, + {file_suffix, Args#args.suffix}, + {layout, Args#args.layout}], + + Env = edoc_lib:get_doc_env(Opts), + + {ok, Tags} = + edoc_extract:file(File, overview, Env, Opts), + Data = + edoc_data:overview("Overview", Tags, Env, Opts), + F = fun(M) -> M:overview(Data, Opts) end, + Text = edoc_lib:run_layout(F, Opts), + + OutFile = "chapter" ++ Args#args.suffix, + edoc_lib:write_file(Text, ".", OutFile); + false -> + io:format("~s: not a regular file\n", [File]), + usage() + end. + + + +parse(["-xml" |RawOpts], Type, Args) -> + parse(RawOpts, Type, Args); % default, no update of record necessary +parse(["-sgml" |RawOpts], Type, Args) -> + parse(RawOpts, Type, Args#args{suffix=".sgml", layout=docb_edoc_sgml_cb}); +parse(["-chapter" |RawOpts], _Type, Args) -> + parse(RawOpts, chapter, Args); +parse(["-def", Key, Val |RawOpts], Type, Args) -> + Args2 = Args#args{def=Args#args.def++[{list_to_atom(Key), Val}]}, + parse(RawOpts, Type, Args2); + +parse(["-i", Dir |RawOpts], Type, Args) -> + Args2 = Args#args{includes=Args#args.includes++[Dir]}, + parse(RawOpts, Type, Args2); +parse(["-preprocess", Bool |RawOpts], Type, Args) when Bool == "true"; + Bool == "false" -> + parse(RawOpts, Type, Args#args{preprocess=list_to_atom(Bool)}); +parse(["-sort_functions", Bool |RawOpts], Type, Args) when Bool == "true"; + Bool == "false" -> + parse(RawOpts, Type, Args#args{sort_functions=list_to_atom(Bool)}); +parse([File], Type, Args) -> + {ok, File, Type, Args}; +parse([Opt | _RawOpts], _Type, _Args) -> + {error, io_lib:format("Bad option: ~p", [Opt])}. + diff --git a/lib/erl_docgen/priv/xsl/db_eix.xsl b/lib/erl_docgen/priv/xsl/db_eix.xsl index 929272256a..970b85ccb9 100644 --- a/lib/erl_docgen/priv/xsl/db_eix.xsl +++ b/lib/erl_docgen/priv/xsl/db_eix.xsl @@ -137,7 +137,20 @@ <xsl:value-of select="substring-before(nametext, '(')"/> </xsl:when> <xsl:when test="ancestor::erlref"> - <xsl:value-of select="substring-before(., '(')"/> + <xsl:variable name="fname1"> + <xsl:value-of select="substring-before(., '(')"/> + </xsl:variable> + <xsl:variable name="fname2"> + <xsl:value-of select="substring-after($fname1, 'erlang:')"/> + </xsl:variable> + <xsl:choose> + <xsl:when test="string-length($fname2) > 0"> + <xsl:value-of select="$fname2"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$fname1"/> + </xsl:otherwise> + </xsl:choose> </xsl:when> </xsl:choose> </xsl:variable> @@ -178,26 +191,63 @@ </xsl:template> <xsl:template name="remove-paren"> - <xsl:param name="string"/> - <xsl:variable name="bstring"> - <xsl:value-of select="substring-before($string, '(')"/> + <xsl:param name="string"/> + + <xsl:variable name="str1"> + <xsl:call-template name="remove-paren-1"> + <xsl:with-param name="string" select="$string"/> + <xsl:with-param name="start">(</xsl:with-param> + <xsl:with-param name="end">)</xsl:with-param> + </xsl:call-template> + </xsl:variable> + + <xsl:variable name="str2"> + <xsl:call-template name="remove-paren-1"> + <xsl:with-param name="string" select="$str1"/> + <xsl:with-param name="start">{</xsl:with-param> + <xsl:with-param name="end">}</xsl:with-param> + </xsl:call-template> </xsl:variable> + + <xsl:variable name="str3"> + <xsl:call-template name="remove-paren-1"> + <xsl:with-param name="string" select="$str2"/> + <xsl:with-param name="start">[</xsl:with-param> + <xsl:with-param name="end">]</xsl:with-param> + </xsl:call-template> + </xsl:variable> + + <xsl:value-of select="$str3"/> + + </xsl:template> + + + <xsl:template name="remove-paren-1"> + <xsl:param name="string"/> + <xsl:param name="start"/> + <xsl:param name="end"/> + + <xsl:variable name="tmp1"> + <xsl:value-of select="substring-before($string, $start)"/> + </xsl:variable> + <xsl:choose> - <xsl:when test="string-length($bstring) > 0"> - <xsl:variable name="astring"> - <xsl:value-of select="substring-after($string, ')')"/> + <xsl:when test="string-length($tmp1) > 0 or starts-with($string, $start)"> + <xsl:variable name="tmp2"> + <xsl:value-of select="substring-after($string, $end)"/> </xsl:variable> <xsl:variable name="retstring"> <xsl:call-template name="remove-paren"> - <xsl:with-param name="string" select="$astring"/> + <xsl:with-param name="string" select="$tmp2"/> </xsl:call-template> </xsl:variable> - <xsl:value-of select="concat($bstring, $retstring)"/> + <xsl:value-of select="concat(concat($tmp1, 'x'), $retstring)"/> </xsl:when> <xsl:otherwise> <xsl:value-of select="$string"/> </xsl:otherwise> </xsl:choose> + </xsl:template> <!-- default content handling --> diff --git a/lib/erl_docgen/priv/xsl/db_html.xsl b/lib/erl_docgen/priv/xsl/db_html.xsl index 984655fc26..c2b58e48ec 100644 --- a/lib/erl_docgen/priv/xsl/db_html.xsl +++ b/lib/erl_docgen/priv/xsl/db_html.xsl @@ -2,20 +2,20 @@ <!-- # # %CopyrightBegin% - # - # Copyright Ericsson AB 2009. All Rights Reserved. - # + # + # Copyright Ericsson AB 2009-2010. 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 # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. - # + # # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. - # + # # %CopyrightEnd% --> @@ -40,6 +40,46 @@ <div id="container"> <script id="js" type="text/javascript" language="JavaScript" src="{$topdocdir}/js/flipmenu/flipmenu.js"/> <script id="js2" type="text/javascript" src="{$topdocdir}/js/erlresolvelinks.js"></script> + <script language="JavaScript" type="text/javascript"> + <xsl:text disable-output-escaping="yes"><![CDATA[ + <!-- + function getWinHeight() { + var myHeight = 0; + if( typeof( window.innerHeight ) == 'number' ) { + //Non-IE + myHeight = window.innerHeight; + } else if( document.documentElement && ( document.documentElement.clientWidth || + document.documentElement.clientHeight ) ) { + //IE 6+ in 'standards compliant mode' + myHeight = document.documentElement.clientHeight; + } else if( document.body && ( document.body.clientWidth || document.body.clientHeight ) ) { + //IE 4 compatible + myHeight = document.body.clientHeight; + } + return myHeight; + } + + function setscrollpos() { + var objf=document.getElementById('loadscrollpos'); + document.getElementById("leftnav").scrollTop = objf.offsetTop - getWinHeight()/2; + } + + function addEvent(obj, evType, fn){ + if (obj.addEventListener){ + obj.addEventListener(evType, fn, true); + return true; + } else if (obj.attachEvent){ + var r = obj.attachEvent("on"+evType, fn); + return r; + } else { + return false; + } + } + + addEvent(window, 'load', setscrollpos); + + //-->]]></xsl:text> + </script> <!-- Generate menu --> <xsl:call-template name="menu"> <xsl:with-param name="chapnum" select="$chapnum"/> @@ -543,7 +583,13 @@ <xsl:otherwise>false</xsl:otherwise> </xsl:choose> </xsl:variable> - <li title="{header/title}" expanded="{$expanded}"> + <xsl:variable name="loadscrollpos"> + <xsl:choose> + <xsl:when test="$chapnum = $curchapnum">loadscrollpos</xsl:when> + <xsl:otherwise>no</xsl:otherwise> + </xsl:choose> + </xsl:variable> + <li id="{$loadscrollpos}" title="{header/title}" expanded="{$expanded}"> <xsl:value-of select="header/title"/> <ul> <li> @@ -731,12 +777,19 @@ </xsl:choose> </xsl:variable> + <xsl:variable name="loadscrollpos"> + <xsl:choose> + <xsl:when test="$curModule = $cval">loadscrollpos</xsl:when> + <xsl:otherwise>no</xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:variable name="link_cval"><xsl:value-of select="translate($cval, '­', '')"/></xsl:variable> <xsl:choose> <xsl:when test="$genFuncMenu = 'true'"> - <li title="{$cval} " expanded="{$expanded}"> + <li id="{$loadscrollpos}" title="{$cval} " expanded="{$expanded}"> <xsl:value-of select="$cval"/> <ul> <li> @@ -788,58 +841,73 @@ <xsl:when test="string-length($fname) > 0"> <li title="{$fname}"> <a href="{$basename}.html#{$fname}"> - <xsl:value-of select="$fname"/>() - </a> - </li> - </xsl:when> - <xsl:otherwise> - <li title="{name/nametext}"> - <a href="{$basename}.html#{name/nametext}"> - <xsl:value-of select="nametext"/>() - </a> - </li> - </xsl:otherwise> - </xsl:choose> - </xsl:when> - - <xsl:when test="ancestor::erlref"> - - <xsl:variable name="tmpstring"> - <xsl:value-of select="substring-before(substring-after(., '('), '->')"/> - </xsl:variable> - - <xsl:variable name="ustring"> - <xsl:choose> - <xsl:when test="string-length($tmpstring) > 0"> - <xsl:call-template name="remove-paren"> - <xsl:with-param name="string" select="$tmpstring"/> - </xsl:call-template> + <xsl:value-of select="$fname"/>() + </a> + </li> </xsl:when> <xsl:otherwise> - <xsl:call-template name="remove-paren"> - <xsl:with-param name="string" select="substring-after(., '(')"/> - </xsl:call-template> + <li title="{name/nametext}"> + <a href="{$basename}.html#{name/nametext}"> + <xsl:value-of select="nametext"/>() + </a> + </li> </xsl:otherwise> - </xsl:choose> - </xsl:variable> - - <xsl:variable name="arity"> - <xsl:call-template name="calc-arity"> - <xsl:with-param name="string" select="substring-before($ustring, ')')"/> - <xsl:with-param name="no-of-pars" select="0"/> - </xsl:call-template> - </xsl:variable> - <xsl:variable name="fname"> - <xsl:value-of select="substring-before(., '(')"/> - </xsl:variable> - <li title="{$fname}-{$arity}"> - <a href="{$basename}.html#{$fname}-{$arity}"> - <xsl:value-of select="$fname"/>/<xsl:value-of select="$arity"/> - </a> - </li> - </xsl:when> - </xsl:choose> - + </xsl:choose> + </xsl:when> + + <xsl:when test="ancestor::erlref"> + + <xsl:variable name="tmpstring"> + <xsl:value-of select="substring-before(substring-after(., '('), '->')"/> + </xsl:variable> + + <xsl:variable name="ustring"> + <xsl:choose> + <xsl:when test="string-length($tmpstring) > 0"> + <xsl:call-template name="remove-paren"> + <xsl:with-param name="string" select="$tmpstring"/> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="remove-paren"> + <xsl:with-param name="string" select="substring-after(., '(')"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + + <xsl:variable name="arity"> + <xsl:call-template name="calc-arity"> + <xsl:with-param name="string" select="substring-before($ustring, ')')"/> + <xsl:with-param name="no-of-pars" select="0"/> + </xsl:call-template> + </xsl:variable> + + <xsl:variable name="fname"> + <xsl:variable name="fname1"> + <xsl:value-of select="substring-before(., '(')"/> + </xsl:variable> + <xsl:variable name="fname2"> + <xsl:value-of select="substring-after($fname1, 'erlang:')"/> + </xsl:variable> + <xsl:choose> + <xsl:when test="string-length($fname2) > 0"> + <xsl:value-of select="$fname2"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$fname1"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + + <li title="{$fname}-{$arity}"> + <a href="{$basename}.html#{$fname}-{$arity}"> + <xsl:value-of select="$fname"/>/<xsl:value-of select="$arity"/> + </a> + </li> + </xsl:when> + </xsl:choose> + </xsl:for-each> </xsl:template> @@ -1065,6 +1133,7 @@ <!-- Funcs --> <xsl:template match="funcs"> + <xsl:param name="partnum"/> <h3> <xsl:text>EXPORTS</xsl:text> @@ -1121,11 +1190,26 @@ <a name="{substring-before(nametext, '(')}"><span class="bold_code"><xsl:value-of select="ret"/><xsl:text> </xsl:text><xsl:value-of select="nametext"/></span></a><br/> </xsl:when> <xsl:when test="ancestor::erlref"> - <a name="{substring-before(., '(')}-{$arity}"><span class="bold_code"><xsl:value-of select="."/></span></a><br/> + <xsl:variable name="fname"> + <xsl:variable name="fname1"> + <xsl:value-of select="substring-before(., '(')"/> + </xsl:variable> + <xsl:variable name="fname2"> + <xsl:value-of select="substring-after($fname1, 'erlang:')"/> + </xsl:variable> + <xsl:choose> + <xsl:when test="string-length($fname2) > 0"> + <xsl:value-of select="$fname2"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$fname1"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + <a name="{$fname}-{$arity}"><span class="bold_code"><xsl:value-of select="."/></span></a><br/> </xsl:when> </xsl:choose> - </xsl:template> @@ -1167,6 +1251,7 @@ <!-- Desc --> <xsl:template match="desc"> + <xsl:param name="partnum"/> <div class="REFBODY"> <p> <xsl:apply-templates> @@ -1458,29 +1543,65 @@ </xsl:choose> </xsl:template> + <xsl:template name="remove-paren"> <xsl:param name="string"/> + + <xsl:variable name="str1"> + <xsl:call-template name="remove-paren-1"> + <xsl:with-param name="string" select="$string"/> + <xsl:with-param name="start">(</xsl:with-param> + <xsl:with-param name="end">)</xsl:with-param> + </xsl:call-template> + </xsl:variable> + + <xsl:variable name="str2"> + <xsl:call-template name="remove-paren-1"> + <xsl:with-param name="string" select="$str1"/> + <xsl:with-param name="start">{</xsl:with-param> + <xsl:with-param name="end">}</xsl:with-param> + </xsl:call-template> + </xsl:variable> + + <xsl:variable name="str3"> + <xsl:call-template name="remove-paren-1"> + <xsl:with-param name="string" select="$str2"/> + <xsl:with-param name="start">[</xsl:with-param> + <xsl:with-param name="end">]</xsl:with-param> + </xsl:call-template> + </xsl:variable> + + <xsl:value-of select="$str3"/> + + </xsl:template> + + + <xsl:template name="remove-paren-1"> + <xsl:param name="string"/> + <xsl:param name="start"/> + <xsl:param name="end"/> - <xsl:variable name="bstring"> - <xsl:value-of select="substring-before($string, '(')"/> + <xsl:variable name="tmp1"> + <xsl:value-of select="substring-before($string, $start)"/> </xsl:variable> <xsl:choose> - <xsl:when test="string-length($bstring) > 0"> - <xsl:variable name="astring"> - <xsl:value-of select="substring-after($string, ')')"/> + <xsl:when test="string-length($tmp1) > 0 or starts-with($string, $start)"> + <xsl:variable name="tmp2"> + <xsl:value-of select="substring-after($string, $end)"/> </xsl:variable> <xsl:variable name="retstring"> <xsl:call-template name="remove-paren"> - <xsl:with-param name="string" select="$astring"/> + <xsl:with-param name="string" select="$tmp2"/> </xsl:call-template> </xsl:variable> - <xsl:value-of select="concat($bstring, $retstring)"/> + <xsl:value-of select="concat(concat($tmp1, 'x'), $retstring)"/> </xsl:when> <xsl:otherwise> <xsl:value-of select="$string"/> </xsl:otherwise> </xsl:choose> + </xsl:template> </xsl:stylesheet> diff --git a/lib/erl_docgen/priv/xsl/db_man.xsl b/lib/erl_docgen/priv/xsl/db_man.xsl index c759a77496..300d1ed362 100644 --- a/lib/erl_docgen/priv/xsl/db_man.xsl +++ b/lib/erl_docgen/priv/xsl/db_man.xsl @@ -2,20 +2,20 @@ <!-- # # %CopyrightBegin% - # - # Copyright Ericsson AB 2009. All Rights Reserved. - # + # + # Copyright Ericsson AB 2009-2010. 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 # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. - # + # # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. - # + # # %CopyrightEnd% --> @@ -37,14 +37,12 @@ <!-- *ref/Section --> <xsl:template match="erlref/section|comref/section|cref/section|fileref/section|appref/section"> - <xsl:text> .RE </xsl:text> <xsl:text> .SH "</xsl:text><xsl:value-of select="translate(title, 'abcdefghijklmnopqrstuvwxyz','ABCDEFGHIJKLMNOPQRSTUVWXYZ')"/><xsl:text>" </xsl:text> <xsl:apply-templates/> </xsl:template> <!-- *ref/Subsection --> - <xsl:template match="erlref/section/section|comref/section/section|cref/section/section|fileref/section/section|appref/section/section"> - <xsl:text> .RE </xsl:text> + <xsl:template match="section/section"> <xsl:text> .SS "</xsl:text><xsl:value-of select="title"/><xsl:text>" </xsl:text> <xsl:apply-templates/> </xsl:template> @@ -53,9 +51,9 @@ <!-- Lists --> <xsl:template match="list"> - <xsl:text> .RS 2 </xsl:text> + <xsl:text> .RS 2</xsl:text> <xsl:apply-templates/> - <xsl:text> .RE </xsl:text> + <xsl:text> .RE</xsl:text> </xsl:template> <xsl:template match="list/item"> @@ -65,72 +63,80 @@ <xsl:apply-templates/> </xsl:variable> <xsl:value-of select="normalize-space($content)"/> - <xsl:text> .br </xsl:text> - <xsl:text> .br </xsl:text> + <xsl:text> .LP </xsl:text> </xsl:template> <xsl:template match="taglist"> - <xsl:text> .RS 2 </xsl:text> - <xsl:apply-templates/> - <xsl:text> .RE </xsl:text> + <xsl:text> .RS 2</xsl:text> + <xsl:apply-templates select="tag|item"/> + <xsl:text> .RE</xsl:text> </xsl:template> <xsl:template match="taglist/tag"> - <xsl:text> .TP 4 </xsl:text> + <xsl:text> .TP 2 </xsl:text> <xsl:text>.B </xsl:text> - <xsl:apply-templates/> + <xsl:apply-templates/><xsl:text>: </xsl:text> </xsl:template> <xsl:template match="item/p"> <xsl:variable name="content"> <xsl:apply-templates/> </xsl:variable> - <xsl:value-of select="normalize-space($content)"/> - <xsl:text> .br </xsl:text> - <xsl:text> .br </xsl:text> + <xsl:choose> + <xsl:when test="position() = 1"> + <xsl:value-of select="normalize-space($content)"/> + </xsl:when> + <xsl:otherwise> + <xsl:text> .RS 2</xsl:text> + <xsl:text> .LP .LP </xsl:text> + <xsl:value-of select="normalize-space($content)"/> + <xsl:text> .RE</xsl:text> + </xsl:otherwise> + </xsl:choose> </xsl:template> - <xsl:template match="taglist/item"> - <xsl:text> </xsl:text> - <xsl:apply-templates/> + <xsl:choose> + <xsl:when test="child::p"> + <xsl:apply-templates/> + </xsl:when> + <xsl:otherwise> + <xsl:variable name="content"> + <xsl:apply-templates/> + </xsl:variable> + <xsl:value-of select="normalize-space($content)"/> + </xsl:otherwise> + </xsl:choose> </xsl:template> <!-- Note --> <xsl:template match="note"> - <xsl:text> .TP 4 .B Note: </xsl:text> + <xsl:text> .SS Note:</xsl:text> <xsl:apply-templates/> + <xsl:text> </xsl:text> </xsl:template> <!-- Warning --> <xsl:template match="warning"> - <xsl:text> .TP 4 .B Warning: </xsl:text> + <xsl:text> .SS Warning:</xsl:text> <xsl:apply-templates/> + <xsl:text> </xsl:text> </xsl:template> - <xsl:template match="warning/p|note/p"> - <xsl:variable name="content"> - <xsl:apply-templates/> - </xsl:variable> - <xsl:value-of select="normalize-space($content)"/> - <xsl:text> .LP </xsl:text> - </xsl:template> - - <!-- Paragraph --> <xsl:template match="p"> - <xsl:text> .LP </xsl:text> <xsl:variable name="content"> <xsl:apply-templates/> </xsl:variable> + <xsl:text> .LP </xsl:text> <xsl:value-of select="normalize-space($content)"/> </xsl:template> <!-- Inline elements --> <xsl:template match="b"> - <xsl:text> \fB</xsl:text> + <xsl:text>\fB</xsl:text> <xsl:apply-templates/> - <xsl:text>\fR\&</xsl:text> + <xsl:text>\fR\& </xsl:text> </xsl:template> <xsl:template match="br"> @@ -138,19 +144,20 @@ </xsl:template> <xsl:template match="c"> - <xsl:text> \fI</xsl:text><xsl:value-of select="text()"/><xsl:text>\fR\&</xsl:text> + <xsl:text>\fI</xsl:text><xsl:apply-templates/><xsl:text>\fR\&</xsl:text> </xsl:template> <xsl:template match="em"> - <xsl:text> \fI</xsl:text><xsl:value-of select="text()"/><xsl:text>\fR\&</xsl:text> + <xsl:text>\fI</xsl:text> <xsl:apply-templates/><xsl:text>\fR\&</xsl:text> </xsl:template> <xsl:template match="seealso"> - <xsl:text> \fB</xsl:text><xsl:apply-templates/><xsl:text>\fR\&</xsl:text> + <xsl:text>\fB</xsl:text><xsl:apply-templates/><xsl:text>\fR\&</xsl:text> </xsl:template> <!-- Code --> <xsl:template match="code"> + <xsl:text> .LP </xsl:text> <xsl:text> .nf </xsl:text> <xsl:apply-templates/> <xsl:text> .fi </xsl:text> @@ -158,6 +165,7 @@ <!-- Pre --> <xsl:template match="pre"> + <xsl:text> .LP </xsl:text> <xsl:text> .nf </xsl:text> <xsl:apply-templates/> <xsl:text> .fi </xsl:text> @@ -168,16 +176,7 @@ <xsl:template match="table"> </xsl:template> - <!--xsl:template match="row"> - <xsl:apply-templates/> - </xsl:template> - - <xsl:template match="cell"> - <xsl:apply-templates/> - </xsl:template --> - - - <!-- Image --> + <!-- Image --> <xsl:template match="image"> </xsl:template> @@ -192,7 +191,7 @@ <!-- Erlref --> <xsl:template match="/erlref"> <xsl:text>.TH </xsl:text><xsl:value-of select="module"/><xsl:text> 3 "</xsl:text><xsl:value-of select="$appname"/><xsl:text> </xsl:text><xsl:value-of select="$appver"/><xsl:text>" "Ericsson AB" "Erlang Module Definition" </xsl:text> - <xsl:text>.SH MODULE </xsl:text> + <xsl:text>.SH NAME </xsl:text> <xsl:value-of select="module"/><xsl:text> \- </xsl:text><xsl:value-of select="modulesummary"/><xsl:text> </xsl:text> <xsl:apply-templates/> </xsl:template> @@ -225,7 +224,7 @@ <xsl:template match="/appref"> <xsl:text>.TH </xsl:text><xsl:value-of select="app"/><xsl:text> 6 "</xsl:text><xsl:value-of select="$appname"/><xsl:text> </xsl:text><xsl:value-of select="$appver"/><xsl:text>" "Ericsson AB" "Erlang Application Definition" </xsl:text> <xsl:text>.SH NAME </xsl:text> - <xsl:value-of select="file"/><xsl:text> \- </xsl:text><xsl:value-of select="filesummary"/><xsl:text> </xsl:text> + <xsl:value-of select="app"/><xsl:text> \- </xsl:text><xsl:value-of select="appsummary"/><xsl:text> </xsl:text> <xsl:apply-templates/> </xsl:template> @@ -297,9 +296,80 @@ <!-- This tag is skipped for now. --> </xsl:template> - <!-- xsl:template match="p/text()"> - <xsl:value-of select="normalize-space()"/> - </xsl:template--> + + <!-- Authors --> + <xsl:template match="authors"> + <xsl:text> .SH AUTHORS</xsl:text> + <xsl:apply-templates/> + </xsl:template> + + <!-- Aname --> + <xsl:template match="authors/aname"> + <xsl:text> .LP </xsl:text> + <xsl:apply-templates/> + </xsl:template> + + <!-- Email --> + <xsl:template match="authors/email"> + <xsl:text> .I <</xsl:text> + <xsl:apply-templates/> + <xsl:text>></xsl:text> + </xsl:template> + + <!-- Replace ' by \&' ans . by \&. --> + <xsl:template match="text()"> + <!-- xsl:variable name="content"> + <xsl:choose> + <xsl:when test="ancestor::code or ancestor::c"> + <xsl:value-of select="."/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="normalize-space()"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable--> + + <xsl:variable name="rep1"> + <xsl:call-template name="replace-string"> + <xsl:with-param name="text" select="." /> + <xsl:with-param name="replace" select=""\"" /> + <xsl:with-param name="with" select=""\\"" /> + </xsl:call-template> + </xsl:variable> + <xsl:variable name="rep2"> + <xsl:call-template name="replace-string"> + <xsl:with-param name="text" select="$rep1" /> + <xsl:with-param name="replace" select=""'"" /> + <xsl:with-param name="with" select=""\&'"" /> + </xsl:call-template> + </xsl:variable> + <xsl:call-template name="replace-string"> + <xsl:with-param name="text" select="$rep2" /> + <xsl:with-param name="replace" select=""."" /> + <xsl:with-param name="with" select=""\&."" /> + </xsl:call-template> + </xsl:template> + + <!-- Template replace-string is borrowed at http://www.dpawson.co.uk/xsl/sect2/replace.html --> + <xsl:template name="replace-string"> + <xsl:param name="text"/> + <xsl:param name="replace"/> + <xsl:param name="with"/> + <xsl:choose> + <xsl:when test="contains($text,$replace)"> + <xsl:value-of select="substring-before($text,$replace)"/> + <xsl:value-of select="$with"/> + <xsl:call-template name="replace-string"> + <xsl:with-param name="text" select="substring-after($text,$replace)"/> + <xsl:with-param name="replace" select="$replace"/> + <xsl:with-param name="with" select="$with"/> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$text"/> + </xsl:otherwise> + </xsl:choose> + </xsl:template> <xsl:template match="d/text()"> <xsl:value-of select="normalize-space()"/> diff --git a/lib/erl_docgen/priv/xsl/db_pdf.xsl b/lib/erl_docgen/priv/xsl/db_pdf.xsl index bef86277ea..e12b4d219a 100644 --- a/lib/erl_docgen/priv/xsl/db_pdf.xsl +++ b/lib/erl_docgen/priv/xsl/db_pdf.xsl @@ -2,20 +2,20 @@ <!-- # # %CopyrightBegin% - # - # Copyright Ericsson AB 2009. All Rights Reserved. - # + # + # Copyright Ericsson AB 2009-2010. 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 # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. - # + # # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. - # + # # %CopyrightEnd% --> @@ -229,7 +229,9 @@ <xsl:value-of select="$companyname"/> </fo:block> <fo:block xsl:use-attribute-sets="cover.inner.copyrightnotice"> - The contents of this file are subject to the Erlang Public License, + <xsl:value-of select="/book/header/legalnotice"/> + + <!-- 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 compliance with the License. You should have received a copy of the Erlang Public License along with this software. If not, it can be @@ -241,6 +243,7 @@ under the License. The Initial Developer of the Original Code is +--> <xsl:value-of select="$companyname"/>. </fo:block> <fo:block xsl:use-attribute-sets="cover.inner.date"> @@ -382,7 +385,9 @@ <xsl:choose> <xsl:when test="ancestor::cref"> <fo:bookmark internal-destination="{generate-id(nametext)}" starting-state="hide"> - <xsl:variable name="fname"><xsl:value-of select="substring-before(nametext, '(')"/></xsl:variable> + <xsl:variable name="fname"> + <xsl:value-of select="substring-before(nametext, '(')"/> + </xsl:variable> <fo:bookmark-title> <xsl:choose> <xsl:when test="string-length($fname) > 0"> @@ -422,8 +427,26 @@ <xsl:with-param name="no-of-pars" select="0"/> </xsl:call-template> </xsl:variable> + + <xsl:variable name="fname"> + <xsl:variable name="fname1"> + <xsl:value-of select="substring-before(., '(')"/> + </xsl:variable> + <xsl:variable name="fname2"> + <xsl:value-of select="substring-after($fname1, 'erlang:')"/> + </xsl:variable> + <xsl:choose> + <xsl:when test="string-length($fname2) > 0"> + <xsl:value-of select="$fname2"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$fname1"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + <fo:bookmark-title> - <xsl:value-of select="substring-before(., '(')"/>/<xsl:value-of select="$arity"/> + <xsl:value-of select="$fname"/>/<xsl:value-of select="$arity"/> </fo:bookmark-title> </fo:bookmark> </xsl:when> @@ -668,12 +691,12 @@ <xsl:number level="any" from="part" count="code"/> </xsl:variable> - <fo:block xsl:use-attribute-sets="code" margin-left="1.5em"> + <fo:block xsl:use-attribute-sets="code"> <xsl:apply-templates select="text()"/> </fo:block> <xsl:if test="@caption"> - <fo:block xsl:use-attribute-sets="caption" margin-left="1.5em"> + <fo:block xsl:use-attribute-sets="caption"> Code listing <xsl:value-of select="$partnum"/>.<xsl:value-of select="$codenum"/>:  <xsl:value-of select="@caption"/> </fo:block> @@ -687,12 +710,12 @@ <xsl:number level="any" from="part" count="code"/> </xsl:variable> - <fo:block xsl:use-attribute-sets="code" margin-left="1.5em"> + <fo:block xsl:use-attribute-sets="code"> <xsl:apply-templates/> </fo:block> <xsl:if test="@caption"> - <fo:block xsl:use-attribute-sets="caption" margin-left="1.5em"> + <fo:block xsl:use-attribute-sets="caption"> Code listing <xsl:value-of select="$partnum"/>.<xsl:value-of select="$codenum"/>:  <xsl:value-of select="@caption"/> </fo:block> @@ -862,7 +885,7 @@ <!-- Funcs --> <xsl:template match="funcs"> - + <xsl:param name="partnum"/> <fo:block xsl:use-attribute-sets="h3"> <xsl:text>Exports</xsl:text> </fo:block> @@ -958,6 +981,7 @@ <!-- Desc --> <xsl:template match="desc"> + <xsl:param name="partnum"/> <xsl:apply-templates> <xsl:with-param name="partnum" select="$partnum"/> @@ -1103,27 +1127,62 @@ <xsl:template name="remove-paren"> <xsl:param name="string"/> + + <xsl:variable name="str1"> + <xsl:call-template name="remove-paren-1"> + <xsl:with-param name="string" select="$string"/> + <xsl:with-param name="start">(</xsl:with-param> + <xsl:with-param name="end">)</xsl:with-param> + </xsl:call-template> + </xsl:variable> + + <xsl:variable name="str2"> + <xsl:call-template name="remove-paren-1"> + <xsl:with-param name="string" select="$str1"/> + <xsl:with-param name="start">{</xsl:with-param> + <xsl:with-param name="end">}</xsl:with-param> + </xsl:call-template> + </xsl:variable> + + <xsl:variable name="str3"> + <xsl:call-template name="remove-paren-1"> + <xsl:with-param name="string" select="$str2"/> + <xsl:with-param name="start">[</xsl:with-param> + <xsl:with-param name="end">]</xsl:with-param> + </xsl:call-template> + </xsl:variable> + + <xsl:value-of select="$str3"/> + + </xsl:template> + + + <xsl:template name="remove-paren-1"> + <xsl:param name="string"/> + <xsl:param name="start"/> + <xsl:param name="end"/> - <xsl:variable name="bstring"> - <xsl:value-of select="substring-before($string, '(')"/> + <xsl:variable name="tmp1"> + <xsl:value-of select="substring-before($string, $start)"/> </xsl:variable> <xsl:choose> - <xsl:when test="string-length($bstring) > 0"> - <xsl:variable name="astring"> - <xsl:value-of select="substring-after($string, ')')"/> + <xsl:when test="string-length($tmp1) > 0 or starts-with($string, $start)"> + <xsl:variable name="tmp2"> + <xsl:value-of select="substring-after($string, $end)"/> </xsl:variable> <xsl:variable name="retstring"> <xsl:call-template name="remove-paren"> - <xsl:with-param name="string" select="$astring"/> + <xsl:with-param name="string" select="$tmp2"/> </xsl:call-template> </xsl:variable> - <xsl:value-of select="concat($bstring, $retstring)"/> + <xsl:value-of select="concat(concat($tmp1, 'x'), $retstring)"/> </xsl:when> <xsl:otherwise> <xsl:value-of select="$string"/> </xsl:otherwise> </xsl:choose> + </xsl:template> </xsl:stylesheet> diff --git a/lib/erl_docgen/priv/xsl/db_pdf_params.xsl b/lib/erl_docgen/priv/xsl/db_pdf_params.xsl index e2e264b90a..7de20f2092 100644 --- a/lib/erl_docgen/priv/xsl/db_pdf_params.xsl +++ b/lib/erl_docgen/priv/xsl/db_pdf_params.xsl @@ -2,20 +2,20 @@ <!-- # # %CopyrightBegin% - # - # Copyright Ericsson AB 2009. All Rights Reserved. - # + # + # Copyright Ericsson AB 2009-2010. 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 # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. - # + # # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. - # + # # %CopyrightEnd% --> @@ -110,7 +110,7 @@ <xsl:attribute-set name="cover.inner.copyrightnotice"> <xsl:attribute name="font-size">0.9em</xsl:attribute> - <xsl:attribute name="font-weight">bold</xsl:attribute> + <!-- xsl:attribute name="font-weight">bold</xsl:attribute --> </xsl:attribute-set> <xsl:attribute-set name="cover.inner.date"> @@ -248,6 +248,8 @@ <xsl:attribute name="padding-after">1em</xsl:attribute> <xsl:attribute name="space-after">1em</xsl:attribute> <xsl:attribute name="space-before">2em</xsl:attribute> + <xsl:attribute name="margin-left">0.5em</xsl:attribute> + <xsl:attribute name="margin-right">0.5em</xsl:attribute> <xsl:attribute name="white-space-collapse">false</xsl:attribute> <xsl:attribute name="white-space-treatment">preserve</xsl:attribute> <xsl:attribute name="wrap-option">no-wrap</xsl:attribute> @@ -266,8 +268,10 @@ <xsl:attribute name="text-align">justify</xsl:attribute> <xsl:attribute name="padding-before">1em</xsl:attribute> <xsl:attribute name="padding-after">0.3em</xsl:attribute> - <xsl:attribute name="padding-left">1em</xsl:attribute> - <xsl:attribute name="padding-right">1em</xsl:attribute> + <xsl:attribute name="padding-left">0.5em</xsl:attribute> + <xsl:attribute name="padding-right">0.5em</xsl:attribute> + <xsl:attribute name="margin-left">0.5em</xsl:attribute> + <xsl:attribute name="margin-right">0.5em</xsl:attribute> <xsl:attribute name="keep-together.within-page">always</xsl:attribute> </xsl:attribute-set> @@ -278,8 +282,10 @@ <xsl:attribute name="text-align">justify</xsl:attribute> <xsl:attribute name="padding-before">1em</xsl:attribute> <xsl:attribute name="padding-after">0.3em</xsl:attribute> - <xsl:attribute name="padding-left">1em</xsl:attribute> - <xsl:attribute name="padding-right">1em</xsl:attribute> + <xsl:attribute name="padding-left">0.5em</xsl:attribute> + <xsl:attribute name="padding-right">0.5em</xsl:attribute> + <xsl:attribute name="margin-left">0.5em</xsl:attribute> + <xsl:attribute name="margin-right">0.5em</xsl:attribute> <xsl:attribute name="keep-together.within-page">always</xsl:attribute> </xsl:attribute-set> diff --git a/lib/et/doc/src/Makefile b/lib/et/doc/src/Makefile index bcbde437d1..6bb8164e91 100644 --- a/lib/et/doc/src/Makefile +++ b/lib/et/doc/src/Makefile @@ -1,19 +1,19 @@ # # %CopyrightBegin% -# -# Copyright Ericsson AB 2002-2009. All Rights Reserved. -# +# +# Copyright Ericsson AB 2002-2010. 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 # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. -# +# # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. -# +# # %CopyrightEnd% # @@ -41,6 +41,9 @@ include files.mk # ---------------------------------------------------- +XML_FILES = $(BOOK_FILES) $(XML_APPLICATION_FILES) $(XML_REF3_FILES) \ + $(XML_PART_FILES) $(XML_CHAPTER_FILES) + HTML_FILES = $(XML_APPLICATION_FILES:%.xml=$(HTMLDIR)/%.html) \ $(XML_PART_FILES:%.xml=$(HTMLDIR)/%.html) @@ -60,7 +63,7 @@ XML_FLAGS += # ---------------------------------------------------- # Targets # ---------------------------------------------------- -$(HTMLDIR)/%.gif: %.gif +$(HTMLDIR)/%: % $(INSTALL_DATA) $< $@ docs: pdf html man @@ -69,9 +72,14 @@ $(TOP_PDF_FILE): $(XML_FILES) pdf: $(TOP_PDF_FILE) -html: gifs $(HTML_REF_MAN_FILE) +html: images $(HTML_REF_MAN_FILE) clean clean_docs: + for file in $(XML_FILES); do \ + if [ -f $$file\src ]; then \ + rm -f $$file; \ + fi \ + done rm -rf $(HTMLDIR)/* rm -f $(MAN3DIR)/* rm -f $(TOP_PDF_FILE) $(TOP_PDF_FILE:%.pdf=%.fo) @@ -79,7 +87,7 @@ clean clean_docs: man: $(MAN3_FILES) -gifs: $(GIF_FILES:%=$(HTMLDIR)/%) +images: $(IMAGE_FILES:%=$(HTMLDIR)/%) debug opt: diff --git a/lib/eunit/doc/src/Makefile b/lib/eunit/doc/src/Makefile index faf2f9a847..19be96d763 100644 --- a/lib/eunit/doc/src/Makefile +++ b/lib/eunit/doc/src/Makefile @@ -123,11 +123,10 @@ man: $(MAN3_FILES) gifs: $(GIF_FILES:%=$(HTMLDIR)/%) $(XML_REF3_FILES): - docb_gen -def vsn $(EUNIT_VSN) -includes $(EUNIT_INC_DIR) $(EUNIT_DIR)/$(@:%.xml=%.erl) + escript $(DOCGEN)/priv/bin/xml_from_edoc.escript -def vsn $(EUNIT_VSN) -i $(EUNIT_INC_DIR) $(EUNIT_DIR)/$(@:%.xml=%.erl) $(XML_CHAPTER_FILES): - docb_gen -chapter -def vsn $(EUNIT_VSN) ../overview.edoc - + escript $(DOCGEN)/priv/bin/xml_from_edoc.escript -def vsn $(EUNIT_VSN) -chapter ../overview.edoc info: @echo "XML_PART_FILES: $(XML_PART_FILES)" diff --git a/lib/hipe/Makefile b/lib/hipe/Makefile index be3a618e34..10bf82b2d7 100644 --- a/lib/hipe/Makefile +++ b/lib/hipe/Makefile @@ -1,19 +1,19 @@ # # %CopyrightBegin% -# -# Copyright Ericsson AB 2001-2009. All Rights Reserved. -# +# +# Copyright Ericsson AB 2001-2010. 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 # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. -# +# # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. -# +# # %CopyrightEnd% # SHELL=/bin/sh @@ -42,15 +42,13 @@ endif # include $(ERL_TOP)/make/otp_subdir.mk -# This overrides the default recursive-make edocs target in otp_subdir.mk -# It is not pretty, but it will have to do for now. -docs: +# The overriding docs target have been removed so the default make rules work properly. + +edocs: @if [ -d $(ERL_TOP)/lib/edoc/ebin ]; then \ erl -noshell -pa $(ERL_TOP)/lib/edoc/ebin $(ERL_TOP)/lib/syntax_tools/ebin $(ERL_TOP)/lib/xmerl/ebin -run edoc_run application 'hipe' '"."' '[new,no_packages]' -s init stop ; \ fi -edocs: docs - all-subdirs: -for dir in $(SUB_DIRECTORIES); do \ (cd $$dir; $(MAKE) $(MAKETARGET) EBIN=../ebin; cd ..); \ diff --git a/lib/hipe/amd64/Makefile b/lib/hipe/amd64/Makefile index 93e5f086d9..58377e5349 100644 --- a/lib/hipe/amd64/Makefile +++ b/lib/hipe/amd64/Makefile @@ -1,19 +1,19 @@ # # %CopyrightBegin% -# -# Copyright Ericsson AB 2004-2009. All Rights Reserved. -# +# +# Copyright Ericsson AB 2004-2010. 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 # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. -# +# # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. -# +# # %CopyrightEnd% # @@ -80,7 +80,10 @@ ERL_COMPILE_FLAGS += -DHIPE_AMD64 +warn_exported_vars debug opt: $(TARGET_FILES) -docs: $(DOC_FILES) +docs: + +# Moved docs target to edocs so the standard docs rule work properly. +edocs: $(DOC_FILES) clean: rm -f $(TARGET_FILES) diff --git a/lib/hipe/arm/Makefile b/lib/hipe/arm/Makefile index 571a1da0fc..3f60cd77cc 100644 --- a/lib/hipe/arm/Makefile +++ b/lib/hipe/arm/Makefile @@ -1,19 +1,19 @@ # # %CopyrightBegin% -# -# Copyright Ericsson AB 2005-2009. All Rights Reserved. -# +# +# Copyright Ericsson AB 2005-2010. 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 # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. -# +# # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. -# +# # %CopyrightEnd% # @@ -81,7 +81,10 @@ ERL_COMPILE_FLAGS += +warn_exported_vars debug opt: $(TARGET_FILES) -docs: $(DOC_FILES) +docs: + +# Moved docs target to edocs so the standard docs rule work properly. +edocs: $(DOC_FILES) clean: rm -f $(TARGET_FILES) diff --git a/lib/hipe/cerl/Makefile b/lib/hipe/cerl/Makefile index fb7ca1153b..7fcc44d27d 100644 --- a/lib/hipe/cerl/Makefile +++ b/lib/hipe/cerl/Makefile @@ -1,19 +1,19 @@ # # %CopyrightBegin% -# -# Copyright Ericsson AB 2003-2009. All Rights Reserved. -# +# +# Copyright Ericsson AB 2003-2010. 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 # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. -# +# # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. -# +# # %CopyrightEnd% # @@ -73,7 +73,10 @@ ERL_COMPILE_FLAGS += +inline +warn_exported_vars +warn_unused_import +warn_missi debug opt: $(TARGET_FILES) -docs: $(DOC_FILES) +docs: + +# Moved docs target to edocs so the standard docs rule work properly. +edocs: $(DOC_FILES) clean: rm -f $(TARGET_FILES) diff --git a/lib/hipe/flow/Makefile b/lib/hipe/flow/Makefile index 5b9d0b7582..91dcfda6f5 100644 --- a/lib/hipe/flow/Makefile +++ b/lib/hipe/flow/Makefile @@ -1,19 +1,19 @@ # # %CopyrightBegin% -# -# Copyright Ericsson AB 2001-2009. All Rights Reserved. -# +# +# Copyright Ericsson AB 2001-2010. 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 # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. -# +# # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. -# +# # %CopyrightEnd% # @@ -73,7 +73,10 @@ ERL_COMPILE_FLAGS += +warn_exported_vars +warn_missing_spec +warn_untyped_record debug opt: $(TARGET_FILES) -docs: $(DOC_FILES) +docs: + +# Moved docs target to edocs so the standard docs rule work properly. +edocs: $(DOC_FILES) clean: rm -f $(TARGET_FILES) diff --git a/lib/hipe/icode/Makefile b/lib/hipe/icode/Makefile index de37c4e4c4..eced90b0ec 100644 --- a/lib/hipe/icode/Makefile +++ b/lib/hipe/icode/Makefile @@ -1,19 +1,19 @@ # # %CopyrightBegin% -# -# Copyright Ericsson AB 2001-2009. All Rights Reserved. -# +# +# Copyright Ericsson AB 2001-2010. 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 # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. -# +# # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. -# +# # %CopyrightEnd% # @@ -91,7 +91,10 @@ ERL_COMPILE_FLAGS += +warn_unused_import +warn_missing_spec +warn_untyped_record debug opt: $(TARGET_FILES) -docs: $(DOC_FILES) +docs: + +# Moved docs target to edocs so the standard docs rule work properly. +edocs: $(DOC_FILES) clean: rm -f $(TARGET_FILES) diff --git a/lib/hipe/main/Makefile b/lib/hipe/main/Makefile index 0ac522b1b2..a14c9c3ca4 100644 --- a/lib/hipe/main/Makefile +++ b/lib/hipe/main/Makefile @@ -1,19 +1,19 @@ # # %CopyrightBegin% -# -# Copyright Ericsson AB 2001-2009. All Rights Reserved. -# +# +# Copyright Ericsson AB 2001-2010. 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 # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. -# +# # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. -# +# # %CopyrightEnd% # @@ -83,7 +83,11 @@ $(EBIN)/hipe_main.beam: hipe.hrl ../icode/hipe_icode.hrl #../rtl/hipe_rtl.hrl debug opt: $(TARGET_FILES) -docs: $(DOC_FILES) +docs: + +# Moved docs target to edocs so the standard docs rule work properly. + +edocs: $(DOC_FILES) clean: rm -f $(TARGET_FILES) $(DOC_FILES) $(HRL_FILES) diff --git a/lib/hipe/misc/Makefile b/lib/hipe/misc/Makefile index d5c395855a..98a69d62c7 100644 --- a/lib/hipe/misc/Makefile +++ b/lib/hipe/misc/Makefile @@ -1,19 +1,19 @@ # # %CopyrightBegin% -# -# Copyright Ericsson AB 2001-2009. All Rights Reserved. -# +# +# Copyright Ericsson AB 2001-2010. 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 # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. -# +# # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. -# +# # %CopyrightEnd% # @@ -76,7 +76,10 @@ ERL_COMPILE_FLAGS += +warn_exported_vars +warn_missing_spec +warn_untyped_record debug opt: $(TARGET_FILES) -docs: $(DOC_FILES) +docs: + +# Moved docs target to edocs so the standard docs rule work properly. +edocs: $(DOC_FILES) clean: rm -f $(TARGET_FILES) diff --git a/lib/hipe/opt/Makefile b/lib/hipe/opt/Makefile index 972cf63944..74fde26c0b 100644 --- a/lib/hipe/opt/Makefile +++ b/lib/hipe/opt/Makefile @@ -1,19 +1,19 @@ # # %CopyrightBegin% -# -# Copyright Ericsson AB 2001-2009. All Rights Reserved. -# +# +# Copyright Ericsson AB 2001-2010. 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 # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. -# +# # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. -# +# # %CopyrightEnd% # @@ -71,7 +71,10 @@ ERL_COMPILE_FLAGS += +warn_exported_vars +warn_missing_spec +warn_untyped_record debug opt: $(TARGET_FILES) -docs: $(DOC_FILES) +docs: + +# Moved docs target to edocs so the standard docs rule work properly. +edocs: $(DOC_FILES) clean: rm -f $(TARGET_FILES) diff --git a/lib/hipe/ppc/Makefile b/lib/hipe/ppc/Makefile index 0857043527..f24139e34b 100644 --- a/lib/hipe/ppc/Makefile +++ b/lib/hipe/ppc/Makefile @@ -1,19 +1,19 @@ # # %CopyrightBegin% -# -# Copyright Ericsson AB 2004-2009. All Rights Reserved. -# +# +# Copyright Ericsson AB 2004-2010. 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 # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. -# +# # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. -# +# # %CopyrightEnd% # @@ -83,7 +83,10 @@ ERL_COMPILE_FLAGS += +warn_exported_vars debug opt: $(TARGET_FILES) -docs: $(DOC_FILES) +docs: + +# Moved docs target to edocs so the standard docs rule work properly. +edocs: $(DOC_FILES) clean: rm -f $(TARGET_FILES) diff --git a/lib/hipe/regalloc/Makefile b/lib/hipe/regalloc/Makefile index 5ab70d1837..386f3589c6 100644 --- a/lib/hipe/regalloc/Makefile +++ b/lib/hipe/regalloc/Makefile @@ -1,19 +1,19 @@ # # %CopyrightBegin% -# -# Copyright Ericsson AB 2001-2009. All Rights Reserved. -# +# +# Copyright Ericsson AB 2001-2010. 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 # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. -# +# # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. -# +# # %CopyrightEnd% # @@ -84,7 +84,11 @@ ERL_COMPILE_FLAGS += +warn_exported_vars# +warn_missing_spec +warn_untyped_recor debug opt: $(TARGET_FILES) -docs: $(DOC_FILES) +docs: + +# Moved docs target to edocs so the standard docs rule work properly. + +edocs: $(DOC_FILES) clean: rm -f $(TARGET_FILES) diff --git a/lib/hipe/sparc/Makefile b/lib/hipe/sparc/Makefile index efd4996046..f25212a89b 100644 --- a/lib/hipe/sparc/Makefile +++ b/lib/hipe/sparc/Makefile @@ -1,19 +1,19 @@ # # %CopyrightBegin% -# -# Copyright Ericsson AB 2001-2009. All Rights Reserved. -# +# +# Copyright Ericsson AB 2001-2010. 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 # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. -# +# # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. -# +# # %CopyrightEnd% # @@ -83,7 +83,10 @@ ERL_COMPILE_FLAGS += +warn_exported_vars debug opt: $(TARGET_FILES) -docs: $(DOC_FILES) +docs: + +# Moved docs target to edocs so the standard docs rule work properly. +edocs: $(DOC_FILES) clean: rm -f $(TARGET_FILES) diff --git a/lib/hipe/tools/Makefile b/lib/hipe/tools/Makefile index 6ce5cb1b8b..0eaa3a7b05 100644 --- a/lib/hipe/tools/Makefile +++ b/lib/hipe/tools/Makefile @@ -1,19 +1,19 @@ # # %CopyrightBegin% -# -# Copyright Ericsson AB 2002-2009. All Rights Reserved. -# +# +# Copyright Ericsson AB 2002-2010. 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 # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. -# +# # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. -# +# # %CopyrightEnd% # @@ -72,7 +72,10 @@ ERL_COMPILE_FLAGS += +warn_exported_vars +warn_missing_spec +warn_untyped_record debug opt: $(TARGET_FILES) -docs: $(DOC_FILES) +docs: + +# Moved docs target to edocs so the standard docs rule work properly. +edocs: $(DOC_FILES) clean: rm -f $(TARGET_FILES) diff --git a/lib/hipe/util/Makefile b/lib/hipe/util/Makefile index 27cacedf11..85719ec3d6 100644 --- a/lib/hipe/util/Makefile +++ b/lib/hipe/util/Makefile @@ -1,19 +1,19 @@ # # %CopyrightBegin% -# -# Copyright Ericsson AB 2001-2009. All Rights Reserved. -# +# +# Copyright Ericsson AB 2001-2010. 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 # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. -# +# # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. -# +# # %CopyrightEnd% # @@ -76,7 +76,10 @@ ERL_COMPILE_FLAGS += +warn_exported_vars +warn_missing_spec +warn_untyped_record debug opt: $(TARGET_FILES) -docs: $(DOC_FILES) +docs: + +# Moved docs target to edocs so the standard docs rule work properly. +edocs: $(DOC_FILES) clean: rm -f $(TARGET_FILES) diff --git a/lib/hipe/x86/Makefile b/lib/hipe/x86/Makefile index 065b56fce3..d7d0c7bf5a 100644 --- a/lib/hipe/x86/Makefile +++ b/lib/hipe/x86/Makefile @@ -1,19 +1,19 @@ # # %CopyrightBegin% -# -# Copyright Ericsson AB 2001-2009. All Rights Reserved. -# +# +# Copyright Ericsson AB 2001-2010. 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 # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. -# +# # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. -# +# # %CopyrightEnd% # @@ -91,7 +91,10 @@ ERL_COMPILE_FLAGS += +warn_exported_vars debug opt: $(TARGET_FILES) -docs: $(DOC_FILES) +docs: + +# Moved docs target to edocs so the standard docs rule work properly. +edocs: $(DOC_FILES) clean: rm -f $(TARGET_FILES) diff --git a/lib/jinterface/doc/src/Makefile b/lib/jinterface/doc/src/Makefile index c4cfde0e9c..acd5307dee 100644 --- a/lib/jinterface/doc/src/Makefile +++ b/lib/jinterface/doc/src/Makefile @@ -2,20 +2,20 @@ # # %CopyrightBegin% -# -# Copyright Ericsson AB 2000-2009. All Rights Reserved. -# +# +# Copyright Ericsson AB 2000-2010. 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 # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. -# +# # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. -# +# # %CopyrightEnd% # include $(ERL_TOP)/make/target.mk @@ -53,6 +53,9 @@ XML_CHAPTER_FILES = \ BOOK_FILES = book.xml +XML_FILES = $(BOOK_FILES) $(XML_APPLICATION_FILES) $(XML_REF3_FILES) \ + $(XML_PART_FILES) $(XML_CHAPTER_FILES) + GIF_FILES = \ notes.gif \ ref_man.gif \ diff --git a/lib/odbc/doc/src/Makefile b/lib/odbc/doc/src/Makefile index 136ddfb980..e2f09733d0 100644 --- a/lib/odbc/doc/src/Makefile +++ b/lib/odbc/doc/src/Makefile @@ -1,19 +1,19 @@ # # %CopyrightBegin% -# -# Copyright Ericsson AB 1999-2009. All Rights Reserved. -# +# +# Copyright Ericsson AB 1999-2010. 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 # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. -# +# # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. -# +# # %CopyrightEnd% # @@ -63,6 +63,9 @@ XML_CHAPTER_FILES = \ BOOK_FILES = book.xml +XML_FILES = $(BOOK_FILES) $(XML_APPLICATION_FILES) $(XML_REF3_FILES) \ + $(XML_PART_FILES) $(XML_CHAPTER_FILES) + GIF_FILES = \ book.gif \ odbc.gif \ diff --git a/lib/percept/doc/src/Makefile b/lib/percept/doc/src/Makefile index c841d17c01..f0d43c5a01 100644 --- a/lib/percept/doc/src/Makefile +++ b/lib/percept/doc/src/Makefile @@ -1,19 +1,19 @@ # # %CopyrightBegin% -# -# Copyright Ericsson AB 2007-2009. All Rights Reserved. -# +# +# Copyright Ericsson AB 2007-2010. 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 # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. -# +# # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. -# +# # %CopyrightEnd% # @@ -153,10 +153,10 @@ gifs: $(GIF_FILES:%=$(HTMLDIR)/%) xml: $(MODULE_XML_FILES) $(PERCEPT_XML_FILES): - docb_gen $(PERCEPT_DIR)/$(@:%.xml=%.erl) + escript $(DOCGEN)/priv/bin/xml_from_edoc.escript $(PERCEPT_DIR)/$(@:%.xml=%.erl) $(RUNTIME_TOOLS_XML_FILES): - docb_gen $(RUNTIME_TOOLS_DIR)/$(@:%.xml=%.erl) + escript $(DOCGEN)/priv/bin/xml_from_edoc.escript $(RUNTIME_TOOLS_DIR)/$(@:%.xml=%.erl) info: @echo "XML_PART_FILES: $(XML_PART_FILES)" diff --git a/lib/reltool/test/Makefile b/lib/reltool/test/Makefile new file mode 100644 index 0000000000..00d2add3e5 --- /dev/null +++ b/lib/reltool/test/Makefile @@ -0,0 +1,82 @@ +# +# %CopyrightBegin% +# +# Copyright Ericsson AB 2009. 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 +# compliance with the License. You should have received a copy of the +# Erlang Public License along with this software. If not, it can be +# retrieved online at http://www.erlang.org/. +# +# Software distributed under the License is distributed on an "AS IS" +# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +# the License for the specific language governing rights and limitations +# under the License. +# +# %CopyrightEnd% + +include $(ERL_TOP)/make/target.mk +include $(ERL_TOP)/make/$(TARGET)/otp.mk + +# ---------------------------------------------------- +# Target Specs +# ---------------------------------------------------- + +MODULES= \ + rtt \ + reltool_wx_SUITE \ + reltool_server_SUITE \ + reltool_test_lib + + +ERL_FILES= $(MODULES:%=%.erl) + +HRL_FILES= reltool_test_lib.hrl + +TARGET_FILES= \ + $(MODULES:%=$(EBIN)/%.$(EMULATOR)) + +INSTALL_PROGS= $(TARGET_FILES) + +# ---------------------------------------------------- +# Release directory specification +# ---------------------------------------------------- +RELSYSDIR = $(RELEASE_PATH)/reltool_test + +# ---------------------------------------------------- +# FLAGS +# ---------------------------------------------------- +#ERL_COMPILE_FLAGS += + +EBIN = . + +# ---------------------------------------------------- +# Targets +# ---------------------------------------------------- + +tests debug opt: $(TARGET_FILES) + +clean: + rm -f $(TARGET_FILES) + rm -f core + +docs: + +# ---------------------------------------------------- +# Release Target +# ---------------------------------------------------- +include $(ERL_TOP)/make/otp_release_targets.mk + +release_spec: opt + +release_tests_spec: opt + $(INSTALL_DIR) $(RELSYSDIR) + $(INSTALL_DATA) reltool.spec $(ERL_FILES) $(HRL_FILES) $(RELSYSDIR) + $(INSTALL_PROGRAM) rtt $(INSTALL_PROGS) $(RELSYSDIR) +# chmod -f -R u+w $(RELSYSDIR) +# @tar cf - *_SUITE_data | (cd $(RELSYSDIR); tar xf -) + +release_docs_spec: + + diff --git a/lib/reltool/test/README b/lib/reltool/test/README new file mode 100644 index 0000000000..031bd2c961 --- /dev/null +++ b/lib/reltool/test/README @@ -0,0 +1,30 @@ + +Testing and running reltool tests. + +Testing gui api/applications can be hard, but we can at least +test that wxerlang behaves as we expected, i.e. that the api +is consistent and that it don't crash. + +The tests are structured as they are because we want you to +be able to run them in three different ways. + - direct via an erlang shell + - via common_test application + - via erlang/OTP inhouse ts tool. + +To run all the tests compile them and on unix +run ./rtt to create an erlang terminal. + +Invoke rtt:t(). in the erlang shell to run all regression tests. +If you want to specific tests invoke rtt:t(Module) +or rtt:t(Module, TestCase). + +To run all tests including the ones that require manual intervention run. +rtt:t(all, [{user,true}]). + +To see every test_case window use +rtt:t(all, [{user,step}]). +This requires that you manually close each window to step to the +next test_case. + +If you want to run specific test_cases use: +rtt:t({Module,TestCase}, [{user,step}]). diff --git a/lib/reltool/test/reltool.spec b/lib/reltool/test/reltool.spec new file mode 100644 index 0000000000..252232e09d --- /dev/null +++ b/lib/reltool/test/reltool.spec @@ -0,0 +1,2 @@ +{topcase, {dir, "../reltool_test"}}. + diff --git a/lib/reltool/test/reltool_server_SUITE.erl b/lib/reltool/test/reltool_server_SUITE.erl new file mode 100644 index 0000000000..cf951191a0 --- /dev/null +++ b/lib/reltool/test/reltool_server_SUITE.erl @@ -0,0 +1,494 @@ +%% +%% %CopyrightBegin% +%% +%% Copyright Ericsson AB 2009. 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 +%% compliance with the License. You should have received a copy of the +%% Erlang Public License along with this software. If not, it can be +%% retrieved online at http://www.erlang.org/. +%% +%% Software distributed under the License is distributed on an "AS IS" +%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +%% the License for the specific language governing rights and limitations +%% under the License. +%% +%% %CopyrightEnd% + +-module(reltool_server_SUITE). + +-export([all/0, init_per_suite/1, end_per_suite/1, + init_per_testcase/2, fin_per_testcase/2, end_per_testcase/2]). + +-compile(export_all). + +-include("reltool_test_lib.hrl"). + +-define(NODE_NAME, '__RELTOOL__TEMPORARY_TEST__NODE__'). + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Initialization functions. + +init_per_suite(Config) -> + reltool_test_lib:init_per_suite(Config). + +end_per_suite(Config) -> + reltool_test_lib:end_per_suite(Config). + +init_per_testcase(Func,Config) -> + reltool_test_lib:init_per_testcase(Func,Config). +end_per_testcase(Func,Config) -> + reltool_test_lib:end_per_testcase(Func,Config). +fin_per_testcase(Func,Config) -> %% For test_server + reltool_test_lib:end_per_testcase(Func,Config). + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% SUITE specification + +all() -> + all(suite). +all(suite) -> + [ + start_server, + set_config, + create_release, + create_script, + create_target, + create_embedded, + create_standalone, + create_old_target + ]. + +%% The test cases + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Start a server process and check that it does not crash + +start_server(TestInfo) when is_atom(TestInfo) -> + reltool_test_lib:tc_info(TestInfo); +start_server(_Config) -> + {ok, Pid} = ?msym({ok, _}, reltool:start_server([])), + Libs = lists:sort(erl_libs()), + StrippedDefault = + case Libs of + [] -> {sys, []}; + _ -> {sys, [{lib_dirs, Libs}]} + end, + ?m({ok, StrippedDefault}, reltool:get_config(Pid)), + ?m(ok, reltool:stop(Pid)), + ok. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Start a server process and check that it does not crash + +set_config(TestInfo) when is_atom(TestInfo) -> + reltool_test_lib:tc_info(TestInfo); +set_config(_Config) -> + Libs = lists:sort(erl_libs()), + Default = + {sys, + [ + {mod_cond, all}, + {incl_cond, derived}, + {root_dir, code:root_dir()}, + {lib_dirs, Libs} + ]}, + {ok, Pid} = ?msym({ok, _}, reltool:start_server([{config, Default}])), + StrippedDefault = + case Libs of + [] -> {sys, []}; + _ -> {sys, [{lib_dirs, Libs}]} + end, + ?m({ok, StrippedDefault}, reltool:get_config(Pid)), + + ?m(ok, reltool:stop(Pid)), + ok. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Generate releases + +create_release(TestInfo) when is_atom(TestInfo) -> + reltool_test_lib:tc_info(TestInfo); +create_release(_Config) -> + %% Configure the server + RelName = "Just testing...", + RelVsn = "1.0", + Config = + {sys, + [ + {lib_dirs, []}, + {boot_rel, RelName}, + {rel, RelName, RelVsn, [kernel, stdlib]} + ]}, + %% Generate release + ErtsVsn = erlang:system_info(version), + Apps = application:loaded_applications(), + {value, {_, _, KernelVsn}} = lists:keysearch(kernel, 1, Apps), + {value, {_, _, StdlibVsn}} = lists:keysearch(stdlib, 1, Apps), + Rel = {release, {RelName, RelVsn}, + {erts, ErtsVsn}, + [{kernel, KernelVsn}, + {stdlib, StdlibVsn}]}, + ?m({ok, Rel}, reltool:get_rel([{config, Config}], RelName)), + ok. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Generate boot scripts + +create_script(TestInfo) when is_atom(TestInfo) -> + reltool_test_lib:tc_info(TestInfo); +create_script(_Config) -> + %% Configure the server + RelName = "Just testing", + RelVsn = "1.0", + Config = + {sys, + [ + {lib_dirs, []}, + {boot_rel, RelName}, + {rel, RelName, RelVsn, [stdlib, kernel]} + ]}, + {ok, Pid} = ?msym({ok, _}, reltool:start_server([{config, Config}])), + + %% Generate release file + ErtsVsn = erlang:system_info(version), + Apps = application:loaded_applications(), + {value, {_, _, KernelVsn}} = lists:keysearch(kernel, 1, Apps), + {value, {_, _, StdlibVsn}} = lists:keysearch(stdlib, 1, Apps), + Rel = {release, + {RelName, RelVsn}, + {erts, ErtsVsn}, + [{stdlib, StdlibVsn}, {kernel, KernelVsn}]}, + ?m({ok, Rel}, reltool:get_rel(Pid, RelName)), + RelFile = RelName ++ ".rel", + ?m(ok, file:write_file(RelFile, io_lib:format("~p.\n", [Rel]))), + + %% Generate script file + ?m(ok, systools:make_script(RelName, [])), + ScriptFile = RelName ++ ".script", + {ok, [OrigScript]} = ?msym({ok, [_]}, file:consult(ScriptFile)), + {ok, Script} = ?msym({ok, _}, reltool:get_script(Pid, RelName)), + %% OrigScript2 = sort_script(OrigScript), + %% Script2 = sort_script(Script), + %% ?m(OrigScript2, Script2), + + ?m(equal, diff_script(OrigScript, Script)), + + %% Stop server + ?m(ok, reltool:stop(Pid)), + ok. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Generate target system + +create_target(TestInfo) when is_atom(TestInfo) -> + reltool_test_lib:tc_info(TestInfo); +create_target(_Config) -> + %% Configure the server + RelName1 = "Just testing", + RelName2 = "Just testing with SASL", + RelVsn = "1.0", + Config = + {sys, + [ + {root_dir, code:root_dir()}, + {lib_dirs, []}, + {boot_rel, RelName2}, + {rel, RelName1, RelVsn, [stdlib, kernel]}, + {rel, RelName2, RelVsn, [sasl, stdlib, kernel]}, + {app, sasl, [{incl_cond, include}]} + ]}, + + %% Generate target file + TargetDir = "reltool_target_dir_development", + ?m(ok, reltool_utils:recursive_delete(TargetDir)), + ?m(ok, file:make_dir(TargetDir)), + ?m(ok, reltool:create_target([{config, Config}], TargetDir)), + + Erl = filename:join([TargetDir, "bin", "erl"]), + {ok, Node} = ?msym({ok, _}, start_node(?NODE_NAME, Erl)), + ?msym(ok, stop_node(Node)), + + ok. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Generate embedded target system + +create_embedded(TestInfo) when is_atom(TestInfo) -> + reltool_test_lib:tc_info(TestInfo); +create_embedded(_Config) -> + %% Configure the server + RelName1 = "Just testing", + RelName2 = "Just testing with SASL", + RelVsn = "1.0", + Config = + {sys, + [ + {lib_dirs, []}, + {profile, embedded}, + {boot_rel, RelName2}, + {rel, RelName1, RelVsn, [stdlib, kernel]}, + {rel, RelName2, RelVsn, [sasl, stdlib, kernel]}, + {app, sasl, [{incl_cond, include}]} + ]}, + + %% Generate target file + TargetDir = "reltool_target_dir_embedded", + ?m(ok, reltool_utils:recursive_delete(TargetDir)), + ?m(ok, file:make_dir(TargetDir)), + ?m(ok, reltool:create_target([{config, Config}], TargetDir)), + + Erl = filename:join([TargetDir, "bin", "erl"]), + {ok, Node} = ?msym({ok, _}, start_node(?NODE_NAME, Erl)), + ?msym(ok, stop_node(Node)), + + ok. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Generate standalone system + +create_standalone(TestInfo) when is_atom(TestInfo) -> + reltool_test_lib:tc_info(TestInfo); +create_standalone(_Config) -> + %% Configure the server + ExDir = code:lib_dir(reltool, examples), + EscriptName = "display_args", + Escript = filename:join([ExDir, EscriptName]), + Config = + {sys, + [ + {lib_dirs, []}, + {escript, Escript, [{incl_cond, include}]}, + {profile, standalone} + ]}, + + %% Generate target file + TargetDir = "reltool_target_dir_standalone", + ?m(ok, reltool_utils:recursive_delete(TargetDir)), + ?m(ok, file:make_dir(TargetDir)), + ?m(ok, reltool:create_target([{config, Config}], TargetDir)), + + BinDir = filename:join([TargetDir, "bin"]), + Erl = filename:join([BinDir, "erl"]), + {ok, Node} = ?msym({ok, _}, start_node(?NODE_NAME, Erl)), + RootDir = ?ignore(rpc:call(Node, code, root_dir, [])), + ?msym(ok, stop_node(Node)), + + Expected = iolist_to_binary(["Root dir: ", RootDir, "\n" + "Script args: [\"-arg1\",\"arg2\",\"arg3\"]\n", + "Smp: false\n", + "ExitCode:0"]), + io:format("Expected: ~s\n", [Expected]), + ?m(Expected, run(BinDir, EscriptName ++ " -arg1 arg2 arg3")), + + ok. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Generate old type of target system + +create_old_target(TestInfo) when is_atom(TestInfo) -> + reltool_test_lib:tc_info(TestInfo); +create_old_target(_Config) -> + %% Configure the server + RelName1 = "Just testing", + RelName2 = "Just testing with SASL", + RelVsn = "1.0", + Config = + {sys, + [ + {lib_dirs, []}, + {boot_rel, RelName2}, + {rel, RelName1, RelVsn, [stdlib, kernel]}, + {rel, RelName2, RelVsn, [sasl, stdlib, kernel]}, + {relocatable, false}, % Implies explicit old style installation + {app, sasl, [{incl_cond, include}]} + ]}, + + %% Generate target file + TargetDir = "reltool_target_dir_old", + ?m(ok, reltool_utils:recursive_delete(TargetDir)), + ?m(ok, file:make_dir(TargetDir)), + ?m(ok, reltool:create_target([{config, Config}], TargetDir)), + + %% io:format("Will fail on Windows (should patch erl.ini)\n", []), + ?m(ok, reltool:install(RelName2, TargetDir)), + + Erl = filename:join([TargetDir, "bin", "erl"]), + {ok, Node} = ?msym({ok, _}, start_node(?NODE_NAME, Erl)), + ?msym(ok, stop_node(Node)), + + ok. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Library functions + +erl_libs() -> + case os:getenv("ERL_LIBS") of + false -> []; + LibStr -> string:tokens(LibStr, ":;") + end. + +diff_script(Script, Script) -> + equal; +diff_script({script, Rel, Commands1}, {script, Rel, Commands2}) -> + diff_cmds(Commands1, Commands2); +diff_script({script, Rel1, _}, {script, Rel2, _}) -> + {error, {Rel1, Rel2}}. + +diff_cmds([Cmd | Commands1], [Cmd | Commands2]) -> + diff_cmds(Commands1, Commands2); +diff_cmds([Cmd1 | _Commands1], [Cmd2 | _Commands2]) -> + {diff, {expected, Cmd1}, {actual, Cmd2}}; +diff_cmds([], []) -> + equal. + +os_cmd(Cmd) when is_list(Cmd) -> + %% Call the plain os:cmd with an echo command appended to print command status + %% io:format("os:cmd(~p).\n", [Cmd]), + case os:cmd(Cmd++";echo \"#$?\"") of + %% There is (as far as I can tell) only one thing that will match this + %% and that is too silly to ever be used, but... + []-> + {99, []}; + Return-> + %% Find the position of the status code wich is last in the string + %% prepended with # + case string:rchr(Return, $#) of + + %% This happens only if the sh command pipe is somehow interrupted + 0-> + {98, Return}; + + Position-> + Result = string:left(Return,Position - 1), + Status = string:substr(Return,Position + 1, length(Return) - Position - 1), + {list_to_integer(Status), Result} + end + end. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Node handling + +start_node(Name, ErlPath) -> + FullName = full_node_name(Name), + CmdLine = mk_node_cmdline(Name, ErlPath), + io:format("Starting node ~p: ~s~n", [FullName, CmdLine]), + case open_port({spawn, CmdLine}, []) of + Port when is_port(Port) -> + unlink(Port), + erlang:port_close(Port), + case ping_node(FullName, 50) of + ok -> {ok, FullName}; + Other -> exit({failed_to_start_node, FullName, Other}) + end; + Error -> + exit({failed_to_start_node, FullName, Error}) + end. + +stop_node(Node) -> + monitor_node(Node, true), + spawn(Node, fun () -> halt() end), + receive {nodedown, Node} -> ok end. + +mk_node_cmdline(Name) -> + Prog = case catch init:get_argument(progname) of + {ok,[[P]]} -> P; + _ -> exit(no_progname_argument_found) + end, + mk_node_cmdline(Name, Prog). + +mk_node_cmdline(Name, Prog) -> + Static = "-detached -noinput", + Pa = filename:dirname(code:which(?MODULE)), + NameSw = case net_kernel:longnames() of + false -> "-sname "; + true -> "-name "; + _ -> exit(not_distributed_node) + end, + {ok, Pwd} = file:get_cwd(), + NameStr = atom_to_list(Name), + Prog ++ " " + ++ Static ++ " " + ++ NameSw ++ " " ++ NameStr ++ " " + ++ "-pa " ++ Pa ++ " " + ++ "-env ERL_CRASH_DUMP " ++ Pwd ++ "/erl_crash_dump." ++ NameStr ++ " " + ++ "-setcookie " ++ atom_to_list(erlang:get_cookie()). + +full_node_name(PreName) -> + HostSuffix = lists:dropwhile(fun ($@) -> false; (_) -> true end, + atom_to_list(node())), + list_to_atom(atom_to_list(PreName) ++ HostSuffix). + +ping_node(_Node, 0) -> + {error, net_adm}; +ping_node(Node, N) when is_integer(N), N > 0 -> + case catch net_adm:ping(Node) of + pong -> + wait_for_process(Node, code_server, 50); + _ -> + timer:sleep(1000), + ping_node(Node, N-1) + end. + +wait_for_process(_Node, Name, 0) -> + {error, Name}; +wait_for_process(Node, Name, N) when is_integer(N), N > 0 -> + case rpc:call(Node, erlang, whereis, [Name]) of + undefined -> + timer:sleep(1000), + wait_for_process(Node, Name, N-1); + {badrpc, _} = Reason -> + erlang:error({Reason, Node}); + Pid when is_pid(Pid) -> + ok + end. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Run escript + +run(Dir, Cmd0) -> + Cmd = case os:type() of + {win32,_} -> filename:nativename(Dir) ++ "\\" ++ Cmd0; + _ -> Cmd0 + end, + do_run(Dir, Cmd). + +run(Dir, Opts, Cmd0) -> + Cmd = case os:type() of + {win32,_} -> Opts ++ " " ++ filename:nativename(Dir) ++ "\\" ++ Cmd0; + _ -> Opts ++ " " ++ Dir ++ "/" ++ Cmd0 + end, + do_run(Dir, Cmd). + +do_run(Dir, Cmd) -> + io:format("Run: ~p\n", [Cmd]), + Env = [{"PATH",Dir++":"++os:getenv("PATH")}], + Port = open_port({spawn,Cmd}, [exit_status,eof,in,{env,Env}]), + Res = get_data(Port, []), + receive + {Port,{exit_status,ExitCode}} -> + iolist_to_binary([Res,"ExitCode:"++integer_to_list(ExitCode)]) + end. + +get_data(Port, SoFar) -> + receive + {Port,{data,Bytes}} -> + get_data(Port, [SoFar|Bytes]); + {Port,eof} -> + erlang:port_close(Port), + SoFar + end. + +expected_output([data_dir|T], Data) -> + Slash = case os:type() of + {win32,_} -> "\\"; + _ -> "/" + end, + [filename:nativename(Data)++Slash|expected_output(T, Data)]; +expected_output([H|T], Data) -> + [H|expected_output(T, Data)]; +expected_output([], _) -> + []; +expected_output(Bin, _) when is_binary(Bin) -> + Bin. diff --git a/lib/reltool/test/reltool_test_lib.erl b/lib/reltool/test/reltool_test_lib.erl new file mode 100644 index 0000000000..25978294ee --- /dev/null +++ b/lib/reltool/test/reltool_test_lib.erl @@ -0,0 +1,329 @@ +%% +%% %CopyrightBegin% +%% +%% Copyright Ericsson AB 2009. 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 +%% compliance with the License. You should have received a copy of the +%% Erlang Public License along with this software. If not, it can be +%% retrieved online at http://www.erlang.org/. +%% +%% Software distributed under the License is distributed on an "AS IS" +%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +%% the License for the specific language governing rights and limitations +%% under the License. +%% +%% %CopyrightEnd% + +-module(reltool_test_lib). +-compile(export_all). + +-include("reltool_test_lib.hrl"). + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +init_per_suite(Config) when is_list(Config)-> + incr_timetrap(Config, 5). + +end_per_suite(Config) when is_list(Config)-> + ok. + +incr_timetrap(Config, Times) -> + Key = tc_timeout, + KeyPos = 1, + NewTime = + case lists:keysearch(Key, KeyPos, Config) of + {value, {Key, OldTime}} -> + (timer:minutes(1) + OldTime) * Times; + false -> + timer:minutes(1) * Times + end, + lists:keystore(Key, KeyPos, Config, {Key, NewTime}). + +set_kill_timer(Config) -> + case init:get_argument(reltool_test_timeout) of + {ok, _} -> + Config; + _ -> + Time = + case lookup_config(tc_timeout, Config) of + [] -> + timer:minutes(5); + ConfigTime when is_integer(ConfigTime) -> + ConfigTime + end, + WatchDog = test_server:timetrap(Time), + [{kill_timer, WatchDog} | Config] + end. + +reset_kill_timer(Config) -> + DogKiller = + case get(reltool_test_server) of + true -> + fun(P) when is_pid(P) -> P ! stop; + (_) -> ok + end; + _ -> + fun(Ref) -> test_server:timetrap_cancel(Ref) end + end, + case lists:keysearch(kill_timer, 1, Config) of + {value, {kill_timer, WatchDog}} -> + DogKiller(WatchDog), + lists:keydelete(kill_timer, 1, Config); + _ -> + Config + end. + +lookup_config(Key,Config) -> + case lists:keysearch(Key, 1, Config) of + {value,{Key,Val}} -> + Val; + _ -> + [] + end. +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +wx_init_per_suite(Config) -> + {_Pid, Ref} = + spawn_monitor(fun() -> + %% Avoid test case crash if wx master process dies + process_flag(trap_exit, true), + try + case os:type() of + {unix,darwin} -> + exit({skipped, "Can not test on MacOSX"}); + {unix, _} -> + io:format("DISPLAY ~s~n", [os:getenv("DISPLAY")]), + case proplists:get_value(xserver, Config, none) of + none -> ignore; + Server -> os:putenv("DISPLAY", Server) + end; + _ -> + ignore + end, + wx:new(), + wx:destroy() + catch + error:undef -> + exit({skipped, "No wx compiled for this platform"}); + _:Reason -> + exit({skipped, lists:flatten(io_lib:format("Start wx failed: ~p", [Reason]))}) + end, + exit(normal) + end), + receive + {'DOWN', Ref, _, _, normal} -> + init_per_suite(Config); + {'DOWN', Ref, _, _, {skipped, _} = Skipped} -> + Skipped; + {'DOWN', Ref, _, _, Reason} -> + exit({wx_init_per_suite, Reason}) + after timer:minutes(1) -> + exit({wx_init_per_suite, timeout}) + end. + +wx_end_per_suite(Config) -> + end_per_suite(Config). + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +init_per_testcase(_Func, Config) when is_list(Config) -> + set_kill_timer(Config), + global:register_name(reltool_global_logger, group_leader()), + Config. + +end_per_testcase(_Func, Config) when is_list(Config) -> + global:unregister_name(reltool_global_logger), + reset_kill_timer(Config), + Config. + +%% Backwards compatible with test_server +tc_info(suite) -> []; +tc_info(doc) -> "". + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +%% Use ?log(Format, Args) as wrapper +log(Format, Args, LongFile, Line) -> + File = filename:basename(LongFile), + Format2 = lists:concat([File, "(", Line, ")", ": ", Format]), + log(Format2, Args). + +log(Format, Args) -> + case global:whereis_name(reltool_global_logger) of + undefined -> + io:format(user, Format, Args); + Pid -> + io:format(Pid, Format, Args) + end. + +verbose(Format, Args, File, Line) -> + Arg = reltool_test_verbose, + case get(Arg) of + false -> + ok; + true -> + log(Format, Args, File, Line); + undefined -> + case init:get_argument(Arg) of + {ok, List} when is_list(List) -> + case lists:last(List) of + ["true"] -> + put(Arg, true), + log(Format, Args, File, Line); + _ -> + put(Arg, false), + ok + end; + _ -> + put(Arg, false), + ok + end + end. + +error(Format, Args, File, Line) -> + global:send(reltool_global_logger, {failed, File, Line}), + Fail = {filename:basename(File),Line,Args}, + case global:whereis_name(reltool_test_case_sup) of + undefined -> ignore; + Pid -> Pid ! Fail + %% global:send(reltool_test_case_sup, Fail), + end, + log("<ERROR>~n" ++ Format, Args, File, Line). + + +pick_msg() -> + receive + Message -> Message + after 4000 -> timeout + end. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Utility functions + +user_available(Config) -> + false /= proplists:get_value(user, Config, false). + + +wx_destroy(Frame, Config) -> + case proplists:get_value(user, Config, false) of + false -> + timer:sleep(100), + ?m(ok, wxFrame:destroy(Frame)), + ?m(ok, wx:destroy()); + true -> + timer:sleep(500), + ?m(ok, wxFrame:destroy(Frame)), + ?m(ok, wx:destroy()); + step -> %% Wait for user to close window + ?m(ok, wxEvtHandler:connect(Frame, close_window, [{skip,true}])), + wait_for_close() + end. + +wait_for_close() -> + receive + #wx{event=#wxClose{}} -> + ?log("Got close~n",[]), + ?m(ok, wx:destroy()); + #wx{obj=Obj, event=Event} -> + try + Name = wxTopLevelWindow:getTitle(Obj), + ?log("~p Event: ~p~n", [Name, Event]) + catch _:_ -> + ?log("Event: ~p~n", [Event]) + end, + wait_for_close(); + Other -> + ?log("Unexpected: ~p~n", [Other]), + wait_for_close() + end. + + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% A small test server, which can be run standalone in a shell + +run_test(Test = {_,_},Config) -> + run_test([Test],Config); +run_test([{Module, TC} | Rest], Config) -> + log("\n\n=== Eval test suite: ~w ===~n", [Module]), + case catch Module:init_per_suite(Config) of + {skipped, Reason} -> + log("Test suite skipped: ~s~n", [Reason]), + [{skipped, Reason}]; + NewConfig when is_list(NewConfig) -> + Res = + if + TC =:= all -> + [do_run_test(Module, Test, NewConfig) || Test <- Module:all()]; + is_list(TC) -> + [do_run_test(Module, Test, NewConfig) || Test <- TC]; + true -> + [do_run_test(Module, TC, NewConfig)] + end, + Module:end_per_suite(NewConfig), + Res ++ run_test(Rest, NewConfig); + Error -> + ?error("Test suite skipped: ~w~n", [Error]), + [{skipped, Error}] + end; +run_test([], _Config) -> + []. + +do_run_test(Module, all, Config) -> + All = [{Module, Test} || Test <- Module:all()], + run_test(All, Config); +do_run_test(Module, TestCase, Config) -> + log("Eval test case: ~w~n", [{Module, TestCase}]), + Sec = timer:seconds(1) * 1000, + {T, Res} = + timer:tc(?MODULE, eval_test_case, [Module, TestCase, Config]), + log("Tested ~w in ~w sec~n", [TestCase, T div Sec]), + {T div Sec, Res}. + +eval_test_case(Mod, Fun, Config) -> + flush(), + global:register_name(reltool_test_case_sup, self()), + Flag = process_flag(trap_exit, true), + Pid = spawn_link(?MODULE, test_case_evaluator, [Mod, Fun, [Config]]), + R = wait_for_evaluator(Pid, Mod, Fun, Config), + global:unregister_name(reltool_test_case_sup), + process_flag(trap_exit, Flag), + R. + +test_case_evaluator(Mod, Fun, [Config]) -> + NewConfig = Mod:init_per_testcase(Fun, Config), + R = apply(Mod, Fun, [NewConfig]), + Mod:fin_per_testcase(Fun, NewConfig), + exit({test_case_ok, R}). + +wait_for_evaluator(Pid, Mod, Fun, Config) -> + receive + {'EXIT', Pid, {test_case_ok, _PidRes}} -> + Errors = flush(), + Res = + case Errors of + [] -> ok; + Errors -> failed + end, + {Res, {Mod, Fun}, Errors}; + {'EXIT', Pid, {skipped, Reason}} -> + log("<WARNING> Test case ~w skipped, because ~p~n", + [{Mod, Fun}, Reason]), + Mod:fin_per_testcase(Fun, Config), + {skip, {Mod, Fun}, Reason}; + {'EXIT', Pid, Reason} -> + log("<ERROR> Eval process ~w exited, because\n\t~p~n", + [{Mod, Fun}, Reason]), + Mod:fin_per_testcase(Fun, Config), + {crash, {Mod, Fun}, Reason} + end. + +flush() -> + receive Msg -> [Msg | flush()] + after 0 -> [] + end. + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% diff --git a/lib/reltool/test/reltool_test_lib.hrl b/lib/reltool/test/reltool_test_lib.hrl new file mode 100644 index 0000000000..93134144ea --- /dev/null +++ b/lib/reltool/test/reltool_test_lib.hrl @@ -0,0 +1,91 @@ +%% +%% %CopyrightBegin% +%% +%% Copyright Ericsson AB 2009. 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 +%% compliance with the License. You should have received a copy of the +%% Erlang Public License along with this software. If not, it can be +%% retrieved online at http://www.erlang.org/. +%% +%% Software distributed under the License is distributed on an "AS IS" +%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +%% the License for the specific language governing rights and limitations +%% under the License. +%% +%% %CopyrightEnd% + +-include_lib("wx/include/wx.hrl"). + +-define(log(Format,Args), reltool_test_lib:log(Format,Args,?FILE,?LINE)). +-define(warning(Format,Args), ?log("<WARNING>\n " ++ Format,Args)). +-define(error(Format,Args), reltool_test_lib:error(Format,Args,?FILE,?LINE)). +-define(verbose(Format,Args), reltool_test_lib:verbose(Format,Args,?FILE,?LINE)). + +-define(fatal(Format,Args), + ?error(Format, Args), + exit({test_case_fatal, Format, Args, ?FILE, ?LINE})). + +-define(skip(Format,Args), + ?warning(Format, Args), + exit({skipped, ?flat_format(Format, Args)})). + +-define(ignore(Expr), + fun() -> + AcTuAlReS = (catch (Expr)), + ?verbose("ok: ~p\n",[AcTuAlReS]), + AcTuAlReS + end()). + +-define(msym(ExpectedRes, Expr), + fun() -> + AcTuAlReS = (catch (Expr)), + case AcTuAlReS of + ExpectedRes -> + ?verbose("ok: ~p\n",[AcTuAlReS]), + AcTuAlReS; + _ -> + reltool_test_lib:error("Not matching actual result was:\n ~p \nExpected ~s\n", + [AcTuAlReS, ??ExpectedRes], + ?FILE, ?LINE), + AcTuAlReS + end + end()). + +-define(m(ExpectedRes, Expr), + fun() -> + AcTuAlReS = (catch (Expr)), + case AcTuAlReS of + ExpectedRes -> + ?verbose("ok: ~p\n",[AcTuAlReS]), + AcTuAlReS; + _ -> + reltool_test_lib:error("Not matching actual result was:\n\t~p \nExpected:\n\t~p\n", + [AcTuAlReS, ExpectedRes], + ?FILE, ?LINE), + AcTuAlReS + end + end()). + +-define(m_receive(ExpectedMsg), + ?m(ExpectedMsg,reltool_test_lib:pick_msg())). + +-define(m_multi_receive(ExpectedMsgs), + fun() -> + TmPeXpCtEdMsGs = lists:sort(ExpectedMsgs), + AcTuAlReS = + lists:sort(lists:map(fun(_) -> + reltool_test_lib:pick_msg() + end, TmPeXpCtEdMsGs)), + case AcTuAlReS of + TmPeXpCtEdMsGs -> + ?verbose("ok: ~p\n",[AcTuAlReS]), + AcTuAlReS; + _ -> + reltool_test_lib:error("Not matching actual result was:\n ~p \nExpected ~p\n", + [AcTuAlReS, ExpectedMsgs], + ?FILE, ?LINE), + AcTuAlReS + end + end()). diff --git a/lib/reltool/test/reltool_wx_SUITE.erl b/lib/reltool/test/reltool_wx_SUITE.erl new file mode 100644 index 0000000000..2e2b355e07 --- /dev/null +++ b/lib/reltool/test/reltool_wx_SUITE.erl @@ -0,0 +1,62 @@ +%% +%% %CopyrightBegin% +%% +%% Copyright Ericsson AB 2009. 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 +%% compliance with the License. You should have received a copy of the +%% Erlang Public License along with this software. If not, it can be +%% retrieved online at http://www.erlang.org/. +%% +%% Software distributed under the License is distributed on an "AS IS" +%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +%% the License for the specific language governing rights and limitations +%% under the License. +%% +%% %CopyrightEnd% + +-module(reltool_wx_SUITE). + +-export([all/0, init_per_suite/1, end_per_suite/1, + init_per_testcase/2, fin_per_testcase/2, end_per_testcase/2]). + +-compile(export_all). + +-include("reltool_test_lib.hrl"). + +%% Initialization functions. +init_per_suite(Config) -> + reltool_test_lib:wx_init_per_suite(Config). + +end_per_suite(Config) -> + reltool_test_lib:wx_end_per_suite(Config). + +init_per_testcase(Func,Config) -> + reltool_test_lib:init_per_testcase(Func,Config). +end_per_testcase(Func,Config) -> + reltool_test_lib:end_per_testcase(Func,Config). +fin_per_testcase(Func,Config) -> %% For test_server + reltool_test_lib:end_per_testcase(Func,Config). + +%% SUITE specification +all() -> + all(suite). +all(suite) -> + [ + start_all_windows + ]. + +%% The test cases + +%% Display all windows and see if something crashes +start_all_windows(TestInfo) when is_atom(TestInfo) -> + reltool_test_lib:tc_info(TestInfo); +start_all_windows(_Config) -> + {ok, SysPid} = ?msym({ok, _}, reltool:start([{trap_exit, false}])), + {ok, AppPid} = ?msym({ok, _}, reltool_sys_win:open_app(SysPid, stdlib)), + ?msym({ok, _}, reltool_app_win:open_mod(AppPid, escript)), + timer:sleep(timer:seconds(10)), + ?m(ok, reltool:stop(SysPid)), + + ok. diff --git a/lib/reltool/test/rtt b/lib/reltool/test/rtt new file mode 100755 index 0000000000..2411195338 --- /dev/null +++ b/lib/reltool/test/rtt @@ -0,0 +1,55 @@ +#! /bin/sh -f +# %CopyrightBegin% +# +# Copyright Ericsson AB 2009. 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 +# compliance with the License. You should have received a copy of the +# Erlang Public License along with this software. If not, it can be +# retrieved online at http://www.erlang.org/. +# +# Software distributed under the License is distributed on an "AS IS" +# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +# the License for the specific language governing rights and limitations +# under the License. +# +# %CopyrightEnd% + +# Usage: rtt [-cerl] <args to erlang startup script> + +emu=erl +while [ $# -gt 0 ]; do + case "$1" in + "-cerl") + shift + emu=cerl + ;; + *) + break + ;; + esac +done + +log=test_log_$$ +latest=test_log_latest +args=${1+"$@"} + +erlcmd="$emu -sname test_server -smp -pa ../../reltool/ebin $p $args -reltool_test_verbose true -reltool_test_timeout" + +echo "Give the following command in order to see the outcome:" +echo "" +echo " less $log" + +rm "$latest" 2>/dev/null +ln -s "$log" "$latest" +touch "$log" + +ostype=`uname -s` +if [ "$ostype" = "SunOS" ] ; then + /usr/openwin/bin/xterm -T "Testing reltool" -l -lf "$log" -e $erlcmd & +else + xterm -T "Testing reltool" -e script -f -c "$erlcmd" "$log" & +fi + +tail -f "$log" | egrep 'Eval|<ERROR>|NYI' diff --git a/lib/reltool/test/rtt.erl b/lib/reltool/test/rtt.erl new file mode 100644 index 0000000000..6755b8400f --- /dev/null +++ b/lib/reltool/test/rtt.erl @@ -0,0 +1,154 @@ +%% +%% %CopyrightBegin% +%% +%% Copyright Ericsson AB 2009. 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 +%% compliance with the License. You should have received a copy of the +%% Erlang Public License along with this software. If not, it can be +%% retrieved online at http://www.erlang.org/. +%% +%% Software distributed under the License is distributed on an "AS IS" +%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +%% the License for the specific language governing rights and limitations +%% under the License. +%% +%% %CopyrightEnd% + +-module(rtt). +-compile(export_all). + +%% Modules or suites can be shortcuts, for example server expands to reltool_server_SUITE. +%% +%% t(Tests) run reltool testcases. +%% Tests can be module, {module, test_case} or [module|{module,test_case}] + +t() -> + t(read_test_case()). +t(Test) -> + t(Test, []). + +t(Mod, TC) when is_atom(Mod), is_atom(TC) -> + t({Mod,TC}, []); +t(all, Config) when is_list(Config) -> + Fs = filelib:wildcard("reltool_*_SUITE.erl"), + t([list_to_atom(filename:rootname(File)) || File <- Fs], Config); +t(Test,Config) when is_list(Config) -> + Tests = resolve(Test), + write_test_case(Test), + Res = reltool_test_lib:run_test(Tests, Config), + append_test_case_info(Test, Res). + +user() -> + user(read_test_case()). +user(Mod) -> + t(Mod, [{user,step}]). +user(Mod,Tc) when is_atom(Tc) -> + t({Mod,Tc}, [{user,step}]). + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Resolves the name of test suites and test cases +%% according to the alias definitions. Single atoms +%% are assumed to be the name of a test suite. + +resolve(Suite0) when is_atom(Suite0) -> + case alias(Suite0) of + Suite when is_atom(Suite) -> + {Suite, all}; + {Suite, Case} -> + {Suite, Case} + end; +resolve({Suite0, Case}) when is_atom(Suite0), is_atom(Case) -> + case alias(Suite0) of + Suite when is_atom(Suite) -> + {Suite, Case}; + {Suite, Case2} -> + {Suite, Case2} + end; +resolve(List) when is_list(List) -> + [resolve(Case) || Case <- List]. + +alias(Suite) when is_atom(Suite) -> + Str = atom_to_list(Suite), + case {Str, lists:reverse(Str)} of + {"reltool" ++ _, "ETIUS" ++ _} -> + Suite; + _ -> + list_to_atom("reltool_" ++ Str ++ "_SUITE") + end. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +config_fname() -> + "reltool_test_case_config". + +%% Read default config file +read_config() -> + Fname = config_fname(), + reltool_test_lib:log("Consulting file ~s...~n", [Fname]), + case file:consult(Fname) of + {ok, Config} -> + reltool_test_lib:log("Read config ~w~n", [Config]), + Config; + _Error -> + Config = reltool_test_lib:default_config(), + reltool_test_lib:log("<>WARNING<> Using default config: ~w~n", [Config]), + Config + end. + +%% Write new default config file +write_config(Config) when is_list(Config) -> + Fname = config_fname(), + {ok, Fd} = file:open(Fname, write), + write_list(Fd, Config), + file:close(Fd). + +write_list(Fd, [H | T]) -> + ok = io:format(Fd, "~p.~n",[H]), + write_list(Fd, T); +write_list(_, []) -> + ok. + +test_case_fname() -> + "reltool_test_case_info". + +%% Read name of test case +read_test_case() -> + Fname = test_case_fname(), + case file:open(Fname, [read]) of + {ok, Fd} -> + Res = io:read(Fd, []), + file:close(Fd), + case Res of + {ok, TestCase} -> + reltool_test_lib:log("Using test case ~w from file ~s~n", + [TestCase, Fname]), + TestCase; + {error, _} -> + default_test_case(Fname) + end; + {error, _} -> + default_test_case(Fname) + end. + +default_test_case(Fname) -> + TestCase = all, + reltool_test_lib:log("<>WARNING<> Cannot read file ~s, " + "using default test case: ~w~n", + [Fname, TestCase]), + TestCase. + +write_test_case(TestCase) -> + Fname = test_case_fname(), + {ok, Fd} = file:open(Fname, write), + ok = io:format(Fd, "~p.~n",[TestCase]), + file:close(Fd). + +append_test_case_info(TestCase, TestCaseInfo) -> + Fname = test_case_fname(), + {ok, Fd} = file:open(Fname, [read, write]), + ok = io:format(Fd, "~p.~n",[TestCase]), + ok = io:format(Fd, "~p.~n",[TestCaseInfo]), + file:close(Fd), + TestCaseInfo. diff --git a/lib/stdlib/doc/src/beam_lib.xml b/lib/stdlib/doc/src/beam_lib.xml index f2a9c2a671..b9286f1402 100644 --- a/lib/stdlib/doc/src/beam_lib.xml +++ b/lib/stdlib/doc/src/beam_lib.xml @@ -4,7 +4,7 @@ <erlref> <header> <copyright> - <year>2000</year><year>2009</year> + <year>2000</year><year>2010</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -13,12 +13,12 @@ compliance with the License. You should have received a copy of the Erlang Public License along with this software. If not, it can be retrieved online at http://www.erlang.org/. - + Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License. - + </legalnotice> <title>beam_lib</title> @@ -70,82 +70,88 @@ using <seealso marker="#strip/1">strip/1</seealso>, <seealso marker="#strip_files/1">strip_files/1</seealso> and/or <seealso marker="#strip_release/1">strip_release/1</seealso>.</p> - <p><em>Reconstructing source code</em></p> - <p>Here is an example of how to reconstruct source code from - the debug information in a BEAM file <c>Beam</c>:</p> - <code type="none"> + <section> + <title>Reconstructing source code</title> + <p>Here is an example of how to reconstruct source code from + the debug information in a BEAM file <c>Beam</c>:</p> + <code type="none"> {ok,{_,[{abstract_code,{_,AC}}]}} = beam_lib:chunks(Beam,[abstract_code]). io:fwrite("~s~n", [erl_prettypr:format(erl_syntax:form_list(AC))]).</code> - <p><em>Encrypted debug information</em></p> - <p>The debug information can be encrypted in order to keep - the source code secret, but still being able to use tools such as - Xref or Debugger. </p> - <p>To use encrypted debug information, a key must be provided to - the compiler and <c>beam_lib</c>. The key is given as a string and - it is recommended that it contains at least 32 characters and - that both upper and lower case letters as well as digits and - special characters are used.</p> - <p></p> - <p>The default type -- and currently the only type -- of crypto - algorithm is <c>des3_cbc</c>, three rounds of DES. The key string - will be scrambled using <c>erlang:md5/1</c> to generate - the actual keys used for <c>des3_cbc</c>.</p> - <note> - <p>As far as we know by the time of writing, it is - infeasible to break <c>des3_cbc</c> encryption without any - knowledge of the key. Therefore, as long as the key is kept - safe and is unguessable, the encrypted debug information - <em>should</em> be safe from intruders.</p> - </note> - <p>There are two ways to provide the key:</p> - <list type="ordered"> - <item> - <p>Use the compiler option <c>{debug_info,Key}</c>, see - <seealso marker="compiler:compile#debug_info_key">compile(3)</seealso>, - and the function - <seealso marker="#crypto_key_fun/1">crypto_key_fun/1</seealso> - to register a fun which returns the key whenever - <c>beam_lib</c> needs to decrypt the debug information.</p> - <p>If no such fun is registered, <c>beam_lib</c> will instead - search for a <c>.erlang.crypt</c> file, see below.</p> - </item> - <item> - <p>Store the key in a text file named <c>.erlang.crypt</c>.</p> - <p>In this case, the compiler option <c>encrypt_debug_info</c> - can be used, see - <seealso marker="compiler:compile#encrypt_debug_info">compile(3)</seealso>.</p> - </item> - </list> - <p><em>.erlang.crypt</em></p> - <p><c>beam_lib</c> searches for <c>.erlang.crypt</c> in the current - directory and then the home directory for the current user. If - the file is found and contains a key, <c>beam_lib</c> will - implicitly create a crypto key fun and register it.</p> - <p>The <c>.erlang.crypt</c> file should contain a single list of - tuples:</p> - <code type="none"> + </section> + <section> + <title>Encrypted debug information</title> + <p>The debug information can be encrypted in order to keep + the source code secret, but still being able to use tools such as + Xref or Debugger. </p> + <p>To use encrypted debug information, a key must be provided to + the compiler and <c>beam_lib</c>. The key is given as a string and + it is recommended that it contains at least 32 characters and + that both upper and lower case letters as well as digits and + special characters are used.</p> + <p></p> + <p>The default type -- and currently the only type -- of crypto + algorithm is <c>des3_cbc</c>, three rounds of DES. The key string + will be scrambled using <c>erlang:md5/1</c> to generate + the actual keys used for <c>des3_cbc</c>.</p> + <note> + <p>As far as we know by the time of writing, it is + infeasible to break <c>des3_cbc</c> encryption without any + knowledge of the key. Therefore, as long as the key is kept + safe and is unguessable, the encrypted debug information + <em>should</em> be safe from intruders.</p> + </note> + <p>There are two ways to provide the key:</p> + <list type="ordered"> + <item> + <p>Use the compiler option <c>{debug_info,Key}</c>, see + <seealso marker="compiler:compile#debug_info_key">compile(3)</seealso>, + and the function + <seealso marker="#crypto_key_fun/1">crypto_key_fun/1</seealso> + to register a fun which returns the key whenever + <c>beam_lib</c> needs to decrypt the debug information.</p> + <p>If no such fun is registered, <c>beam_lib</c> will instead + search for a <c>.erlang.crypt</c> file, see below.</p> + </item> + <item> + <p>Store the key in a text file named <c>.erlang.crypt</c>.</p> + <p>In this case, the compiler option <c>encrypt_debug_info</c> + can be used, see + <seealso marker="compiler:compile#encrypt_debug_info">compile(3)</seealso>.</p> + </item> + </list> + </section> + <section> + <title>.erlang.crypt</title> + <p><c>beam_lib</c> searches for <c>.erlang.crypt</c> in the current + directory and then the home directory for the current user. If + the file is found and contains a key, <c>beam_lib</c> will + implicitly create a crypto key fun and register it.</p> + <p>The <c>.erlang.crypt</c> file should contain a single list of + tuples:</p> + <code type="none"> {debug_info, Mode, Module, Key}</code> - <p><c>Mode</c> is the type of crypto algorithm; currently, the only - allowed value thus is <c>des3_cbc</c>. <c>Module</c> is either an - atom, in which case <c>Key</c> will only be used for the module - <c>Module</c>, or <c>[]</c>, in which case <c>Key</c> will be - used for all modules. <c>Key</c> is the non-empty key string.</p> - <p>The <c>Key</c> in the first tuple where both <c>Mode</c> and - <c>Module</c> matches will be used.</p> - <p>Here is an example of an <c>.erlang.crypt</c> file that returns - the same key for all modules:</p> - <code type="none"><![CDATA[ + <p><c>Mode</c> is the type of crypto algorithm; currently, the only + allowed value thus is <c>des3_cbc</c>. <c>Module</c> is either an + atom, in which case <c>Key</c> will only be used for the module + <c>Module</c>, or <c>[]</c>, in which case <c>Key</c> will be + used for all modules. <c>Key</c> is the non-empty key string.</p> + <p>The <c>Key</c> in the first tuple where both <c>Mode</c> and + <c>Module</c> matches will be used.</p> + <p>Here is an example of an <c>.erlang.crypt</c> file that returns + the same key for all modules:</p> + <code type="none"><![CDATA[ [{debug_info, des3_cbc, [], "%>7}|pc/DM6Cga*68$Mw]L#&_Gejr]G^"}].]]></code> - <p>And here is a slightly more complicated example of an - <c>.erlang.crypt</c> which provides one key for the module - <c>t</c>, and another key for all other modules:</p> - <code type="none"><![CDATA[ + <p>And here is a slightly more complicated example of an + <c>.erlang.crypt</c> which provides one key for the module + <c>t</c>, and another key for all other modules:</p> + <code type="none"><![CDATA[ [{debug_info, des3_cbc, t, "My KEY"}, {debug_info, des3_cbc, [], "%>7}|pc/DM6Cga*68$Mw]L#&_Gejr]G^"}].]]></code> - <note> - <p>Do not use any of the keys in these examples. Use your own - keys.</p> - </note> + <note> + <p>Do not use any of the keys in these examples. Use your own + keys.</p> + </note> + </section> </section> <section> diff --git a/lib/stdlib/doc/src/io.xml b/lib/stdlib/doc/src/io.xml index c075f11792..6f9d979c9a 100644 --- a/lib/stdlib/doc/src/io.xml +++ b/lib/stdlib/doc/src/io.xml @@ -4,7 +4,7 @@ <erlref> <header> <copyright> - <year>1996</year><year>2009</year> + <year>1996</year><year>2010</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -13,12 +13,12 @@ compliance with the License. You should have received a copy of the Erlang Public License along with this software. If not, it can be retrieved online at http://www.erlang.org/. - + Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License. - + </legalnotice> <title>io</title> @@ -1003,7 +1003,8 @@ enter><input>bar.</input> <title>Standard Error</title> <p>In certain situations, especially when the standard output is redirected, access to an io_server() specific for error messages might be convenient. The io_device 'standard_error' can be used to direct output to whatever the current operating system considers a suitable device for error output. Example on a Unix-like operating system:</p> <pre> -$ <input>erl -noshell -noinput -eval 'io:format(standard_error,"Error: ~s~n",["error 11"]),init:stop().' > /dev/null</input> +$ <input>erl -noshell -noinput -eval 'io:format(standard_error,"Error: ~s~n",["error 11"]),'\</input> +<input>'init:stop().' > /dev/null</input> Error: error 11</pre> diff --git a/lib/stdlib/doc/src/unicode.xml b/lib/stdlib/doc/src/unicode.xml index b3aad51591..60edd8ade9 100644 --- a/lib/stdlib/doc/src/unicode.xml +++ b/lib/stdlib/doc/src/unicode.xml @@ -51,7 +51,9 @@ charlist() = [unicode_char() | unicode_binary() | charlist()] a unicode_binary is allowed as the tail of the list</code> <code type="none"> -external_unicode_binary() = binary() with characters coded in a user specified Unicode encoding other than UTF-8 (UTF-16 or UTF-32) +external_unicode_binary() = binary() + with characters coded in a user specified Unicode encoding other + than UTF-8 (UTF-16 or UTF-32) external_chardata() = external_charlist() | external_unicode_binary() diff --git a/lib/stdlib/doc/src/unicode_usage.xml b/lib/stdlib/doc/src/unicode_usage.xml index 06347b3aae..c5bf10b63d 100644 --- a/lib/stdlib/doc/src/unicode_usage.xml +++ b/lib/stdlib/doc/src/unicode_usage.xml @@ -76,7 +76,8 @@ charlist() = [unicode_char() | unicode_binary() | charlist()] a unicode_binary is allowed as the tail of the list</code> <p>The module <c>unicode</c> in stdlib even supports similar mixes with binaries containing other encodings than UTF-8, but that is a special case to allow for conversions to and from external data:</p> <code type="none"> -external_unicode_binary() = binary() with characters coded in a user specified Unicode encoding other than UTF-8 (UTF-16 or UTF-32) +external_unicode_binary() = binary() with characters coded in a user specified Unicode + encoding other than UTF-8 (UTF-16 or UTF-32) external_chardata() = external_charlist() | external_unicode_binary() @@ -93,7 +94,8 @@ external_charlist() = [unicode_char() | external_unicode_binary() | external_cha <code> <<Ch/utf8,_/binary>> = Bin1, <<Ch/utf16-little,_/binary>> = Bin2, -Bin3 = <<$H/utf32-little, $e/utf32-little, $l/utf32-little, $l/utf32-little, $o/utf32-little>>,</code> +Bin3 = <<$H/utf32-little, $e/utf32-little, $l/utf32-little, $l/utf32-little, + $o/utf32-little>>,</code> <p>For convenience, literal strings can be encoded with a Unicode encoding in binaries using the following (or similar) syntax:</p> <code> Bin4 = <<"Hello"/utf16>>,</code> diff --git a/lib/syntax_tools/Makefile b/lib/syntax_tools/Makefile index 08ede67209..37e84a80a5 100644 --- a/lib/syntax_tools/Makefile +++ b/lib/syntax_tools/Makefile @@ -58,10 +58,10 @@ include $(ERL_TOP)/make/otp_subdir.mk version: @echo "$(VSN)" -docs: - erl -noshell -pa "$(BINDIR)" -run edoc_run application "'$(APPNAME)'" '"."' '$(DOC_OPTS)' -s init stop +# The overriding "docs" target have been removed so the default make rules work properly. -edocs: docs +edocs: + erl -noshell -pa "$(BINDIR)" -run edoc_run application "'$(APPNAME)'" '"."' '$(DOC_OPTS)' -s init stop app_release: tar diff --git a/lib/syntax_tools/doc/src/Makefile b/lib/syntax_tools/doc/src/Makefile index 2065614251..291b3e3047 100644 --- a/lib/syntax_tools/doc/src/Makefile +++ b/lib/syntax_tools/doc/src/Makefile @@ -1,19 +1,19 @@ # # %CopyrightBegin% -# -# Copyright Ericsson AB 2006-2009. All Rights Reserved. -# +# +# Copyright Ericsson AB 2006-2010. 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 # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. -# +# # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. -# +# # %CopyrightEnd% # include $(ERL_TOP)/make/target.mk @@ -101,10 +101,10 @@ html: gifs $(HTML_REF_MAN_FILE) man: $(MAN3_FILES) $(XML_REF3_FILES): - docb_gen $(SRC_DIR)/$(@:%.xml=%.erl) + escript $(DOCGEN)/priv/bin/xml_from_edoc.escript $(SRC_DIR)/$(@:%.xml=%.erl) $(XML_CHAPTER_FILES): - docb_gen -chapter -def vsn $(VSN) ../overview.edoc + escript $(DOCGEN)/priv/bin/xml_from_edoc.escript -def vsn $(VSN) -chapter ../overview.edoc gifs: $(GIF_FILES:%=$(HTMLDIR)/%) diff --git a/lib/syntax_tools/src/Makefile b/lib/syntax_tools/src/Makefile index 5ffe85c975..62a24d98c0 100644 --- a/lib/syntax_tools/src/Makefile +++ b/lib/syntax_tools/src/Makefile @@ -34,15 +34,15 @@ OBJECTS=$(SOURCES:%.erl=$(EBIN)/%.$(EMULATOR)) $(APP_TARGET) $(APPUP_TARGET) APP_FILE= syntax_tools.app APP_SRC= $(APP_FILE).src APP_TARGET= $(EBIN)/$(APP_FILE) - + APPUP_FILE= syntax_tools.appup APPUP_SRC= $(APPUP_FILE).src APPUP_TARGET= $(EBIN)/$(APPUP_FILE) - + # ---------------------------------------------------- # Targets # ---------------------------------------------------- - + debug opt: $(OBJECTS) all: $(OBJECTS) @@ -52,6 +52,8 @@ clean: rm -f $(OBJECTS) rm -f core *~ +docs: + distclean: clean realclean: clean @@ -62,10 +64,10 @@ $(EBIN)/%.$(EMULATOR):%.erl # ---------------------------------------------------- # Special Build Targets # ---------------------------------------------------- - + $(APP_TARGET): $(APP_SRC) ../vsn.mk sed -e 's;%VSN%;$(VSN);' $< > $@ - + $(APPUP_TARGET): $(APPUP_SRC) ../vsn.mk sed -e 's;%VSN%;$(VSN);' $< > $@ diff --git a/lib/test_server/doc/src/Makefile b/lib/test_server/doc/src/Makefile index e3c1b8ce92..c7ba415e5b 100644 --- a/lib/test_server/doc/src/Makefile +++ b/lib/test_server/doc/src/Makefile @@ -1,19 +1,19 @@ # # %CopyrightBegin% -# -# Copyright Ericsson AB 2002-2009. All Rights Reserved. -# +# +# Copyright Ericsson AB 2002-2010. 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 # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. -# +# # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. -# +# # %CopyrightEnd% # @@ -60,6 +60,9 @@ XML_CHAPTER_FILES = \ BOOK_FILES = book.xml +XML_FILES = $(BOOK_FILES) $(XML_APPLICATION_FILES) $(XML_REF3_FILES) $(XML_REF6_FILES) \ + $(XML_PART_FILES) $(XML_CHAPTER_FILES) + GIF_FILES = # ---------------------------------------------------- diff --git a/lib/test_server/src/Makefile b/lib/test_server/src/Makefile index 2d7e5b28bc..d55a3a597d 100644 --- a/lib/test_server/src/Makefile +++ b/lib/test_server/src/Makefile @@ -1,19 +1,19 @@ # # %CopyrightBegin% -# -# Copyright Ericsson AB 1996-2009. All Rights Reserved. -# +# +# Copyright Ericsson AB 1996-2010. 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 # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. -# +# # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. -# +# # %CopyrightEnd% # @@ -104,7 +104,7 @@ clean: rm -f $(TARGET_FILES) $(TS_TARGET_FILES) rm -f core -doc: +docs: configure: configure.in autoconf configure.in > configure diff --git a/lib/wx/doc/src/Makefile b/lib/wx/doc/src/Makefile index fd9f7441a3..c8eb6174c4 100644 --- a/lib/wx/doc/src/Makefile +++ b/lib/wx/doc/src/Makefile @@ -1,19 +1,19 @@ # # %CopyrightBegin% -# -# Copyright Ericsson AB 2008-2009. All Rights Reserved. -# +# +# Copyright Ericsson AB 2008-2010. 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 # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. -# +# # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. -# +# # %CopyrightEnd% # @@ -82,7 +82,6 @@ XML_FILES = \ $(XML_PART_FILES) $(XML_REF3_FILES) \ $(XML_NOTES_FILES) $(XML_APPLICATION_FILES) - # ---------------------------------------------------- INFO_FILE = ../../info @@ -130,12 +129,13 @@ ref_man.xml: ref_man.xml.src @echo $(ErlMods:%.erl=%.xml): - docb_gen -def vsn $(VSN) -sort_functions false ../../src/$(@:%.xml=%.erl) + escript $(DOCGEN)/priv/bin/xml_from_edoc.escript -def vsn $(VSN) -sort_functions false ../../src/$(@:%.xml=%.erl) + $(GenMods:%.erl=%.xml): - docb_gen -def vsn $(VSN) -sort_functions false ../../src/gen/$(@:%.xml=%.erl) + escript $(DOCGEN)/priv/bin/xml_from_edoc.escript -def vsn $(VSN) -sort_functions false ../../src/gen/$(@:%.xml=%.erl) $(XML_CHAPTER_FILES): - docb_gen -chapter -def vsn $(VSN) ../overview.edoc + escript $(DOCGEN)/priv/bin/xml_from_edoc.escript -def vsn $(VSN) -chapter ../overview.edoc debug opt: diff --git a/make/otp.mk.in b/make/otp.mk.in index 902def5fd8..4d8727d47e 100644 --- a/make/otp.mk.in +++ b/make/otp.mk.in @@ -262,7 +262,8 @@ $(MAN9DIR)/%.9:: %.xml .xmlsrc.xml: - $(DOCGEN)/priv/bin/codeline_preprocessing.escript $< $@ + escript $(DOCGEN)/priv/bin/codeline_preprocessing.escript $< $@ .fo.pdf: $(FOP) -fo $< -pdf $@ + diff --git a/system/AD.html b/system/AD.html deleted file mode 100644 index 695f3b40aa..0000000000 --- a/system/AD.html +++ /dev/null @@ -1,307 +0,0 @@ -<HTML> -<HEAD> -<TITLE>AMENDMENT DIRECTIVE, OTP</TITLE> -</HEAD> -<BODY BGCOLOR="#FFFFFF"> -<CENTER> -<A HREF="http://otp.ericsson.se"><IMG BORDER=0 ALT="[OTP]" SRC="http://otp.ericsson.se/pics/banner/min_head.gif"></A> -<H1>AMENDMENT DIRECTIVE, OTP</H1> -<FONT SIZE="+1"> -1/177 82 - APN 181 01I<BR> -UAB/F Kenneth Lundin, Lars Thors�n, Morgan Eriksson<BR> -961023<BR> -</FONT> -</CENTER> -<BLOCKQUOTE> -<H2>Table of Contents</H2> -1 <A HREF="#1">Introduction</A><BR> -1.1 <A HREF="#1.1">Purpose</A><BR> -1.2 <A HREF="#1.2">Revision History</A><BR> -2 <A HREF="#2">Product Identities</A><BR> -3 <A HREF="#3">Document Survey</A><BR> -4 <A HREF="#4">Implemented Change requests</A><BR> -5 <A HREF="#5">Implemented Trouble Reports</A><BR> -6 <A HREF="#6">Installation Instructions</A><BR> -6.1 <A HREF="#6.1">Separate (optional) Installation of XNTP (Network Time Protocol)</A><BR> -7 <A HREF="#7">Some useful notes</A><BR> -8 <A HREF="#8">Known problems in this release</A><BR> -9 <A HREF="#9">References</A><BR> - -<A NAME="1"><!-- Empty --></A><H2>1 Introduction</H2> -<P><A NAME="1.1"><!-- Empty --></A><H3>1.1 Purpose</H3> -<P>This update release, OTP P1H, contains a fix for the erl_call problems in OTP P1G.<A NAME="1.2"><!-- Empty --></A><H3>1.2 Revision History</H3> -<P>Rev.A:Kenneth Lundin 1996-05-31<BR> - -Rev.B:Lars Thors�n 1996-06-04<BR> - -Rev.C:Kenneth Lundin 1996-06-14<BR> - -Rev.D:Kenneth Lundin 1996-08-28<BR> - -Rev.E:Lars Thors�n 1996-09-12<BR> - -Rev.F:Kenneth Lundin 1996-09-13<BR> - -Rev.G:Morgan Ericsson 1996-10-08<BR> - -Rev.H:Kenneth Lundin 1996-10-14<BR> - -Rev.I:Morgan Eriksson 1996-10-23<BR> -<P>The exact changes between revisions of this document can be generated from our ClearCase repository upon request , or a simple unix "diff" can be used.<A NAME="2"><!-- Empty --></A><H2>2 Product Identities</H2> -<P><P><TABLE BORDER=1> -<TR> -<TD><B>Product Name</B></TD> -<TD><B>Product Number</B></TD> -<TD><B>R-state</B></TD> -</TR> -<TR> -<TD>OTP</TD> -<TD>APN 181 01</TD> -<TD>P1H</TD> -</TR> -<TR> -<TD>ERTS (sunos4)</TD> -<TD>CXC 138 10/1</TD> -<TD>P1G</TD> -</TR> -<TR> -<TD>ERTS (sunos5)</TD> -<TD>CXC 138 10/2</TD> -<TD>P1G</TD> -</TR> -<TR> -<TD>SASL (BOS) (sunos4)</TD> -<TD>CXC 138 11/1</TD> -<TD>P1D</TD> -</TR> -<TR> -<TD>SASL (BOS) (sunos5)</TD> -<TD>CXC 138 11/2</TD> -<TD>P1D</TD> -</TR> -<TR> -<TD>MNESIA</TD> -<TD>CXC 138 12/1</TD> -<TD>P1E</TD> -</TR> -<TR> -<TD>SNMPEA</TD> -<TD>CXC 138 13/1</TD> -<TD>P1D</TD> -</TR> -<TR> -<TD>ERLDEV (Compiler & Debugger)</TD> -<TD>CXC 138 15/1</TD> -<TD>P1C</TD> -</TR> -<TR> -<TD>DEVTOOLS (sunos4)</TD> -<TD>CXC 138 16/1</TD> -<TD>P1D</TD> -</TR> -<TR> -<TD>DEVTOOLS (sunos5)</TD> -<TD>CXC 138 16/2</TD> -<TD>P1D</TD> -</TR> -<TR> -<TD>XLATETOOLS (sunos4)</TD> -<TD>CXC 138 17/1</TD> -<TD>P1D</TD> -</TR> -<TR> -<TD>XLATETOOLS (sunos5)</TD> -<TD>CXC 138 17/2</TD> -<TD>P1D</TD> -</TR> -<TR> -<TD>CPO Solaris (XNTP)</TD> -<TD>CXC 138 46/1</TD> -<TD>P1A</TD> -</TR> -</TABLE> -<A NAME="3"><!-- Empty --></A><H2>3 Document Survey</H2> -<P><P><TABLE BORDER=1> -<TR> -<TD><B>Document name</B></TD> -<TD><B>Document number</B></TD> -<TD>Rev</TD> -</TR> -<TR> -<TD>Systems Overview</TD> -<TD>1551-APN 181 01</TD> -<TD>A</TD> -</TR> -<TR> -<TD>Erlang Tools Introduction</TD> -<TD>EPK-95:030/1</TD> -<TD>A</TD> -</TR> -<TR> -<TD>Erlang Tools User's Guide</TD> -<TD>EPK-95:030/2</TD> -<TD>A</TD> -</TR> -<TR> -<TD>Erlang Tools</TD> -<TD>EPK-95:030/3</TD> -<TD>A</TD> -</TR> -<TR> -<TD>Distributed Erlang User's Guide</TD> -<TD>EPK-95:030/4</TD> -<TD>A</TD> -</TR> -<TR> -<TD>Erlang Tools Examples</TD> -<TD>EPK-95:030/5</TD> -<TD>A</TD> -</TR> -<TR> -<TD>User's Guide to the Erlang Interface Library</TD> -<TD>3/1553-CNA 121 16</TD> -<TD>A</TD> -</TR> -<TR> -<TD>Erlang Interface Library Examples</TD> -<TD>1/198 17-CNA 121 16</TD> -<TD>A</TD> -</TR> -<TR> -<TD>Programmer's Guide to the Erlang Interface Library</TD> -<TD>2/198 17-CNA 121 16</TD> -<TD>A</TD> -</TR> -<TR> -<TD>OTP Erlang User's guide</TD> -<TD>1553-CNA 121 17</TD> -<TD>A</TD> -</TR> -<TR> -<TD>The Mnesia Query Language Mnemosyne</TD> -<TD>1553-CNA 121 18</TD> -<TD>A</TD> -</TR> -<TR> -<TD>SNMPEA User's Guide</TD> -<TD>1553-CNA 121 19</TD> -<TD>A</TD> -</TR> -<TR> -<TD>SNMPEA Reference Guide</TD> -<TD>1551-CNA 121 19</TD> -<TD>A</TD> -</TR> -<TR> -<TD>User's Guide to the Interface Generator</TD> -<TD>1553-CNA 121 38</TD> -<TD>A</TD> -</TR> -</TABLE> -<P>A complete browseable document survey is available at the OTP WWW-server http://otp.ericsson.se and can also be found in the release at $OTP_ROOT/doc/all.html when the -release file is un-tar:ed at $OTP_ROOT.<A NAME="4"><!-- Empty --></A><H2>4 Implemented Change requests</H2> -<P>-<A NAME="5"><!-- Empty --></A><H2>5 Implemented Trouble Reports</H2> -<P><P><TABLE BORDER=1> -<TR> -<TD><B>Block</B></TD> -<TD><B>TR id</B></TD> -<TD><B>Slogan</B></TD> -</TR> -<TR> -<TD>ERTS</TD> -<TD>-</TD> -<TD>erl_call crashes (Segmentation fault) has now been fixed</TD> -</TR> -</TABLE> -<A NAME="6"><!-- Empty --></A><H2>6 Installation Instructions</H2> -<P>The release is delivered as a compressed tar-file <B>otp_APN18101_P1H.<target>.tar.Z</B>, where <target> is substituted with <B>sunos4</B> or <B>sunos5</B>.<P>Then the following steps shall be performed at installation time:<UL> -<LI>Create a new directory $OTP_INSTALL_DIR where OTP can be installed. -<PRE>mkdir $OTP_INSTALL_DIR -cd $OTP_INSTALL_DIR -uncompress $XXX/otp_APN18101_P1H.<target>.tar.Z -tar xvfp $XXX/otp_APN18101_P1H.<target>.tar</PRE> - -<LI>Run the OTP installscript and answer the questions. -<PRE>./Install $OTP_INSTALL_DIR</PRE> -<BR>The Install command will ask a number of questions during the installation. -<B>OBS!</B> When installing on a system where DNS is not used you -should answer <B>NO</B> on the question "WILL YOU USE DNS?" - -<LI>Prepare the OTP man pages. -<PRE>mkdir man/cat1 man/cat3 -./format_man_pages</PRE> - -<LI>Update the erl_interface library with ranlib (sunos4 only). -<PRE>cd $OTP_INSTALL_DIR/usr/lib -ranlib liberl_interface.a</PRE> - -</UL> -<P>Add $OTP_INSTALL_DIR/bin to the path variable and $OTP_INSTALL_DIR/man to the MANPATH variable.<P>Where <B>$XXX</B> denotes the path at which otp_APN18101_P1H.<target>.tar resides. -<A NAME="6.1"><!-- Empty --></A><H3>6.1 Separate (optional) Installation of XNTP (Network Time Protocol)</H3> -<P>XNTP (Network Time Protocol) <B>for use in an embedded system running Sunos5</B> is -delivered in this release. The XNTP resides in the tar-file xntp_CXC_13846_P1A.sunos5.tar.Z and can be fetched with Netscape from the same place as the other OTP deliverables.<UL> -<LI>Create a new directory $XNTP_DIR where the XNTP distribution can be loaded. -<PRE>mkdir $XNTP_DIR -cd $XNTP_DIR -uncompress $XXX/xntp_CXC_13846_P1A.sunos5.tar.Z -tar xvf $XXX/xntp_CXC_13846_P1A.sunos5.tar.Z</PRE> - -<LI>Read the README-file which is included, below follows information which -is partly the same as can be found at the end of the README file. - -<LI>Note, the xntp3.5a.export subdirectory is not needed for installation. - -<BR>Create a suitable configuration file based on the samples in the -'config' directory, and copy it to /etc/ntp.conf. - -<LI>Create a directory for the binaries and copy them there:<BR> - -<PRE>mkdir -p /opt/xntp/bin -cp bin/* /opt/xntp/bin</PRE> -<BR>Note!, if you prefer another installation directory for the binaries, you have to edit one line in the "Run Commands" script xntp (located in the init directory): -<PRE>BINDIR=<your new bindir></PRE> - -<LI>Install the "Run Commands" script:<BR> - -<PRE>cp init/xntp /etc/init.d/xntp<br> -ln /etc/init.d/xntp /etc/rc0.d/K57xntp -ln /etc/init.d/xntp /etc/rc1.d/K57xntp -ln /etc/init.d/xntp /etc/rc2.d/S78xntp</PRE> - -<LI>Modify the /etc/system file (you probably want to save the original):<BR> - -<PRE>cat init/system >> /etc/system</PRE> - -</UL> -<P>Where <B>$XXX</B> denotes the path at which xntp_CXC13846_P1A.sunos5.tar.Z resides.<A NAME="7"><!-- Empty --></A><H2>7 Some useful notes</H2> -<P>To make it possible to browse Framemaker documents through Netscape the files -.mime.types and .mailcap should be modified (see below). The modifications -can be made as systems defaults if they are placed in e.g /usr/local/lib/netscape (see Netscape Handbook for details) or as personal defaults if placed in the -users $HOME directory.<P>.mime.types<P><PRE>application/x-maker fm</PRE> -<P> -.mailcap<P><PRE>application/x-maker; fmclient -f %s</PRE> -<A NAME="8"><!-- Empty --></A><H2>8 Known problems in this release</H2> -<P><UL> -<LI>In the manual-page for module code, the returned value of the function -which is described to be String but in reality it is an Atom (for compatibility -reasons). In the next release the return type will however be String as it says -in the manual-page. - -<LI>On SunOS4.x platforms, the format_man_pages script (executed as a part of installation) will cause following error messages for missing manual sections: -<BR> -<PRE>opendir:man{2,4,5,6,7,8,l,n}: No such file or directory</PRE> -<BR>These messages should be ignored. - -</UL> -<A NAME="9"><!-- Empty --></A><H2>9 References</H2> -<P><I>Nothing to reference</I> -</BLOCKQUOTE> -<CENTER> -<HR> -<P><FONT SIZE=-1> -Copyright © 1996 <A HREF="http://otp.ericsson.se">Open Telecom Platform</A><BR> -<!--#include virtual="/ssi/otp_footer.html"--> -</FONT> -</CENTER> -</BODY> -</HTML> diff --git a/system/AD.sgml b/system/AD.sgml deleted file mode 100644 index e7fc9755ed..0000000000 --- a/system/AD.sgml +++ /dev/null @@ -1,367 +0,0 @@ -<!doctype report PUBLIC "-//Stork//DTD report//EN"> - -<report> - <header> - <title>AMENDMENT DIRECTIVE, OTP</title> - <prepared>ETX/B/SFP Kenneth Lundin, Lars Thorsén, Morgan Eriksson</prepared> - <responsible></responsible> - <docno>1/177 82 - APN 181 01</docno> - <approved>ETX/B/SF Torbjörn Johnson</approved> - <checked></checked> - <date>961023</date> - <rev>I</rev> - <file>tr1c.sgml</file> - </header> - -<section> -<title>Introduction</title> -<p> -<section><title>Purpose</title> -<p> -This update release, OTP P1H, contains a fix for the erl_call problems in OTP P1G. -</section> - -<section><title>Revision History</title> -<p> -Rev.A:Kenneth Lundin 1996-05-31<br> -Rev.B:Lars Thorsén 1996-06-04<br> -Rev.C:Kenneth Lundin 1996-06-14<br> -Rev.D:Kenneth Lundin 1996-08-28<br> -Rev.E:Lars Thorsén 1996-09-12<br> -Rev.F:Kenneth Lundin 1996-09-13<br> -Rev.G:Morgan Ericsson 1996-10-08<br> -Rev.H:Kenneth Lundin 1996-10-14<br> -Rev.I:Morgan Eriksson 1996-10-23<br> -<p> -The exact changes between revisions of this document can be generated from our ClearCase repository upon request , or a simple unix "diff" can be used. -</section> -</section> -<section><title>Product Identities</title> -<p> -<table> -<row> -<cell><b>Product Name</b></cell> -<cell><b>Product Number</b></cell> -<cell><b>R-state</b></cell> -</row> -<row> -<cell>OTP</cell> -<cell>APN 181 01</cell> -<cell>P1H</cell> -</row> -<row> -<cell>ERTS (sunos4)</cell> -<cell>CXC 138 10/1</cell> -<cell>P1G</cell> -</row> -<row> -<cell>ERTS (sunos5)</cell> -<cell>CXC 138 10/2</cell> -<cell>P1G</cell> -</row> -<row> -<cell>SASL (BOS) (sunos4)</cell> -<cell>CXC 138 11/1</cell> -<cell>P1D</cell> -</row> -<row> -<cell>SASL (BOS) (sunos5)</cell> -<cell>CXC 138 11/2</cell> -<cell>P1D</cell> -</row> -<row> -<cell>MNESIA</cell> -<cell>CXC 138 12/1</cell> -<cell>P1E</cell> -</row> -<row> -<cell>SNMPEA</cell> -<cell>CXC 138 13/1</cell> -<cell>P1D</cell> -</row> -<row> -<cell>ERLDEV (Compiler & Debugger)</cell> -<cell>CXC 138 15/1</cell> -<cell>P1C</cell> -</row> -<row> -<cell>DEVTOOLS (sunos4)</cell> -<cell>CXC 138 16/1</cell> -<cell>P1D</cell> -</row> -<row> -<cell>DEVTOOLS (sunos5)</cell> -<cell>CXC 138 16/2</cell> -<cell>P1D</cell> -</row> -<row> -<cell>XLATETOOLS (sunos4)</cell> -<cell>CXC 138 17/1</cell> -<cell>P1D</cell> -</row> -<row> -<cell>XLATETOOLS (sunos5)</cell> -<cell>CXC 138 17/2</cell> -<cell>P1D</cell> -</row> -<row> -<cell>CPO Solaris (XNTP)</cell> -<cell>CXC 138 46/1</cell> -<cell>P1A</cell> -</row> -</table> -</section> -<section><title>Document Survey</title> -<p> -<table> -<row> -<cell><b>Document name</b></cell> -<cell><b>Document number</b></cell> -<cell>Rev</cell> -</row> -<row> -<cell>Systems Overview</cell> -<cell>1551-APN 181 01</cell> -<cell>A</cell> -</row> -<row> -<cell>Erlang Tools Introduction</cell> -<cell>EPK-95:030/1</cell> -<cell>A</cell> -</row> -<row> -<cell>Erlang Tools User's Guide</cell> -<cell>EPK-95:030/2</cell> -<cell>A</cell> -</row> -<row> -<cell>Erlang Tools</cell> -<cell>EPK-95:030/3</cell> -<cell>A</cell> -</row> -<row> -<cell>Distributed Erlang User's Guide</cell> -<cell>EPK-95:030/4</cell> -<cell>A</cell> -</row> -<row> -<cell>Erlang Tools Examples</cell> -<cell>EPK-95:030/5</cell> -<cell>A</cell> -</row> - -<row> -<cell>User's Guide to the Erlang Interface Library</cell> -<cell>3/1553-CNA 121 16</cell> -<cell>A</cell> -</row> -<row> -<cell>Erlang Interface Library Examples</cell> -<cell>1/198 17-CNA 121 16</cell> -<cell>A</cell> -</row> -<row> -<cell>Programmer's Guide to the Erlang Interface Library</cell> -<cell>2/198 17-CNA 121 16</cell> -<cell>A</cell> -</row> - -<row> -<cell>OTP Erlang User's guide</cell> -<cell>1553-CNA 121 17</cell> -<cell>A</cell> -</row> - -<row> -<cell>The Mnesia Query Language Mnemosyne</cell> -<cell>1553-CNA 121 18</cell> -<cell>A</cell> -</row> - -<row> -<cell>SNMPEA User's Guide</cell> -<cell>1553-CNA 121 19</cell> -<cell>A</cell> -</row> - -<row> -<cell>SNMPEA Reference Guide</cell> -<cell>1551-CNA 121 19</cell> -<cell>A</cell> -</row> - -<row> -<cell>User's Guide to the Interface Generator</cell> -<cell>1553-CNA 121 38</cell> -<cell>A</cell> -</row> - -</table> - -<p> -A complete browseable document survey is available at the OTP WWW-server http://otp.ericsson.se and can also be found in the release at $OTP_ROOT/doc/all.html when the -release file is un-tar:ed at $OTP_ROOT. -</section> -<section><title>Implemented Change requests</title> -<p> -- -</section> -<section><title>Implemented Trouble Reports</title> -<p> -<table> -<row> -<cell><b>Block</b></cell> -<cell><b>TR id</b></cell> -<cell><b>Slogan</b></cell> -</row> -<row> -<cell>ERTS</cell> -<cell>-</cell> -<cell> -erl_call crashes (Segmentation fault) has now been fixed -</cell> -</row> -</table> -</section> -<section><title>Installation Instructions</title> -<p> -The release is delivered as a compressed tar-file <b>otp_APN18101_P1H.<target>.tar.Z</b>, where <target> is substituted with <b>sunos4</b> or <b>sunos5</b>. -<p> -Then the following steps shall be performed at installation time: -</p> -<list> -<item><p>Create a new directory $OTP_INSTALL_DIR where OTP can be installed. -<code> -mkdir $OTP_INSTALL_DIR -cd $OTP_INSTALL_DIR -uncompress $XXX/otp_APN18101_P1H.<target>.tar.Z -tar xvfp $XXX/otp_APN18101_P1H.<target>.tar -</code> -</item> -<item><p>Run the OTP installscript and answer the questions. -<code> -./Install $OTP_INSTALL_DIR -</code> -<p> -The Install command will ask a number of questions during the installation. -<b>OBS!</b> When installing on a system where DNS is not used you -should answer <b>NO</b> on the question "WILL YOU USE DNS?" -</item> -<item><p>Prepare the OTP man pages. -<code> -mkdir man/cat1 man/cat3 -./format_man_pages -</code> -<item><p>Update the erl_interface library with ranlib (sunos4 only). -<code> -cd $OTP_INSTALL_DIR/usr/lib -ranlib liberl_interface.a -</code> -</item> -</list> -<p> -Add $OTP_INSTALL_DIR/bin to the path variable and $OTP_INSTALL_DIR/man to the MANPATH variable. -<p> -Where <b>$XXX</b> denotes the path at which otp_APN18101_P1H.<target>.tar resides. - -<section><title>Separate (optional) Installation of XNTP (Network Time Protocol)</title> -<p> -XNTP (Network Time Protocol) <b>for use in an embedded system running Sunos5</b> is -delivered in this release. The XNTP resides in the tar-file xntp_CXC_13846_P1A.sunos5.tar.Z and can be fetched with Netscape from the same place as the other OTP deliverables. -<list> -<item><p>Create a new directory $XNTP_DIR where the XNTP distribution can be loaded. -<code> -mkdir $XNTP_DIR -cd $XNTP_DIR -uncompress $XXX/xntp_CXC_13846_P1A.sunos5.tar.Z -tar xvf $XXX/xntp_CXC_13846_P1A.sunos5.tar.Z -</code> -</item> -<item><p>Read the README-file which is included, below follows information which -is partly the same as can be found at the end of the README file.</item> -<item><p>Note, the xntp3.5a.export subdirectory is not needed for installation. - -<p>Create a suitable configuration file based on the samples in the -'config' directory, and copy it to /etc/ntp.conf.</item> - -<item><p>Create a directory for the binaries and copy them there:<br> -<code> -mkdir -p /opt/xntp/bin -cp bin/* /opt/xntp/bin -</code> -<p>Note!, if you prefer another installation directory for the binaries, you have to edit one line in the "Run Commands" script xntp (located in the init directory): -<code> -BINDIR=<your new bindir>; -</code> -</item> - -<item><p>Install the "Run Commands" script:<br> -<code> -cp init/xntp /etc/init.d/xntp<br> -ln /etc/init.d/xntp /etc/rc0.d/K57xntp -ln /etc/init.d/xntp /etc/rc1.d/K57xntp -ln /etc/init.d/xntp /etc/rc2.d/S78xntp -</code> -</item> - -<item><p>Modify the /etc/system file (you probably want to save the original):<br> -<code> -cat init/system >> /etc/system -</code> -</item> - -</list> -<p> -Where <b>$XXX</b> denotes the path at which xntp_CXC13846_P1A.sunos5.tar.Z resides. -</section> -</section> - -<section><title>Some useful notes</title> -<p> -To make it possible to browse Framemaker documents through Netscape the files -.mime.types and .mailcap should be modified (see below). The modifications -can be made as systems defaults if they are placed in e.g /usr/local/lib/netscape (see Netscape Handbook for details) or as personal defaults if placed in the -users $HOME directory. -<p> -.mime.types -<p> -<pre> -application/x-maker fm -</pre> -<p> - -.mailcap -<p> -<pre> -application/x-maker; fmclient -f %s -</pre> -</section> -<section><title>Known problems in this release</title> -<p> -<list> -<item><p>In the manual-page for module code, the returned value of the function -which is described to be String but in reality it is an Atom (for compatibility -reasons). In the next release the return type will however be String as it says -in the manual-page.</item> -<item><p>On SunOS4.x platforms, the format_man_pages script (executed as a part of installation) will cause following error messages for missing manual sections: -<p><code>opendir:man{2,4,5,6,7,8,l,n}: No such file or directory</code> -<p>These messages should be ignored. -</item> - -</list> -</section> -<section><title>References</title> -<p> -<i>Nothing to reference</i> - -</section> -</report> - - - - - - - - - diff --git a/system/ADbeam.html b/system/ADbeam.html deleted file mode 100644 index abb80c9f0a..0000000000 --- a/system/ADbeam.html +++ /dev/null @@ -1,261 +0,0 @@ -<HTML> -<HEAD> -<TITLE>AMENDMENT DIRECTIVE, OTP-BEAM - </TITLE> -</HEAD> -<BODY BGCOLOR="#FFFFFF"> -<TABLE WIDTH=100%> -<TR> -<TD ROWSPAN=2 WIDTH=50%><IMG ALT="Ericsson" SRC="http://otp.ericsson.se/pics/logo/elogo.gif"></TD> -<TD VALIGN=TOP WIDTH=50%><BR><BR></TD> -</TR> -<TR> -<TD VALIGN=TOP WIDTH=50%><B>OTP Report</B></TD> -</TR> -</TABLE><CENTER> -<TABLE BORDER CELLSPACING=0 CELLPADDING=2 WIDTH=100%> -<TR> -<TD VALIGN=TOP WIDTH=30% COLSPAN=3> -<FONT SIZE=1>Uppgjord - <I>Prepared</I></FONT><BR> -<FONT SIZE=3>UAB/F Kenneth Lundin, Lars Thors�n -</FONT> -</TD> -<TD VALIGN=TOP WIDTH=20% COLSPAN=2 NOWRAP> -<FONT SIZE=1>Faktaansvarig - <I>Subject responsible</I></FONT><BR> -<FONT SIZE=3> </FONT><BR> -</TD> -<TD VALIGN=TOP WIDTH=50% COLSPAN=5> -<FONT SIZE=1>Nr - <I>No</I></FONT><BR> -<FONT SIZE=3>3/177 82 - APN 181 01 -</FONT> -</TD> -</TR> -<TR> -<TD VALIGN=TOP WIDTH=40% COLSPAN=4 NOWRAP> -<FONT SIZE=1>Dokansv/Godk - <I>Doc respons/Approved</I></FONT><BR> -<FONT SIZE=3>ETX/B/DU Torbjörn Johnsson -</FONT> -</TD> -<TD VALIGN=TOP WIDTH=10%> -<FONT SIZE=1>Kontr - <I>Checked</I></FONT><BR> -<FONT SIZE=3> </FONT> -</TD> -<TD VALIGN=TOP WIDTH=20% COLSPAN=2 NOWRAP> -<FONT SIZE=1>Datum - <I>Date</I></FONT><BR> -<FONT SIZE=3>960828 -</FONT></TD> -<TD VALIGN=TOP WIDTH=10%><FONT SIZE=1>Rev</FONT><BR> -<FONT SIZE=3>D -</FONT> -</TD> -<TD VALIGN=TOP WIDTH=20% COLSPAN=2> -<FONT SIZE=1>File</FONT><BR> -<FONT SIZE=3>tr1c.sgml -<BR></FONT> -</TD> -</TR> -</TABLE><P> -<A HREF="http://otp.ericsson.se/"> -<STRONG>OTP</STRONG></A> / -<STRONG>...</STRONG> / -<A HREF="../ - "> -<STRONG>Up</STRONG></A> / -<P><B><FONT SIZE=8>AMENDMENT DIRECTIVE, OTP-BEAM -</FONT></B> -</CENTER> -<HR> -<H2>Introduction</H2> -<P> -<H3>Purpose</H3> -<P>This is a first prototype release of the OTP-BEAM system for SunOS5. -This version is intended to be used for various capacity measurements and the functionality is comparable to that of OTP rev P1D (APN 181 01 P1D). - -<H3>Revision History</H3> -<P>Rev.A:Kenneth Lundin 1996-08-28<BR> - -<P>The exact changes between revisions of this document can be generated from our ClearCase repository upon request , or a simple unix "diff" can be used. -<H2>Product Identities</H2> -<P><CENTER><TABLE BORDER=1> -<TR> -<TH>Product Name</TH> -<TH>Product Number</TH> -<TH>R-state</TH> -</TR> -<TR> -<TD>OTP</TD> -<TD>APN 181 01</TD> -<TD>P1D</TD> -</TR> -<TR> -<TD>ERTS (sunos5-beam)</TD> -<TD>CXC 138 10/3</TD> -<TD>P1D</TD> -</TR> -<TR> -<TD>SASL (BOS) (sunos5-beam)</TD> -<TD>CXC 138 11/3</TD> -<TD>P1C</TD> -</TR> -<TR> -<TD>MNESIA</TD> -<TD>CXC 138 12/1</TD> -<TD>P1C</TD> -</TR> -<TR> -<TD>SNMPEA</TD> -<TD>CXC 138 13/1</TD> -<TD>P1C</TD> -</TR> -<TR> -<TD>ERLDEV (Compiler & Debugger)</TD> -<TD>CXC 138 15/1</TD> -<TD>P1B</TD> -</TR> -<TR> -<TD>DEVTOOLS (sunos5-beam)</TD> -<TD>CXC 138 16/3</TD> -<TD>P1C</TD> -</TR> -<TR> -<TD>XLATETOOLS (sunos5-beam)</TD> -<TD>CXC 138 17/3</TD> -<TD>P1C</TD> -</TR> -</TABLE></CENTER> - -<H2>Document Survey</H2> -<P><CENTER><TABLE BORDER=1> -<TR> -<TH>Document name</TH> -<TH>Document number</TH> -<TH>Rev</TH> -</TR> -<TR> -<TD>Systems Overview</TD> -<TD>1551-APN 181 01</TD> -<TD>A</TD> -</TR> -<TR> -<TD>Erlang Tools Introduction</TD> -<TD>EPK-95:030/1</TD> -<TD>A</TD> -</TR> -<TR> -<TD>Erlang Tools User's Guide</TD> -<TD>EPK-95:030/2</TD> -<TD>A</TD> -</TR> -<TR> -<TD>Erlang Tools</TD> -<TD>EPK-95:030/3</TD> -<TD>A</TD> -</TR> -<TR> -<TD>Distributed Erlang User's Guide</TD> -<TD>EPK-95:030/4</TD> -<TD>A</TD> -</TR> -<TR> -<TD>Erlang Tools Examples</TD> -<TD>EPK-95:030/5</TD> -<TD>A</TD> -</TR> -<TR> -<TD>User's Guide to the Erlang Interface Library</TD> -<TD>3/1553-CNA 121 16</TD> -<TD>A</TD> -</TR> -<TR> -<TD>Erlang Interface Library Examples</TD> -<TD>1/198 17-CNA 121 16</TD> -<TD>A</TD> -</TR> -<TR> -<TD>Programmer's Guide to the Erlang Interface Library</TD> -<TD>2/198 17-CNA 121 16</TD> -<TD>A</TD> -</TR> -<TR> -<TD>OTP Erlang User's guide</TD> -<TD>1553-CNA 121 17</TD> -<TD>A</TD> -</TR> -<TR> -<TD>Mnesia Users Guide (changed name and much improved)</TD> -<TD>1553-CNA 121 18</TD> -<TD>PB1</TD> -</TR> -<TR> -<TD>SNMPEA User's Guide</TD> -<TD>1553-CNA 121 19</TD> -<TD>A</TD> -</TR> -<TR> -<TD>SNMPEA Reference Guide</TD> -<TD>1551-CNA 121 19</TD> -<TD>A</TD> -</TR> -<TR> -<TD>User's Guide to the Interface Generator</TD> -<TD>1553-CNA 121 38</TD> -<TD>A</TD> -</TR> -</TABLE></CENTER> - - -<P>A complete browseable document survey is available at the OTP WWW-server http://otp.ericsson.se and can also be found in the release at $OTP_ROOT/doc/all.html when the -release file is un-tar:ed at $OTP_ROOT. -<H2>Implemented Change requests</H2> -<P>Comparable in functionality with OTP 181 01 P1D (jam). - -<H2>Implemented Trouble Reports</H2> -<P>This is the first version. - -<H2>Installation Instructions</H2> -<P><B>OBS! The installation path selected below must not be the same as the one used for an OTP -jam system. </B> -<P>The release is delivered as a compressed tar-file -<B>otp_APN18101_beam_P1D.<target>.tar.Z</B>, -where <target> is substituted with <B>sunos5</B>. -<P>Then the following steps shall be performed at installation time: -<UL> -<LI>mkdir <I><installation path></I> -<LI>cd <I><installation path></I> -<LI>uncompress $XXX/otp_APN18101_beam_P1D.<target>.tar.Z -<LI>tar xvfp $XXX/otp_APN18101_beam_P1D.<target>.tar -<LI>./Install <I><installation path></I><BR> -The Install command will ask a number of questions during the installation.<BR> -<B>OBS!</B> When installing on a system where DNS is not used you -should answer <B>NO</B> on the question "WILL YOU USE DNS?" -<LI>mkdir man/cat1 man/cat3 -<LI>./format_man_pages -<LI>cd <I><installation path></I>/usr/lib and run ranlib on liberl_interface.a (only sunos4) -</UL> - -Add <I><installation path></I>/bin to the path variable and <I><installation path></I>/man to the MANPATH variable. -<P>Where $XXX denotes the path at which otp_APN18101_beam_P1D.<target>.tar resides. -<H2>Some useful notes</H2> -<P>To make it possible to browse Framemaker documents through Netscape the files -.mime.types and .mailcap should be modified (see below). The modifications -can be made as systems defaults if they are placed in e.g /usr/local/lib/netscape (see Netscape Handbook for details) or as personal defaults if placed in the -users $HOME directory. -<P>.mime.types -<P> -<PRE>application/x-maker fm</PRE> - -<P> -.mailcap -<P> -<PRE>application/x-maker; fmclient -f %s</PRE> - -<H2>Known problems in this release</H2> -<P><UL> -<LI>Some html-links may still be faulty. -</UL> - -<H2>References</H2> -<P><I>Nothing to reference</I> - - -</BODY> -</HTML>
\ No newline at end of file diff --git a/system/ADbeam.sgml b/system/ADbeam.sgml deleted file mode 100644 index 63995fe26e..0000000000 --- a/system/ADbeam.sgml +++ /dev/null @@ -1,246 +0,0 @@ -<!doctype report PUBLIC "-//Stork//DTD tr1c//EN"> - -<report> - <header> - <title>AMENDMENT DIRECTIVE, OTP-BEAM - <prepared>ETX/B/DUP Kenneth Lundin, Lars Thorsén - <responsible> - <docno>3/177 82 - APN 181 01 - <approved>ETX/B/DU Torbjörn Johnsson - <checked> - <date>960828 - <rev>D - <file>tr1c.sgml - <parent>../ - </header> - - <section> -<h1>Introduction</h1> -<p> -<h2>Purpose</h2> -<p> -This is a first prototype release of the OTP-BEAM system for SunOS5. -This version is intended to be used for various capacity measurements and the functionality is comparable to that of OTP rev P1D (APN 181 01 P1D). - -<h2>Revision History</h2> -<p> -Rev.A:Kenneth Lundin 1996-08-28<br> - -<p> -The exact changes between revisions of this document can be generated from our ClearCase repository upon request , or a simple unix "diff" can be used. -<h1>Product Identities</h1> -<p> -<table> -<row> -<hcell>Product Name -<hcell>Product Number -<hcell>R-state -</row> -<row> -<cell>OTP -<cell>APN 181 01 -<cell>P1D -</row> -<row> -<cell>ERTS (sunos5-beam) -<cell>CXC 138 10/3 -<cell>P1D -</row> -<row> -<cell>SASL (BOS) (sunos5-beam) -<cell>CXC 138 11/3 -<cell>P1C -</row> -<row> -<cell>MNESIA -<cell>CXC 138 12/1 -<cell>P1C -</row> -<row> -<cell>SNMPEA -<cell>CXC 138 13/1 -<cell>P1C -</row> -<row> -<cell>ERLDEV (Compiler & Debugger) -<cell>CXC 138 15/1 -<cell>P1B -</row> -<row> -<cell>DEVTOOLS (sunos5-beam) -<cell>CXC 138 16/3 -<cell>P1C -</row> -<row> -<cell>XLATETOOLS (sunos5-beam) -<cell>CXC 138 17/3 -<cell>P1C -</row> -</table> -<h1>Document Survey</h1> -<p> -<table> -<row> -<hcell>Document name -<hcell>Document number -<hcell>Rev -</row> -<row> -<cell>Systems Overview -<cell>1551-APN 181 01 -<cell>A -</row> -<row> -<cell>Erlang Tools Introduction -<cell>EPK-95:030/1 -<cell>A -</row> -<row> -<cell>Erlang Tools User's Guide -<cell>EPK-95:030/2 -<cell>A -</row> -<row> -<cell>Erlang Tools -<cell>EPK-95:030/3 -<cell>A -</row> -<row> -<cell>Distributed Erlang User's Guide -<cell>EPK-95:030/4 -<cell>A -</row> -<row> -<cell>Erlang Tools Examples -<cell>EPK-95:030/5 -<cell>A -</row> - -<row> -<cell>User's Guide to the Erlang Interface Library -<cell>3/1553-CNA 121 16 -<cell>A -</row> -<row> -<cell>Erlang Interface Library Examples -<cell>1/198 17-CNA 121 16 -<cell>A -</row> -<row> -<cell>Programmer's Guide to the Erlang Interface Library -<cell>2/198 17-CNA 121 16 -<cell>A -</row> - -<row> -<cell>OTP Erlang User's guide -<cell>1553-CNA 121 17 -<cell>A -</row> - -<row> -<cell>Mnesia Users Guide (changed name and much improved) -<cell>1553-CNA 121 18 -<cell>PB1 -</row> - -<row> -<cell>SNMPEA User's Guide -<cell>1553-CNA 121 19 -<cell>A -</row> - -<row> -<cell>SNMPEA Reference Guide -<cell>1551-CNA 121 19 -<cell>A -</row> - -<row> -<cell>User's Guide to the Interface Generator -<cell>1553-CNA 121 38 -<cell>A -</row> - -</table> - -<p> -A complete browseable document survey is available at the OTP WWW-server http://otp.ericsson.se and can also be found in the release at $OTP_ROOT/doc/all.html when the -release file is un-tar:ed at $OTP_ROOT. -<h1>Implemented Change requests</h1> -<p> -Comparable in functionality with OTP 181 01 P1D (jam). - -<h1>Implemented Trouble Reports</h1> -<p> -This is the first version. - -<h1>Installation Instructions</h1> -<p> -<b>OBS! The installation path selected below must not be the same as the one used for an OTP -jam system. </b> -<p> -The release is delivered as a compressed tar-file -<b>otp_APN18101_beam_P1D.<target>.tar.Z</b>, -where <target> is substituted with <b>sunos5</b>. -<p> -Then the following steps shall be performed at installation time: -<list> -<item>mkdir <i><installation path></i> -<item>cd <i><installation path></i> -<item>uncompress $XXX/otp_APN18101_beam_P1D.<target>.tar.Z -<item>tar xvfp $XXX/otp_APN18101_beam_P1D.<target>.tar -<item>./Install <i><installation path></i><br> -The Install command will ask a number of questions during the installation.<br> -<b>OBS!</b> When installing on a system where DNS is not used you -should answer <b>NO</b> on the question "WILL YOU USE DNS?" -<item>mkdir man/cat1 man/cat3 -<item>./format_man_pages -<item>cd <i><installation path></i>/usr/lib and run ranlib on liberl_interface.a (only sunos4) -</list> -Add <i><installation path></i>/bin to the path variable and <i><installation path></i>/man to the MANPATH variable. -<p> -Where $XXX denotes the path at which otp_APN18101_beam_P1D.<target>.tar resides. -<h1>Some useful notes</h1> -<p> -To make it possible to browse Framemaker documents through Netscape the files -.mime.types and .mailcap should be modified (see below). The modifications -can be made as systems defaults if they are placed in e.g /usr/local/lib/netscape (see Netscape Handbook for details) or as personal defaults if placed in the -users $HOME directory. -<p> -.mime.types -<p> -<pre> -application/x-maker fm -</pre> -<p> - -.mailcap -<p> -<pre> -application/x-maker; fmclient -f %s -</pre> -<h1>Known problems in this release</h1> -<p> -<list> -<item>Some html-links may still be faulty. -</list> -<h1>References</h1> -<p> -<i>Nothing to reference</i> - - </section> -</report> - - - - - - - - - - - - - - diff --git a/system/doc/book.xml b/system/doc/book.xml deleted file mode 100644 index d1ec093019..0000000000 --- a/system/doc/book.xml +++ /dev/null @@ -1,52 +0,0 @@ -<?xml version="1.0" encoding="latin1" ?> -<!DOCTYPE book SYSTEM "book.dtd"> - -<book xmlns:xi="http://www.w3.org/2001/XInclude"> - <header titlestyle="normal"> - <copyright> - <year>1997</year><year>2009</year> - <holder>Ericsson AB. All Rights Reserved.</holder> - </copyright> - <legalnotice> - 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 - compliance with the License. You should have received a copy of the - Erlang Public License along with this software. If not, it can be - retrieved online at http://www.erlang.org/. - - Software distributed under the License is distributed on an "AS IS" - basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See - the License for the specific language governing rights and limitations - under the License. - - </legalnotice> - - <title>Erlang/OTP System Documentation</title> - <prepared>OTP Team</prepared> - <docno></docno> - <date>2009-08-21</date> - <rev>A</rev> - <file>book.xml</file> - </header> - <insidecover> - </insidecover> - <pagetext></pagetext> - <preamble> - <contents level="2"></contents> - </preamble> - <parts lift="no"> - <xi:include href="installation_guide/part.xml"/> - <xi:include href="system_principles/part.xml"/> - <xi:include href="embedded/part.xml"/> - <xi:include href="getting_started/part.xml"/> - <xi:include href="reference_manual/part.xml"/> - <xi:include href="getting_started/part.xml"/> - <xi:include href="efficiency_guide/part.xml"/> - <xi:include href="tutorial/part.xml"/> - <xi:include href="design_principles/part.xml"/> - <xi:include href="oam/part.xml"/> - </parts> - <listofterms></listofterms> - <index></index> -</book> - diff --git a/system/doc/extensions/Makefile b/system/doc/extensions/Makefile deleted file mode 100644 index cfc506f7e8..0000000000 --- a/system/doc/extensions/Makefile +++ /dev/null @@ -1,142 +0,0 @@ -# ``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 -# compliance with the License. You should have received a copy of the -# Erlang Public License along with this software. If not, it can be -# retrieved via the world wide web at http://www.erlang.org/. -# -# Software distributed under the License is distributed on an "AS IS" -# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See -# the License for the specific language governing rights and limitations -# under the License. -# -# The Initial Developer of the Original Code is Ericsson Utvecklings AB. -# Portions created by Ericsson are Copyright 1999, Ericsson Utvecklings -# AB. All Rights Reserved.'' -# -# $Id$ -# -include $(ERL_TOP)/make/target.mk -include $(ERL_TOP)/make/$(TARGET)/otp.mk - -# ---------------------------------------------------- -# Application version -# ---------------------------------------------------- -include $(ERL_TOP)/erts/vsn.mk -#VSN=$(SYSTEM_VSN) - -# ---------------------------------------------------- -# Include dependency -# ---------------------------------------------------- - -include make.dep - -# ---------------------------------------------------- -# Release directory specification -# ---------------------------------------------------- -RELSYSDIR = $(RELEASE_PATH)/doc/extensions - -# ---------------------------------------------------- -# Target Specs -# ---------------------------------------------------- -XML_PART_FILES = part.xml -XML_CHAPTER_FILES = \ - funs.xml \ - macros.xml \ - misc.xml \ - include.xml \ - records.xml \ - list_comprehensions.xml \ - bit_syntax.xml - -BOOK_FILES = book.xml - -GIF_FILES = note.gif - -PS_FILES = - -# ---------------------------------------------------- - -HTML_FILES = \ - $(XML_PART_FILES:%.xml=%.html) - -HTMLDIR = . -EXTRA_FILES = $(DEFAULT_GIF_FILES) \ - $(DEFAULT_HTML_FILES) \ - $(XML_CHAPTER_FILES:%.xml=%.html) - -TEX_FILES_BOOK = \ - $(BOOK_FILES:%.xml=%.tex) -TEX_FILES_USERS_GUIDE = \ - $(XML_CHAPTER_FILES:%.xml=%.tex) - -TOP_PDF_FILE = extensions-$(VSN).pdf -TOP_PS_FILE = extensions-$(VSN).ps - -$(TOP_PDF_FILE): book.dvi $(ERL_TOP)/erts/vsn.mk - $(DVI2PS) $(DVIPS_FLAGS) -f $< | $(DISTILL) $(DISTILL_FLAGS) > $@ - -$(TOP_PS_FILE): book.dvi $(ERL_TOP)/erts/vsn.mk - $(DVI2PS) $(DVIPS_FLAGS) -f $< > $@ - -# ---------------------------------------------------- -# FLAGS -# ---------------------------------------------------- -XML_FLAGS += -DVIPS_FLAGS += - -# ---------------------------------------------------- -# Targets -# ---------------------------------------------------- - -ifeq ($(DOCTYPE),pdf) -docs: pdf -else -ifeq ($(DOCTYPE),ps) -docs: ps -else -docs: html -endif -endif - -pdf: $(TOP_PDF_FILE) - -ps: $(TOP_PS_FILE) - -html: $(HTML_FILES) $(GIF_FILES) - -debug opt: - -clean_tex: - -rm -f $(TEX_FILES_USERS_GUIDE) $(TEX_FILES_BOOK) - -clean: - rm -f *.html $(TEX_FILES_USERS_GUIDE) - rm -f $(TOP_PS_FILES) - rm -f errs core *~ $(LATEX_CLEAN) - -# ---------------------------------------------------- -# Release Target -# ---------------------------------------------------- -include $(ERL_TOP)/make/otp_release_targets.mk - -ifeq ($(DOCTYPE),pdf) -release_docs_spec: pdf - $(INSTALL_DIR) $(RELEASE_PATH)/pdf - $(INSTALL_DATA) $(TOP_PDF_FILE) $(RELEASE_PATH)/pdf -else -ifeq ($(DOCTYPE),ps) -release_docs_spec: ps - $(INSTALL_DIR) $(RELEASE_PATH)/ps - $(INSTALL_DATA) $(TOP_PS_FILE) $(RELEASE_PATH)/ps -else -release_docs_spec: docs - $(INSTALL_DIR) $(RELSYSDIR) - $(INSTALL_DATA) $(GIF_FILES) $(EXTRA_FILES) $(HTML_FILES) \ - $(RELSYSDIR) -endif -endif - -release_spec: - - - diff --git a/system/doc/extensions/bit_syntax.xml b/system/doc/extensions/bit_syntax.xml deleted file mode 100644 index d86f73cd9a..0000000000 --- a/system/doc/extensions/bit_syntax.xml +++ /dev/null @@ -1,403 +0,0 @@ -<?xml version="1.0" encoding="latin1" ?> -<!DOCTYPE chapter SYSTEM "chapter.dtd"> - -<chapter> - <header> - <copyright> - <year>2000</year><year>2009</year> - <holder>Ericsson AB. All Rights Reserved.</holder> - </copyright> - <legalnotice> - 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 - compliance with the License. You should have received a copy of the - Erlang Public License along with this software. If not, it can be - retrieved online at http://www.erlang.org/. - - Software distributed under the License is distributed on an "AS IS" - basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See - the License for the specific language governing rights and limitations - under the License. - - </legalnotice> - - <title>The Bit Syntax</title> - <prepared>Björn Gustavsson</prepared> - <responsible>Bjarne Däcker</responsible> - <docno>1</docno> - <approved>Bjarne DäKer</approved> - <checked></checked> - <date>00-06-21</date> - <rev>PA1</rev> - <file>bit_syntax.sgml</file> - </header> - <p>This section describes the "bit syntax" which was added to - the Erlang language in release 5.0 (R7). - Compared to the original bit syntax prototype - by Claes Wikström and Tony Rogvall (presented on the - Erlang User's Conference 1999), this implementation differs - primarily in the following respects, - </p> - <list type="ordered"> - <item> - <p>the character pairs '<<' and '>>' are used to delimit - a binary patterns and constructor (not '<' and '>' as in - the prototype), - </p> - </item> - <item> - <p>the tail syntax ('|Variable') has been eliminated, - </p> - </item> - <item> - <p>all size expressions must be bound, - </p> - </item> - <item> - <p>a type <c>unit:U</c> has been added, - </p> - </item> - <item> - <p>lists and tuples cannot be generated - </p> - </item> - <item> - <p>there are no paddings whatsoever. - </p> - </item> - </list> - - <section> - <title>Introduction</title> - <p>In Erlang a Bin is used for constructing binaries and - matching binary patterns. A Bin is written with the - following syntax:</p> - <code type="none"><![CDATA[ - <<E1, E2, ... En>> - ]]></code> - <p>A Bin is a low-level sequence of bytes. The purpose of a - Bin is to be able to, from a high level, - <em>construct</em> a binary, - </p> - <code type="none"><![CDATA[ - Bin = <<E1, E2, ... En>> - ]]></code> - <p>in which case all elements must be bound, or to - <em>match</em> a binary, - </p> - <code type="none"><![CDATA[ - <<E1, E2, ... En>> = Bin - ]]></code> - <p>where <c>Bin</c> is bound, and where the elements are bound or unbound, - as in any match. - </p> - <p>Each element specifies a certain <em>segment</em> of the binary. - A segment is is a set of contiguous bits of the binary (not - necessarily on a byte boundary). The first element specifies - the initial segment, the second element specifies the following - segment etc. - </p> - <p>The following examples illustrate how binaries are constructed - or matched, and how elements and tails are specified. - </p> - - <section> - <title>Examples</title> - <p><em>Example 1: </em>A binary can be constructed from a set of - constants or a string literal:</p> - <code type="none"><![CDATA[ - Bin11 = <<1, 17, 42>>, - Bin12 = <<"abc">> - ]]></code> - <p>yields binaries of size 3; <c>binary_to_list(Bin11)</c> - evaluates to <c>[1, 17, 42]</c>, and - <c>binary_to_list(Bin12)</c> evaluates to <c>[97, 98, 99]</c>. - </p> - <p><em>Example 2: </em>Similarly, a binary can be constructed - from a set of bound variables:</p> - <code type="none"><![CDATA[ - A = 1, B = 17, C = 42, - Bin2 = <<A, B, C:16>> - ]]></code> - <p>yields a binary of size 4, and <c>binary_to_list(Bin2)</c> - evaluates to <c>[1, 17, 00, 42]</c> too. Here we used a - <em>size expression</em> for the variable <c>C</c> in order to - specify a 16-bits segment of <c>Bin2</c>. - </p> - <p><em>Example 3: </em>A Bin can also be used for matching: if - <c>D</c>, <c>E</c>, and <c>F</c> are unbound variables, and - <c>Bin2</c> is bound as in the former example,</p> - <code type="none"><![CDATA[ - <<D:16, E, F/binary>> = Bin2 - ]]></code> - <p>yields <c>D = 273</c>, <c>E = 00</c>, and F binds to a binary - of size 1: <c>binary_to_list(F) = [42]</c>. - </p> - <p><em>Example 4: </em>The following is a more elaborate example - of matching, where <c>Dgram</c> is bound to the consecutive - bytes of an IP datagram of IP protocol version 4, and where we - want to extract the header and the data of the datagram:</p> - <code type="none"><![CDATA[ - -define(IP_VERSION, 4). - -define(IP_MIN_HDR_LEN, 5). - - DgramSize = byte_size(Dgram), - case Dgram of - <<?IP_VERSION:4, HLen:4, SrvcType:8, TotLen:16, - ID:16, Flgs:3, FragOff:13, - TTL:8, Proto:8, HdrChkSum:16, - SrcIP:32, - DestIP:32, RestDgram/binary>> when HLen >= 5, 4*HLen =< DgramSize -> - OptsLen = 4*(HLen - ?IP_MIN_HDR_LEN), - <<Opts:OptsLen/binary,Data/binary>> = RestDgram, - ... - end. - ]]></code> - <p>Here the segment corresponding to the <c>Opts</c> variable - has a <em>type modifier</em> specifying that <c>Opts</c> should - bind to a binary. All other variables have the default type - equal to unsigned integer. - </p> - <p>An IP datagram header is of variable length, and its length - - measured in the number of 32-bit words - is given in the segment - corresponding to <c>HLen</c>, the minimum value of which is - 5. It is the segment corresponding to <c>Opts</c> that is - variable: if <c>HLen</c> is equal to 5, <c>Opts</c> will be an - empty binary. - </p> - <p>The tail variables <c>RestDgram</c> and <c>Data</c> bind to - binaries, as all tail variables do. Both may bind to empty - binaries. - </p> - <p>If the first 4-bits segment of <c>Dgram</c> is not equal to - 4, or if <c>HLen</c> is less than 5, or if the size of - <c>Dgram</c> is less than <c>4*HLen</c>, the match of - <c>Dgram</c> fails. - </p> - </section> - </section> - - <section> - <title>A Lexical Note</title> - <p>Note that "<c><![CDATA[B=<<1>>]]></c>" will be interpreted as - "<c><![CDATA[B =< ;<1>>]]></c>", which is a syntax error. - The correct way to write the expression is "<c><![CDATA[B = <<1>>]]></c>".</p> - </section> - - <section> - <title>Segments</title> - <p>Each segment has the following general syntax:</p> - <p><c>Value:Size/TypeSpecifierList</c></p> - <p>Both the <c>Size</c> and the <c>TypeSpecifier</c> or both may be - omitted; thus the following variations are allowed: - </p> - <p><c>Value</c></p> - <p><c>Value:Size</c></p> - <p><c>Value/TypeSpecifierList</c></p> - <p>Default values will be used for missing specifications. The default - values are described in the section "Defaults" below. - </p> - <p>Used in binary construction, the <c>Value</c> part is any expression. - Used in binary matching, the <c>Value</c> part must be a literal or - variable. You can read more about the <c>Value</c> part in the - sections about constructing binaries and matching binaries. - </p> - <p>The <c>Size</c> part of the segment multiplied by the unit in the - <c>TypeSpecifierList</c> (described below) gives the number of bits - for the segment. In construction, <c>Size</c> is any expression that - evaluates to an integer. In matching, <c>Size</c> must be a constant - expression or a variable. - </p> - <p>The <c>TypeSpecifierList</c> is a list of type specifiers separated by - hyphens. - </p> - <taglist> - <tag>Type</tag> - <item>The type can be <c>integer</c>, <c>float</c>, or <c>binary</c>.</item> - <tag>Signedness</tag> - <item>The signedness specification can be either <c>signed</c> - or <c>unsigned</c>. Note that signedness only matters for matching.</item> - <tag>Endianness</tag> - <item>The endianness specification can be either <c>big</c>, - <c>little</c>, or <c>native</c>. Native-endian means that - the endian will be resolved at load time to be either - big-endian or little-endian, depending on what is "native" - for the CPU that the Erlang machine is run on.</item> - <tag>Unit</tag> - <item>The unit size is given as <c>unit:IntegerLiteral</c>. - The allowed range is 1-256. It will be multiplied by the <c>Size</c> - specifier to give the effective size of the segment.</item> - </taglist> - <p>Example: - </p> - <code type="none"> -X:4/little-signed-integer-unit:8 - </code> - <p>This element has a total size of 4*8 = 32 bits, and it contains a - signed integer in little-endian order.</p> - </section> - - <section> - <title>Defaults</title> - <p>The default type for a segment is <c>integer</c>. The default type - does <em>not</em> depend on the value, even if the value is a literal. - For instance, the default type in '<c><![CDATA[<<3.14>>]]></c>' is <c>integer</c>, - not <c>float</c>. - </p> - <p>The default <c>Size</c> depends on the type. - For <c>integer</c> it is 8. For <c>float</c> it is 64. - For <c>binary</c> it is all of the binary. In matching, this default - value is only valid for the very last element. All other binary elements - in matching must have a size specification. - </p> - <p>The default unit depends on the the type. - For <c>integer</c> and <c>float</c> it is 1. - For <c>binary</c> it is 8. - </p> - <p>The default signedness is <c>unsigned</c>. - </p> - <p>The default endianness is <c>big</c>.</p> - </section> - - <section> - <title>Constructing Binaries</title> - <p>This section describes the rules for constructing binaries using - the bit syntax. Unlike when constructing lists or tuples, the construction - of a binary can fail with a <c>badarg</c> exception. - </p> - <p>There can be zero or more segments in a binary to be constructed. - The expression '<c><![CDATA[<<>>]]></c>' constructs a zero length binary. - </p> - <p>Each segment in a binary can consist of zero or more bits. - There are no alignment rules for individual segments, but the total - number of bits in all segments must be evenly divisible by 8, - or in other words, the resulting binary must consist of a whole number - of bytes. An <c>badarg</c> exception will be thrown if the resulting - binary is not byte-aligned. Example: - </p> - <code type="none"><![CDATA[ -<<X:1,Y:6>> - ]]></code> - <p>The total number of bits is 7, which is not evenly divisible by 8; - thus, there will be <c>badarg</c> exception (and a compiler warning - as well). The following example - </p> - <code type="none"><![CDATA[ -<<X:1,Y:6,Z:1>> - ]]></code> - <p>will successfully construct a binary of 8 bits, or one byte. (Provided - that all of X, Y and Z are integers.) - </p> - <p>As noted earlier, segments have the following general syntax: - </p> - <p><c>Value:Size/TypeSpecifierList</c></p> - <p>When constructing binaries, <c>Value</c> and <c>Size</c> can be - any Erlang expression. However, for syntactical reasons, - both <c>Value</c> and <c>Size</c> must be enclosed in parenthesis - if the expression consists of anything more than a single literal - or variable. The following gives a compiler syntax error: - </p> - <code type="none"><![CDATA[ -<<X+1:8>> - ]]></code> - <p>This expression must be rewritten to - </p> - <code type="none"><![CDATA[ -<<(X+1):8>> - ]]></code> - <p>in order to be accepted by the compiler. - </p> - - <section> - <title>Including Literal Strings</title> - <p>As syntactic sugar, an literal string may be written instead of a - element.</p> - <code type="none"><![CDATA[ -<<"hello">> ]]></code> - <p>which is syntactic sugar for</p> - <code type="none"><![CDATA[ -<<$h,$e,$l,$l,$o>> ]]></code> - </section> - </section> - - <section> - <title>Matching Binaries</title> - <p>This section describes the rules for matching binaries using the - bit syntax. - </p> - <p>There can be zero or more segments in a binary binary pattern. - A binary pattern can occur in every place patterns are allowed, also - inside other patterns. Binary patterns cannot be nested. - </p> - <p>The pattern '<c><![CDATA[<<>>]]></c>' matches a zero length binary. - </p> - <p>Each segment in a binary can consist of zero or more bits. - </p> - <p>A segment of type <c>binary</c> must have a size evenly divisible by 8. - </p> - <p>This means that the following head will never match:</p> - <code type="none"><![CDATA[ -foo(<<X:7/binary,Y:1/binary>>) -> ]]></code> - <p>As noted earlier, segments have the following general syntax: - </p> - <p><c>Value:Size/TypeSpecifierList</c></p> - <p>When matching <c>Value</c> value must be either a variable or an integer - or floating point literal. Expressions are not allowed. - </p> - <p><c>Size</c> must be an integer literal, or a previously bound variable. - Note that the following is not allowed:</p> - <code type="none"><![CDATA[ -foo(N, <<X:N,T/binary>>) -> - {X,T}. ]]></code> - <p>The two occurrences of <c>N</c> are not related. The compiler - will complain that the <c>N</c> in the size field is unbound. - </p> - <p>The correct way to write this example is like this:</p> - <code type="none"><![CDATA[ -foo(N, Bin) -> - <<X:N,T/binary>> = Bin, - {X,T}. ]]></code> - - <section> - <title>Getting the Rest of the Binary</title> - <p>To match out the rest of binary, specify a binary field without size:</p> - <code type="none"><![CDATA[ -foo(<<A:8,Rest/binary>>) -> ]]></code> - <p>As always, the size of the tail must be evenly divisible by 8. - </p> - </section> - </section> - - <section> - <title>Traps and Pitfalls</title> - <p>Assume that we need a function that creates a binary out of a - list of triples of integers. A first (inefficient) version of such - a function could look like this:</p> - <code type="none"><![CDATA[ -triples_to_bin(T) -> - triples_to_bin(T, <<>>). - -triples_to_bin([{X,Y,Z} | T], Acc) -> - triples_to_bin(T, <<Acc/binary, X:32, Y:32, Z:32>>); % inefficient -triples_to_bin([], Acc) -> - Acc. ]]></code> - <p>The reason for the inefficiency of this function is that for - each triple, the binary constructed so far (<c>Acc</c>) is copied. - (Note: The original bit syntax prototype avoided the copy operation - by using segmented binaries, which are not implemented in R7.) - </p> - <p>The efficient way to write this function in R7 is:</p> - <code type="none"><![CDATA[ -triples_to_bin(T) -> - triples_to_bin(T, []). - -triples_to_bin([{X,Y,Z} | T], Acc) -> - triples_to_bin(T, [<<X:32, Y:32, Z:32>> | Acc]); -triples_to_bin([], Acc) -> - list_to_binary(lists:reverse(Acc)). ]]></code> - <p>Note that <c>list_to_binary/1</c> handles deep lists of binaries - and small integers. (This fact was previously undocumented.) - </p> - </section> -</chapter> - diff --git a/system/doc/extensions/book.xml b/system/doc/extensions/book.xml deleted file mode 100644 index ffdbe6cb44..0000000000 --- a/system/doc/extensions/book.xml +++ /dev/null @@ -1,45 +0,0 @@ -<?xml version="1.0" encoding="latin1" ?> -<!DOCTYPE book SYSTEM "book.dtd"> - -<book> - <header titlestyle="normal"> - <copyright> - <year>1997</year> - <year>2007</year> - <holder>Ericsson AB, All Rights Reserved</holder> - </copyright> - <legalnotice> - 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 - compliance with the License. You should have received a copy of the - Erlang Public License along with this software. If not, it can be - retrieved online at http://www.erlang.org/. - - Software distributed under the License is distributed on an "AS IS" - basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See - the License for the specific language governing rights and limitations - under the License. - - The Initial Developer of the Original Code is Ericsson AB. - </legalnotice> - - <title>Erlang Extensions Since 4.4</title> - <prepared>OTP Team</prepared> - <docno></docno> - <date>1997-05-21</date> - <rev></rev> - <file>book.sgml</file> - </header> - <insidecover> - </insidecover> - <pagetext>Erlang Extensions Since 4.4</pagetext> - <preamble> - <contents level="2"></contents> - </preamble> - <parts lift="no"> - <include file="part"></include> - </parts> - <listofterms></listofterms> - <index></index> -</book> - diff --git a/system/doc/extensions/fun_test.erl b/system/doc/extensions/fun_test.erl deleted file mode 100644 index 8472fd87f8..0000000000 --- a/system/doc/extensions/fun_test.erl +++ /dev/null @@ -1,17 +0,0 @@ -%1 --module(fun_test). --export([t1/0, t2/0, t3/0, t4/0, double/1]). --import(lists, [map/2]). - -t1() -> map(fun(X) -> 2 * X end, [1,2,3,4,5]). - -t2() -> map(fun double/1, [1,2,3,4,5]). - -t3() -> map({?MODULE, double}, [1,2,3,4,5]). - -double(X) -> X * 2. -%1 - - -t4() -> - "hello world". diff --git a/system/doc/extensions/funparse.erl b/system/doc/extensions/funparse.erl deleted file mode 100644 index 5e23c90df9..0000000000 --- a/system/doc/extensions/funparse.erl +++ /dev/null @@ -1,74 +0,0 @@ --module(funparse). --compile(export_all). --import(lists, [reverse/1]). - -%17 -%% > hof:parse([a,c]). -%% {ok,{'and',{'or',1,{const,a}},{'or',1,{const,c}}}} -%% > hof:parse([a,d]). -%% {ok,{'and',{'or',1,{const,a}},{'or',2,{const,d}}}} -%% > hof:parse([b,c]). -%% {ok,{'and',{'or',2,{const,b}},{'or',1,{const,c}}}} -%% > hof:parse([b,d]). -%% {ok,{'and',{'or',2,{const,b}},{'or',2,{const,d}}}} -%% > hof:parse([a,b]). -%% fail -%17 - -%% Grammar = (a | b) & (c | d) - -%12 -parse(List) -> - (grammar())(List). -%12 - -%13 -grammar() -> - pand( - por(pconst(a), pconst(b)), - por(pconst(c), pconst(d))). -%13 - -%14 -pconst(X) -> - fun (T) -> - case T of - [X|T1] -> {ok, {const, X}, T1}; - _ -> fail - end - end. -%14 - -%15 -por(P1, P2) -> - fun (T) -> - case P1(T) of - {ok, R, T1} -> - {ok, {'or',1,R}, T1}; - fail -> - case P2(T) of - {ok, R1, T1} -> - {ok, {'or',2,R1}, T1}; - fail -> - fail - end - end - end. -%15 - -%16 -pand(P1, P2) -> - fun (T) -> - case P1(T) of - {ok, R1, T1} -> - case P2(T1) of - {ok, R2, T2} -> - {ok, {'and', R1, R2}}; - fail -> - fail - end; - fail -> - fail - end - end. -%16 diff --git a/system/doc/extensions/funs.xml b/system/doc/extensions/funs.xml deleted file mode 100644 index f9c003c8ee..0000000000 --- a/system/doc/extensions/funs.xml +++ /dev/null @@ -1,486 +0,0 @@ -<?xml version="1.0" encoding="latin1" ?> -<!DOCTYPE chapter SYSTEM "chapter.dtd"> - -<chapter> - <header> - <copyright> - <year>1997</year> - <year>2007</year> - <holder>Ericsson AB, All Rights Reserved</holder> - </copyright> - <legalnotice> - 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 - compliance with the License. You should have received a copy of the - Erlang Public License along with this software. If not, it can be - retrieved online at http://www.erlang.org/. - - Software distributed under the License is distributed on an "AS IS" - basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See - the License for the specific language governing rights and limitations - under the License. - - The Initial Developer of the Original Code is Ericsson AB. - </legalnotice> - - <title>Programming with Funs</title> - <prepared>Joe Armstrong</prepared> - <responsible>Bjarne Däcker</responsible> - <docno>1</docno> - <approved>Bjarne DäKer</approved> - <checked></checked> - <date>96-01-16</date> - <rev>PA1</rev> - <file>funs.sgml</file> - </header> - <p>This section introduces functional objects (Funs). That is a new data type introduced in Erlang 4.4. Functions which takes Funs as arguments, or which return Funs are called higher order functions.</p> - <list type="bulleted"> - <item>Funs can be passed as arguments to other functions, just like lists or tuples</item> - <item>functions can be written which return Funs, just like any other data object.</item> - </list> - - <section> - <title>Higher Order Functions </title> - <p>Funs encourages us to encapsulate common patterns of design into functional forms called higher order functions. These functions not only shortens programs, but also produce clearer programs because the intended meaning of the program is explicitly rather than implicitly stated.</p> - <p>The concepts of higher order functions and procedural abstraction are introduced with two brief examples.</p> - - <section> - <title>Example 1 - map</title> - <p>If we want to double every element in a list, we could write a function named <c>double</c>:</p> - <code type="none"> - -double([H|T]) -> [2*H|double(T)]; -double([]) -> [] </code> - <p>This function obviously doubles the argument entered as input as follows:</p> - <pre> - -> <input>double([1,2,3,4]).</input> -[2,4,6,8] </pre> - <p>We now add the function <c>add_one</c>, which adds one to every element in a list:</p> - <code type="none"> - -add_one([H|T]) -> [H+1|add_one(T)]; -add_one([]) -> []. </code> - <p>These functions, <c>double</c> and <c>add_one</c>, have a very similar structure. We can exploit this fact and write a function <c>map</c> which expresses this similarity:</p> - <codeinclude file="funs1.erl" tag="%1" type="erl"></codeinclude> - <p>We can now express the functions <c>double</c> and <c>add_one</c> in terms of <c>map</c> as follows:</p> - <code type="none"> - -double(L) -> map(fun(X) -> 2*X end, L). -add_one(L) -> map(fun(X) -> 1 + X end, L). </code> - <p><c>map(F, List)</c> is a function which takes a function <c>F</c> and a list <c>L</c> as arguments and - returns the new list which is obtained by applying <c>F</c> to each of the elements in <c>L</c>.</p> - <p>The process of abstracting out the common features of a number of different programs is called procedural abstraction. Procedural abstraction can be used in order to write several different functions which have a similar structure, but differ only in some minor detail. This is done as follows:</p> - <list type="ordered"> - <item>write one function which represents the common features of these functions</item> - <item>parameterize the difference in terms of functions which are passed as arguments to the common function.</item> - </list> - </section> - - <section> - <title>Example 2 - foreach</title> - <p>This example illustrates procedural abstraction. Initially, we show the following two examples written as conventional functions:</p> - <list type="ordered"> - <item>all elements of a list are printed onto a stream</item> - <item>a message is broadcast to a list of processes.</item> - </list> - <code type="none"> - -print_list(Stream, [H|T]) -> - io:format(Stream, "~p~n", [H]), - print_list(Stream, T); -print_on_list(Stream, []) -> - true. </code> - <code type="none"> - -broadcast(Msg, [Pid|Pids]) -> - Pid ! Msg, - broadcast(Msg, Pids); -broadcast(_, []) -> - true. </code> - <p>Both these functions have a very similar structure. They both iterate over a list doing something to each element in the list. The "something" has to be carried round as an extra argument to the function which does this.</p> - <p>The function <c>foreach</c> expresses this similarity:</p> - <codeinclude file="funs1.erl" tag="%2" type="erl"></codeinclude> - <p>Using <c>foreach</c>, <c>print_on_list</c> becomes:</p> - <code type="none"> - -foreach(fun(H) -> io:format(S, "~p~n~,[H]) end, L) </code> - <p><c>broadcast</c> becomes:</p> - <code type="none"> - -foreach(fun(Pid) -> Pid ! M end, L) </code> - <p><c>foreach</c> is evaluated for its side-effect and not its value. <c>foreach(Fun ,L)</c> calls <c>Fun(X)</c> for each element <c>X</c> in <c>L</c> and the processing occurs in the order in which the elements were defined in <c>L</c>. <c>map</c> does not define the order in which its elements are processed.</p> - </section> - </section> - - <section> - <title>Advantages of Higher Order Functions</title> - <p>Programming with higher order functions, such as <c>map</c> and <c>foreach</c>, has a number of advantages:</p> - <list type="bulleted"> - <item>It is much easier to understand the program and the intention of the programmer is clearly expressed in the code. The statement <c>foreach(fun(X) -></c> clearly indicates that the intention of this program is to do something to each element in the list <c>L</c>. We also know that the function which is passed as the first argument of <c>foreach</c> takes one argument <c>X</c>, which will be successively bound to each of the elements in <c>L</c>.</item> - <item>Functions which take Funs as arguments are much easier to re-use than other functions. </item> - </list> - </section> - - <section> - <title>The Syntax of Funs</title> - <p>Funs are written with the syntax:</p> - <code type="none"> - -F = fun (Arg1, Arg2, ... ArgN) -> - ... - end </code> - <p>This creates an anonymous function of <c>N</c> arguments and binds it to the variable <c>F</c>.</p> - <p>If we have already written a function in the same module and wish to pass this function as an argument, we can use the following syntax:</p> - <code type="none"> - -F = fun FunctionName/Arity </code> - <p>With this form of function reference, the function which is referred to does not need to be exported from the module.</p> - <p>We can also refer to a function defined in a different module with the following syntax:</p> - <code type="none"> - -F = {Module, FunctionName} </code> - <p>In this case, the function must be exported from the module in question.</p> - <p>The follow program illustrates the different ways of creating Funs:</p> - <codeinclude file="fun_test.erl" tag="%1" type="erl"></codeinclude> - <p>We can evaluate the fun <c>F</c> with the syntax:</p> - <code type="none"> - -F(Arg1, Arg2, ..., Argn) </code> - <p>To check whether a term is a Fun, use the test <c>function/1</c> - in a guard. Example:</p> - <code type="none"> -f(F, Args) when function(F) -> - apply(F, Args); -f(N, _) when integer(N) -> - N. </code> - <p>Funs are a distinct type. The BIFs erlang:fun_info/1,2 can - be used to retrieve information about a fun, and the BIF - erlang:fun_to_list/1 returns a textual representation of a fun. - The check_process_code/2 BIF returns true if the - process contains funs that depend on the old version of - a module.</p> - <note> - <p>In OTP R5 and earlier releases, funs were represented - using tuples.</p> - </note> - </section> - - <section> - <title>Variable Bindings within a Fun</title> - <p>The scope rules for variables which occur in Funs are as follows:</p> - <list type="bulleted"> - <item>All variables which occur in the head of a Fun are assumed to be "fresh" variables.</item> - <item>Variables which are defined before the Fun, and which occur in function calls or guard tests within the Fun, have the values they had outside the Fun.</item> - <item>No variables may be exported from a Fun.</item> - </list> - <p>The following examples illustrate these rules:</p> - <code type="none"> - -print_list(File, List) -> - {ok, Stream} = file:open(File, write), - foreach(fun(X) -> io:format(Stream,"~p~n",[X]) end, List), - file:close(Stream). </code> - <p>In the above example, the variable <c>X</c> which is defined in the head of the Fun is a new variable. The value of the variable <c>Stream</c> which is used within within the Fun gets its value from the - <c>file:open</c> line.</p> - <p>Since any variable which occurs in the head of a Fun is considered a new variable it would be equally valid to write:</p> - <code type="none"> - -print_list(File, List) -> - {ok, Stream} = file:open(File, write), - foreach(fun(File) -> - io:format(Stream,"~p~n",[File]) - end, List), - file:close(Stream). </code> - <p>In this example, <c>File</c> is used as the new variable instead of <c>X</c>. This is rather silly since code in the body of the Fun cannot refer to the variable <c>File</c> which is defined outside the Fun. Compiling this example will yield the diagnostic:</p> - <code type="none"> - -./FileName.erl:Line: Warning: variable 'File' - shadowed in 'lambda head' </code> - <p>This reminds us that the variable <c>File</c> which is defined inside the Fun collides with the variable <c>File</c> which is defined outside the Fun.</p> - <p>The rules for importing variables into a Fun has the consequence that certain pattern matching operations have to be moved into guard expressions and cannot be written in the head of the Fun. For example, we might write the following code if we intend the first clause of <c>F</c> to be evaluated when the value of its argument is <c>Y</c>:</p> - <code type="none"> - -f(...) -> - Y = ... - map(fun(X) when X == Y -> - ; - (_) -> - ... - end, ...) - ... </code> - <p>instead of</p> - <code type="none"> - -f(...) -> - Y = ... - map(fun(Y) -> - ; - (_) -> - ... - end, ...) - ... </code> - </section> - - <section> - <title>Funs and the Module Lists</title> - <p>The following examples show a dialogue with the Erlang shell. All the higher order functions discussed are exported from the module <c>lists</c>.</p> - - <section> - <title>map</title> - <codeinclude file="funs1.erl" tag="%1" type="erl"></codeinclude> - <p><c>map</c> takes a function of one argument and a list of terms. It returns the list obtained by applying the function to every argument in the list.</p> - <pre> - -1> <input>Double = fun(X) -> 2 * X end.</input> -#Fun<erl_eval> -2><input>lists:map(Double, [1,2,3,4,5]).</input> -[2,4,6,8,10] </pre> - <p>When a new Fun is defined in the shell, the value of the Fun is printed as <c><![CDATA[Fun#<erl_eval>]]></c></p> - </section> - - <section> - <title>any</title> - <codeinclude file="funs1.erl" tag="%4" type="erl"></codeinclude> - <p><c>any</c> takes a predicate <c>P</c> of one argument and a list of terms. A predicate is a function which returns <c>true</c> or <c>false</c>. <c>any</c> is true if there is a term <c>X</c> in the list such that <c>P(X)</c> is <c>true</c>.</p> - <p>We define a predicate <c>Big(X)</c> which is <c>true</c> if its argument is greater that 10.</p> - <pre> - -3> <input>Big = fun(X) -> if X > 10 -> true; true -> false end end.</input> -#Fun<erl_eval> -4><input>lists:any(Big, [1,2,3,4]).</input> -false. -5> <input>lists:any(Big, [1,2,3,12,5]).</input> -true. </pre> - </section> - - <section> - <title>all</title> - <codeinclude file="funs1.erl" tag="%3" type="erl"></codeinclude> - <p><c>all</c> has the same arguments as <c>any</c>. It is true if the predicate applied to all elements in the list is true.</p> - <pre> - -6><input>lists:all(Big, [1,2,3,4,12,6]).</input> -false -7><input>lists:all(Big, [12,13,14,15]).</input> -true </pre> - </section> - - <section> - <title>foreach</title> - <codeinclude file="funs1.erl" tag="%2" type="erl"></codeinclude> - <p><c>foreach</c> takes a function of one argument and a list of terms. The function is applied to each argument in the list. <c>foreach</c> returns <c>ok</c>. It is used for its side-effect only.</p> - <pre> - -8> <input>lists:foreach(fun(X) -> io:format("~w~n",[X]) end, [1,2,3,4]).</input> -1 -2 -3 -4 -true </pre> - </section> - - <section> - <title>foldl</title> - <codeinclude file="funs1.erl" tag="%8" type="erl"></codeinclude> - <p><c>foldl</c> takes a function of two arguments, an accumulator and a list. The function is called with two arguments. The first argument is the successive elements in the list, the second argument is the accumulator. The function must return a new accumulator which is used the next time the function is called.</p> - <p>If we have a list of lists <c>L = ["I","like","Erlang"]</c>, then we can sum the lengths of all the strings in <c>L</c> as follows:</p> - <pre> - -9> <input>L = ["I","like","Erlang"].</input> -["I","like","Erlang"] -10> <input>lists:foldl(fun(X, Sum) -> length(X) + Sum end, 0, L).</input> -11 </pre> - <p><c>foldl</c> works like a <c>while</c> loop in an imperative language:</p> - <code type="none"> - - L = ["I","like","Erlang"], - Sum = 0, - while( L != []){ - Sum += length(head(L)), - L = tail(L) - end </code> - </section> - - <section> - <title>mapfoldl</title> - <codeinclude file="funs1.erl" tag="%10" type="erl"></codeinclude> - <p><c>mapfoldl</c> simultaneously maps and folds over a list. The following example shows how to change all letters in <c>L</c> to upper case and count them.</p> - <p>First upcase:</p> - <pre> - -11> <input>Upcase = fun(X) when $a =< X, X =< $z -> X + $A - $a;</input> -<input>(X) -> X</input> -<input>end.</input> -#Fun<erl_eval> -12> <input>Upcase_word =</input> -<input>fun(X) -></input> -<input>lists:map(Upcase, X)</input> -<input>end.</input> -#Fun<erl_eval> -13><input>Upcase_word("Erlang").</input> -"ERLANG" -14><input>lists:map(Upcase_word, L).</input> -["I","LIKE","ERLANG"] </pre> - <p>Now we can do the fold and the map at the same time:</p> - <pre> - -14> <input>lists:mapfoldl(fun(Word, Sum) -></input> -14> <input>{Upcase_word(Word), Sum + length(Word)}</input> -14> <input>end, 0, L).</input> -{["I","LIKE","ERLANG"],11} </pre> - </section> - - <section> - <title>filter</title> - <codeinclude file="funs1.erl" tag="%9" type="erl"></codeinclude> - <p><c>filter</c> takes a predicate of one argument and a list and returns all element in the list which satisfy the predicate.</p> - <pre> - -15><input>lists:filter(Big, [500,12,2,45,6,7]).</input> -[500,12,45] </pre> - <p>When we combine maps and filters we can write very succinct and obviously correct code. For example, suppose we want to define a set difference function. We want to define <c>diff(L1, L2)</c> to be the difference between the lists <c>L1</c> and <c>L2</c>. - This is the list of all elements in L1 which are not contained in L2. This code can be written as follows:</p> - <code type="none"> - -diff(L1, L2) -> - filter(fun(X) -> not member(X, L2) end, L1). </code> - <p>The AND intersection of the list <c>L1</c> and <c>L2</c> is also easily defined:</p> - <code type="none"> - -intersection(L1,L2) -> filter(fun(X) -> member(X,L1) end, L2). </code> - </section> - - <section> - <title>takewhile</title> - <codeinclude file="funs1.erl" tag="%5" type="erl"></codeinclude> - <p><c>takewhile(P, L)</c> takes elements <c>X</c> from a list <c>L</c> as long as the predicate <c>P(X)</c> is true.</p> - <pre> - -16><input>lists:takewhile(Big, [200,500,45,5,3,45,6]).</input> -[200,500,45] </pre> - </section> - - <section> - <title>dropwhile</title> - <codeinclude file="funs1.erl" tag="%6" type="erl"></codeinclude> - <p><c>dropwhile</c> is the complement of <c>takewhile</c>.</p> - <pre> - -17> <input>lists:dropwhile(Big, [200,500,45,5,3,45,6]).</input> -[5,3,45,6] </pre> - </section> - - <section> - <title>splitlist</title> - <codeinclude file="funs1.erl" tag="%7" type="erl"></codeinclude> - <p><c>splitlist(P, L)</c> splits the list <c>L</c> into the two sub-lists <c>{L1, L2}</c>, where <c>L = takewhile(P, L)</c> and <c>L2 = dropwhile(P, L)</c>.</p> - <pre> - -18><input>lists:splitlist(Big, [200,500,45,5,3,45,6]).</input> -{[200,500,45],[5,3,45,6]} </pre> - </section> - - <section> - <title>first</title> - <codeinclude file="funs1.erl" tag="%11" type="erl"></codeinclude> - <p><c>first</c> returns <c>{true, R}</c>, where <c>R</c> is the first element in a list satisfying a predicate or <c>false</c>:</p> - <pre> - -19><input>lists:first(Big, [1,2,45,6,123]).</input> -{true,45} -20><input>lists:first(Big, [1,2,4,5]). </input> -false </pre> - </section> - </section> - - <section> - <title>Funs which Return Funs</title> - <p>So far, this section has only described functions which take Funs as arguments. It is also possible to write more powerful functions which themselves return Funs. The following examples illustrate these type of functions.</p> - - <section> - <title>Simple Higher Order Functions</title> - <p><c>Adder(X)</c> is a function which, given <c>X</c>, returns a new function <c>G</c> such that <c>G(K)</c> returns <c>K + X</c>.</p> - <pre> - -21> <input>Adder = fun(X) -> fun(Y) -> X + Y end end.</input> -#Fun<erl_eval> -22> <input>Add6 = Adder(6).</input> -#Fun<erl_eval> -23><input>Add6(10).</input> -16 </pre> - </section> - - <section> - <title>Infinite Lists</title> - <p>The idea is to write something like:</p> - <code type="none"> - --module(lazy). --export([ints_from/1]). -ints_from(N) -> - fun() -> - [N|ints_from(N+1)] - end. </code> - <p>Then we can proceed as follows:</p> - <code type="none"><![CDATA[ - -24> XX = lazy:ints_from(1). -#Fun<lazy> -25> XX(). -[1|#Fun<lazy>] -26> hd(XX()). -1 -27> Y = tl(XX()). -#Fun<lazy> -28> hd(Y()). -2 ]]></code> - <p>etc. - this is an example of "lazy embedding"</p> - </section> - - <section> - <title>Parsing</title> - <p>The following examples show parsers of the following type:</p> - <pre> -Parser(Toks) -> {ok, Tree, Toks1} | fail </pre> - <p><c>Toks</c> is the list of tokens to be parsed. A successful parse returns <c>{ok, Tree, Toks1}</c>, where <c>Tree</c> is a parse tree and <c>Toks1</c> is a tail of <c>Tree</c> which contains symbols encountered after the structure which was correctly parsed. Otherwise <c>fail</c> is returned.</p> - <p>The example which follows illustrates a simple, functional parser which parses the grammar:</p> - <pre> -(a | b) & (c | d) </pre> - <p>The following code defines a function <c>pconst(X)</c> in the module <c>funparse</c>, which returns a Fun which parses a list of tokens.</p> - <codeinclude file="funparse.erl" tag="%14" type="erl"></codeinclude> - <p>This function can be used as follows:</p> - <pre> -29><input>P1 = funparse:pconst(a).</input> -#Fun<hof> -30> <input>P1([a,b,c]).</input> -{ok,{const,a},[b,c]} -31> <input>P1([x,y,z]).</input> -fail </pre> - <p>Next, we define the two higher order functions <c>pand</c> and <c>por</c> which combine primitive parsers to produce more complex parsers. Firstly <c>pand</c>:</p> - <codeinclude file="funparse.erl" tag="%16" type="erl"></codeinclude> - <p>Given a parser <c>P1</c> for grammar <c>G1</c>, and a parser <c>P2</c> for grammar <c>G2</c>, <c>pand(P1, P2)</c> - returns a parser for the grammar which consists of sequences of tokens which satisfy <c>G1</c> followed by sequences of tokens which satisfy <c>G2</c>.</p> - <p><c>por(P1, P2)</c> returns a parser for the language described by the grammar <c>G1</c> or <c>G2</c>.</p> - <codeinclude file="funparse.erl" tag="%15" type="erl"></codeinclude> - <p>The original problem was to parse the grammar <c><![CDATA[(a | b) & (c | d)]]></c>. The following code addresses this problem: </p> - <codeinclude file="funparse.erl" tag="%13" type="erl"></codeinclude> - <p>The following code adds a parser interface to the grammar:</p> - <codeinclude file="funparse.erl" tag="%12" type="erl"></codeinclude> - <p>We can test this parser as follows:</p> - <pre> - -32> <input>funparse:parse([a,c]).</input> -{ok,{'and',{'or',1,{const,a}},{'or',1,{const,c}}}} -33> <input>funparse:parse([a,d]).</input> -{ok,{'and',{'or',1,{const,a}},{'or',2,{const,d}}}} -34> <input>funparse:parse([b,c]).</input> -{ok,{'and',{'or',2,{const,b}},{'or',1,{const,c}}}} -35> <input>funparse:parse([b,d]).</input> -{ok,{'and',{'or',2,{const,b}},{'or',2,{const,d}}}} -36> <input>funparse:parse([a,b]).</input> -fail </pre> - </section> - </section> -</chapter> - diff --git a/system/doc/extensions/funs1.erl b/system/doc/extensions/funs1.erl deleted file mode 100644 index b1a3e21525..0000000000 --- a/system/doc/extensions/funs1.erl +++ /dev/null @@ -1,125 +0,0 @@ --module(funs1). --compile(export_all). --import(lists, [reverse/1]). - -%1 -map(F, [H|T]) -> [F(H)|map(F, T)]; -map(F, []) -> []. -%1 - -%2 -foreach(F, [H|T]) -> - F(H), - foreach(F, T); -foreach(F, []) -> - ok. -%2 -% -%3 -all(Pred, [H|T]) -> - case Pred(H) of - true -> all(Pred, T); - false -> false - end; -all(Pred, []) -> - true. -%3 -%4 -any(Pred, [H|T]) -> - case Pred(H) of - true -> true; - false -> any(Pred, T) - end; -any(Pred, []) -> - false. -%4 -%5 -takewhile(Pred, [H|T]) -> - case Pred(H) of - true -> [H|takewhile(Pred, T)]; - false -> [] - end; -takewhile(Pred, []) -> - []. -%5 -%6 -dropwhile(Pred, [H|T]) -> - case Pred(H) of - true -> dropwhile(Pred, T); - false -> [H|T] - end; -dropwhile(Pred, []) -> - []. -%6 -%7 -splitlist(Pred, L) -> - splitlist(Pred, L, []). - -splitlist(Pred, [H|T], L) -> - case Pred(H) of - true -> splitlist(Pred, T, [H|L]); - false -> {reverse(L), [H|T]} - end; -splitlist(Pred, [], L) -> - {reverse(L), []}. -%7 - -flatmap(F, [Hd|Tail]) -> - F(Hd) ++ flatmap(F, Tail); -flatmap(F, []) -> []. - -%8 -foldl(F, Accu, [Hd|Tail]) -> - foldl(F, F(Hd, Accu), Tail); -foldl(F, Accu, []) -> Accu. -%8 -% -foldr(F, Accu, [Hd|Tail]) -> - F(Hd, foldr(F, Accu, Tail)); -foldr(F, Accu, []) -> Accu. -%9 -filter(F, [H|T]) -> - case F(H) of - true -> [H|filter(F, T)]; - false -> filter(F, T) - end; -filter(F, []) -> []. -%9 -%10 -mapfoldl(F, Accu0, [Hd|Tail]) -> - {R,Accu1} = F(Hd, Accu0), - {Rs,Accu2} = mapfoldl(F, Accu1, Tail), - {[R|Rs], Accu2}; -mapfoldl(F, Accu, []) -> {[], Accu}. -%10 -mapfoldr(F, Accu0, [Hd|Tail]) -> - {Rs,Accu1} = mapfoldr(F, Accu0, Tail), - {R,Accu2} = F(Hd, Accu1), - {[R|Rs],Accu2}; -mapfoldr(F, Accu, []) -> {[], Accu}. -%11 -first(Pred, [H|T]) -> - case Pred(H) of - true -> - {true, H}; - false -> - first(Pred, T) - end; -first(Pred, []) -> - false. -%11 -% -compose(F, G) -> - fun(X) -> - F(G(X)) - end. - -%20 -iterate(N, F) -> - iterate(N, N+1, F). - -iterate(Stop, Stop, _) -> - []; -iterate(N, Stop, Fun) -> - [Fun(N)|iterate(N+1, Stop, Fun)]. -%20 diff --git a/system/doc/extensions/include.xml b/system/doc/extensions/include.xml deleted file mode 100644 index cd78644b95..0000000000 --- a/system/doc/extensions/include.xml +++ /dev/null @@ -1,81 +0,0 @@ -<?xml version="1.0" encoding="latin1" ?> -<!DOCTYPE chapter SYSTEM "chapter.dtd"> - -<chapter> - <header> - <copyright> - <year>1999</year><year>2009</year> - <holder>Ericsson AB. All Rights Reserved.</holder> - </copyright> - <legalnotice> - 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 - compliance with the License. You should have received a copy of the - Erlang Public License along with this software. If not, it can be - retrieved online at http://www.erlang.org/. - - Software distributed under the License is distributed on an "AS IS" - basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See - the License for the specific language governing rights and limitations - under the License. - - </legalnotice> - - <title>Includes</title> - <prepared>Arndt Jonasson</prepared> - <docno>1</docno> - <date>99-01-25</date> - <rev>PA1</rev> - <file>include.sgml</file> - </header> - <p>There are two directives which can be used in Erlang source - files to cause the compiler to temporarily read input from another - source. They are typically used to provide macro definitions and - record definitions from header files. It is recommended to use the - file name extension <c>".hrl"</c> for files which are meant to be - included (the 'h' can be read as "header").</p> - <p>When locating header files a list of directory names, the - compiler include path, is used. In short the list contains the current - working directory of the file server, the base name of the compiled - file, and the directories given by the include option, in that order. - See <c>erlc(1)</c> and <c>compile(3)</c> for the details of the - compiler include path.</p> - - <section> - <title>The -include Directive</title> - <p>The first action taken by the <c>-include</c> directive is to - check if the format of the first path component of the specified - filename is <c>$VAR</c>, for some string <c>VAR</c>. If that is the - case, the value of the environment variable <c>VAR</c> as returned by - <c>os:getenv(VAR)</c> is substituted for the first path component. If - <c>os:getenv/1</c> returns <c>false</c>, the first path component is - left as is. If the filename is absolute (possibly after variable - substitution), the header file with that name is included. Otherwise, - the specified header file is searched for in the directories in the - compiler include path, starting with the first directory in the list. - The first file found while traversing the list is included. Examples:</p> - <code type="none"> - -include("my_records.hrl"). - -include("incdir/more_records.hrl"). - -include("/home/users/proj/recs.hrl"). - -include("$PROJ_ROOT/app1/defs.hrl"). </code> - </section> - - <section> - <title>The -include_lib Directive</title> - <p>The <c>-include_lib</c> directive first tries to find the - specified header file using the procedure employed for the - <c>-include</c> directive. If no header file can be found by searching - the compiler include path, the first path component of the specified - filename (possibly after variable substitution) is regarded as the - name of an application, and the directory of the current version of - the application is searched. Example:</p> - <code type="none"> - -include_lib("mnesia/include/mnemosyne.hrl"). </code> - <p>The compiler is instructed to look for the directory where the - current version of the <c>mnesia</c> application is installed, that is - <c>code:lib_dir(mnesia)</c>, and then search the subdirectory - <c>include</c> for the file <c>mnemosyne.hrl</c>.</p> - </section> -</chapter> - diff --git a/system/doc/extensions/list_comprehensions.erl b/system/doc/extensions/list_comprehensions.erl deleted file mode 100644 index 21ac562aa5..0000000000 --- a/system/doc/extensions/list_comprehensions.erl +++ /dev/null @@ -1,118 +0,0 @@ --module(t). --author('[email protected]'). - -%%-export([test/2]). --compile(export_all). - -%% Odd numbers. - -%%foo(L) -> [ X || X <- L, (X > X-1) == (X /= X-1) ]. - -bar(L) -> [ X || X <- L, integer(X), gt(X, 3) ]. - -bar(L, M) -> [ Y || X <- L, integer(X), gt(X, 3), - Y <- M, float(Y), gt(X, Y) - ]. - -baz(L) -> [ X || X <- L, atom(X) ]. - -buz(L, Min) -> [ X || Min > 3, X <- L, X >= Min ]. - -gt(X, Y) when X > Y -> true; -gt(X, Y) -> false. - -%% Turn a list into a set. -make_set([]) -> []; -make_set([H|T]) -> - [H|[ - Y || Y <- make_set(T), - Y =/= H - ]]. - -%% Return the Pythagorean triangles with sides -%% of total length less than N -pyth(N) -> - [ {A,B,C} || - A <- lists:seq(1,N), - B <- lists:seq(1,N), - C <- lists:seq(1,N), - A+B+C =< N, - A*A+B*B == C*C - ]. - -%% Cut the search space a bit.. -pyth2(N) -> - [ {A,B,C} || - A <- lists:seq(1,N), - B <- lists:seq(1,N-A+1), - C <- lists:seq(1,N-A-B+2), - A+B+C =< N, - A*A+B*B == C*C ]. - -%% Return the Cartesian product -cp() -> - [ {X,Y} || - X <- a(), - Y <- b() - ]. - -cp(A,B) when list(A),list(B) -> - [ {X,Y} || - X <- A, - Y <- B - ]. - -%a() -> 1/0. -a() -> [a,b]. -b() -> [1,2,3]. - -%% Return all permutations of a list -perms([]) -> [[]]; -perms(L) -> [ [H|T] || H <- L, T <- perms(L--[H]) ]. - -%% Quick sort -sort([X|Xs]) -> - sort([ Y || Y <- Xs, Y < X ]) ++ - [X] ++ - sort([ Y || Y <- Xs, Y >= X ]); -sort([]) -> []. - -%% Vector addition -vecAdd(Xs,Ys) -> - [ X+Y || {X,Y} <- zip(Xs,Ys) ]. - -zip([X|Xs],[Y|Ys]) -> [{X,Y}|zip(Xs,Ys)]; -zip([],[]) -> []. - -qsort([X|Xs]) -> - qsort(lt(X,Xs)) - ++ [X] ++ - qsort(ge(X,Xs)); -qsort([]) -> []. - -lt(X,[H|T]) when X>H -> [H|lt(X,T)]; -lt(X,[_|T]) -> lt(X,T); -lt(_,[]) -> []. - -ge(X,[H|T]) when X=<H -> [H|ge(X,T)]; -ge(X,[_|T]) -> ge(X,T); -ge(_,[]) -> []. - -test(1,N) -> statistics(runtime),test1(N),statistics(runtime); -test(2,N) -> statistics(runtime),test2(N),statistics(runtime); -test(3,N) -> statistics(runtime),test3(N),statistics(runtime). - -test1(0) -> true; -test1(N) -> - sort([21,12,45,1,3,87,55,77,11,20,6,99,91,13,14,15,66,62,69,71,67,82,83,84,87,86,85]), - test1(N-1). - -test2(0) -> true; -test2(N) -> - qsort([21,12,45,1,3,87,55,77,11,20,6,99,91,13,14,15,66,62,69,71,67,82,83,84,87,86,85]), - test2(N-1). - -test3(0) -> true; -test3(N) -> - lists:sort([21,12,45,1,3,87,55,77,11,20,6,99,91,13,14,15,66,62,69,71,67,82,83,84,87,86,85]), - test3(N-1). diff --git a/system/doc/extensions/list_comprehensions.xml b/system/doc/extensions/list_comprehensions.xml deleted file mode 100644 index 30e32da79c..0000000000 --- a/system/doc/extensions/list_comprehensions.xml +++ /dev/null @@ -1,205 +0,0 @@ -<?xml version="1.0" encoding="latin1" ?> -<!DOCTYPE chapter SYSTEM "chapter.dtd"> - -<chapter> - <header> - <copyright> - <year>1997</year><year>2009</year> - <holder>Ericsson AB. All Rights Reserved.</holder> - </copyright> - <legalnotice> - 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 - compliance with the License. You should have received a copy of the - Erlang Public License along with this software. If not, it can be - retrieved online at http://www.erlang.org/. - - Software distributed under the License is distributed on an "AS IS" - basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See - the License for the specific language governing rights and limitations - under the License. - - </legalnotice> - - <title>List Comprehensions</title> - <prepared>Joe Armstrong</prepared> - <responsible>Bjarne Däcker</responsible> - <docno>1</docno> - <approved>Bjarne DäKer</approved> - <checked></checked> - <date>96-09-10</date> - <rev>PA1</rev> - <file>list_comprehensions.sgml</file> - </header> - <p>List comprehensions are a feature of many modern functional programming languages. Subject to certain rules, they provide a succinct notation for generating elements in a list.</p> - <p>List comprehensions are analogous to set comprehensions - in Zermelo-Frankel set theory and are called ZF expressions in - Miranda. They are analogous to the <c>setof</c> and - <c>findall</c> predicates in Prolog.</p> - <p>List comprehensions are written with the following syntax: - </p> - <code type="none"> - -[Expression || Qualifier1, Qualifier2, ...] </code> - <p><c>Expression</c> is an arbitrary expression, and each <c>Qualifier</c> is either a generator or a filter.</p> - <list type="bulleted"> - <item>A <em>generator</em> written as <c><![CDATA[Pattern <- ListExpr]]></c>. <c>ListExpr</c> must be an expression which evaluates to a list of terms.</item> - <item>A <em>filter</em> is either a predicate or a boolean expression. A predicate is a function which returns <c>true</c> or <c>false</c>.</item> - </list> - - <section> - <title>Examples of List Comprehensions</title> - <p>We start with a simple example:</p> - <code type="none"><![CDATA[ - -> [X || X <- [1,2,a,3,4,b,5,6], X > 3]. -[a,4,b,5,6] ]]></code> - <p>This should be read as follows:</p> - <quote> - <p>The list of X such that X is taken from the list <c>[1,2,a,...]</c> and X is greater than 3.</p> - </quote> - <p>The notation <c><![CDATA[X <- [1,2,a,...]]]></c> is a generator and the expression <c>X > 3</c> is a filter.</p> - <p>An additional filter can be added in order to restrict the result to integers:</p> - <code type="none"><![CDATA[ - -> [X || X <- [1,2,a,3,4,b,5,6], integer(X), X > 3]. -[4,5,6] ]]></code> - <p>Generators can be combined. For example, the Cartesian product of two lists can be written as follows:</p> - <code type="none"><![CDATA[ - -> [{X, Y} || X <- [1,2,3], Y <- [a,b]]. -[{1,a},{1,b},{2,a},{2,b},{3,a},{3,b}] ]]></code> - - <section> - <title>Quick Sort</title> - <p>The well known quick sort routine can be written as follows:</p> - <code type="none"><![CDATA[ - -sort([Pivot|T]) -> - sort([ X || X <- T, X < Pivot]) ++ - [Pivot] ++ - sort([ X || X <- T, X >= Pivot]); -sort([]) -> []. ]]></code> - <p>The expression <c><![CDATA[[X || X <- T, X < Pivot]]]></c> is the list of all elements in <c>T</c>, which are less than <c>Pivot</c>.</p> - <p><c><![CDATA[[X || X <- T, X >= Pivot]]]></c> is the list of all elements in <c>T</c>, which are greater or equal to <c>Pivot</c>.</p> - <p>To sort a list, we isolate the first element in the list and split the list into two sub-lists. The first sub-list contains all elements which are smaller than the first element in the list, the second contains all elements which are greater than or equal to the first element in the list. We then sort the sub-lists and combine the results.</p> - </section> - - <section> - <title>Permutations</title> - <p>The following example generates all permutations of the elements in a list:</p> - <code type="none"><![CDATA[ - -perms([]) -> [[]]; -perms(L) -> [[H|T] || H <- L, T <- perms(L--[H])]. ]]></code> - <p>We take take <c>H</c> from <c>L</c> in all possible ways. The result is the set of all lists <c>[H|T]</c>, where <c>T</c> is the set of all possible permutations of <c>L</c> with <c>H</c> removed.</p> - <code type="none"> - -> perms([b,u,g]). -[[b,u,g],[b,g,u],[u,b,g],[u,g,b],[g,b,u],[g,u,b]] </code> - </section> - - <section> - <title>Pythagorean Triplets</title> - <p>Pythagorean triplets are sets of integers <c>{A,B,C}</c> such that <c>A**2 + B**2 = C**2</c>.</p> - <p>The function <c>pyth(N)</c> generates a list of all integers <c>{A,B,C}</c> such that <c>A**2 + B**2 = C**2</c> and where the sum of the sides is less than <c>N</c>.</p> - <code type="none"><![CDATA[ - -pyth(N) -> - [ {A,B,C} || - A <- lists:seq(1,N), - B <- lists:seq(1,N), - C <- lists:seq(1,N), - A+B+C =< N, - A*A+B*B == C*C - ]. ]]></code> - <pre> - -> <input>pyth(3).</input> -[]. -> <input>pyth(11).</input> -[]. -><input>pyth(12).</input> -[{3,4,5},{4,3,5}] -> <input>pyth(50).</input> -[{3,4,5}, - {4,3,5}, - {5,12,13}, - {6,8,10}, - {8,6,10}, - {8,15,17}, - {9,12,15}, - {12,5,13}, - {12,9,15}, - {12,16,20}, - {15,8,17}, - {16,12,20}]</pre> - <p>The following code reduces the search space and is more efficient:</p> - <code type="none"><![CDATA[ - -pyth1(N) -> - [{A,B,C} || - A <- lists:seq(1,N), - B <- lists:seq(1,N-A+1), - C <- lists:seq(1,N-A-B+2), - A+B+C =< N, - A*A+B*B == C*C ]. ]]></code> - </section> - - <section> - <title>Simplifications with List Comprehensions</title> - <p>As an example, list comprehensions can be used to simplify some of the functions in <c>lists.erl</c>:</p> - <code type="none"><![CDATA[ - -append(L) -> [X || L1 <- L, X <- L1]. -map(Fun, L) -> [Fun(X) || X <- L]. -filter(Pred, L) -> [X || X <- L, Pred(X)]. ]]></code> - </section> - </section> - - <section> - <title>Variable Bindings in List Comprehensions</title> - <p>The scope rules for variables which occur in list comprehensions are as follows:</p> - <list type="bulleted"> - <item>all variables which occur in a generator pattern are assumed to be "fresh" variables</item> - <item>any variables which are defined before the list comprehension and which are used in filters have the values they had before the list comprehension</item> - <item>no variables may be exported from a list comprehension.</item> - </list> - <p>As an example of these rules, suppose we want to write the function <c>select</c>, which selects certain elements from a list of tuples. We might write <c><![CDATA[select(X, L) -> [Y || {X, Y} <- L].]]></c> with the intention of extracting all tuples from <c>L</c> where the first item is <c>X</c>.</p> - <p>Compiling this yields the following diagnostic:</p> - <code type="none"> - -./FileName.erl:Line: Warning: variable 'X' shadowed in generate </code> - <p>This diagnostic warns us that the variable <c>X</c> in the pattern is not the same variable as the variable <c>X</c> which occurs in the function head.</p> - <p>Evaluating <c>select</c> yields the following result:</p> - <pre> - -> <input>select(b,[{a,1},{b,2},{c,3},{b,7}]).</input> -[1,2,3,7] </pre> - <p>This result is not what we wanted. To achieve the desired effect we must write <c>select</c> as follows:</p> - <code type="none"><![CDATA[ - -select(X, L) -> [Y || {X1, Y} <- L, X == X1]. ]]></code> - <p>The generator now contains unbound variables and the test has been moved into the filter. This now works as expected:</p> - <pre> - -> <input>select(b,[{a,1},{b,2},{c,3},{b,7}]).</input> -[2,7] </pre> - <p>One consequence of the rules for importing variables into a list comprehensions is that certain pattern matching operations have to be moved into the filters and cannot be written directly in the generators. To illustrate this, do <em>not</em> write as follows:</p> - <code type="none"><![CDATA[ - -f(...) -> - Y = ... - [ Expression || PatternInvolving Y <- Expr, ...] - ... ]]></code> - <p>Instead, write as follows:</p> - <code type="none"><![CDATA[ - -f(...) -> - Y = ... - [ Expression || PatternInvolving Y1 <- Expr, Y == Y1, ...] - ... - ]]></code> - </section> -</chapter> - diff --git a/system/doc/extensions/list_comrehensions.erl b/system/doc/extensions/list_comrehensions.erl deleted file mode 100644 index f6a23b5dca..0000000000 --- a/system/doc/extensions/list_comrehensions.erl +++ /dev/null @@ -1,75 +0,0 @@ --module(zf). - --compile(export_all). - - -%% Odd numbers. - -%%foo(L) -> [ X || X <- L, (X > X-1) == (X /= X-1) ]. - -boo() -> [X||X <- [1,2,a,3,4,b,5,6], X > 3]. -boo1() -> [X||X <- [1,2,a,3,4,b,5,6], integer(X),X > 3]. -boo2() -> [{X,Y} || X <- [1,2,3], Y <- [a,b]]. - -bar(L) -> [ X || X <- L, integer(X), gt(X, 3) ]. - -bar(L, M) -> [ Y || X <- L, integer(X), gt(X, 3), - Y <- M, float(Y), gt(X, Y) - ]. - -baz(L) -> [ X || X <- L, atom(X) ]. - -buz(L, Min) -> [ X || Min > 3, X <- L, X >= Min ]. - -gt(X, Y) when X > Y -> true; -gt(X, Y) -> false. - - -%% Return the Pythagorean triangles with sides -%% of total length less than N -pyth(N) -> - [ {A,B,C} || - A <- lists:seq(1,N), - B <- lists:seq(1,N), - C <- lists:seq(1,N), - A+B+C =< N, - A*A+B*B == C*C - ]. - -%% Cut the search space a bit.. -pyth2(N) -> - [ {A,B,C} || - A <- lists:seq(1,N), - B <- lists:seq(1,N-A+1), - C <- lists:seq(1,N-A-B+2), - A+B+C =< N, - A*A+B*B == C*C ]. - -%% Return the Cartesian product - -cp(A,B) -> - [ {X,Y} || - X <- A, - Y <- B - ]. - -%% Return all permutations of a list -perms([]) -> [[]]; -perms(L) -> [ [H|T] || H <- L, T <- perms(L--[H]) ]. - -%% Quick sort -sort([X|Xs]) -> - sort([ Y || Y <- Xs, Y < X ]) ++ - [X] ++ - sort([ Y || Y <- Xs, Y >= X ]); -sort([]) -> []. - -%% append - -append(L) -> [X||L1<-L,X<-L1]. - -map(Fun, L) -> [Fun(X)||X<-L]. - -filter(Pred, L) -> [X||X<-L,Pred(X)]. - -select(X, L) -> [Y || {X1,Y} <- L, X == X1]. diff --git a/system/doc/extensions/macros.xml b/system/doc/extensions/macros.xml deleted file mode 100644 index feb3de6102..0000000000 --- a/system/doc/extensions/macros.xml +++ /dev/null @@ -1,177 +0,0 @@ -<?xml version="1.0" encoding="latin1" ?> -<!DOCTYPE chapter SYSTEM "chapter.dtd"> - -<chapter> - <header> - <copyright> - <year>1997</year><year>2009</year> - <holder>Ericsson AB. All Rights Reserved.</holder> - </copyright> - <legalnotice> - 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 - compliance with the License. You should have received a copy of the - Erlang Public License along with this software. If not, it can be - retrieved online at http://www.erlang.org/. - - Software distributed under the License is distributed on an "AS IS" - basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See - the License for the specific language governing rights and limitations - under the License. - - </legalnotice> - - <title>Macros</title> - <prepared>Joe Armstrong</prepared> - <responsible>Bjarne Däcker</responsible> - <docno>1</docno> - <approved>Bjarne DäKer</approved> - <checked></checked> - <date>96-09-10</date> - <rev>PA1</rev> - <file>macros.sgml</file> - </header> - <p>Macros in Erlang are written with the following syntax:</p> - <code type="none"> - --define(Const, Replacement). --define(Fun(Var1, Var2,.., Var), Replacement). </code> - <p>Macros are expanded when the syntax <c>?MacroName</c> is encountered.</p> - <p>Consider the macro definition:</p> - <code type="none"> - --define(timeout, 200). </code> - <p>The expression <c>?timeout</c>, which can occur anywhere in the code which follows the macro definition, will be replaced by <c>200</c>.</p> - <p>Macros with arguments are written as follows:</p> - <code type="none"> - - -define(macro1(X, Y), {a, X, b, Y}). </code> - <p>This type of macro can be used as follows:</p> - <code type="none"> - -bar(X) -> - ?macro1(a, b), - ?macro1(X, 123) </code> - <p>This expands to:</p> - <code type="none"> - -bar(X) -> - {a,a,b,b}, - {a,X,b,123}. </code> - - <section> - <title>Macros and Tokens</title> - <p>Macro expansion works at a token level. We might define a macro as follows:</p> - <code type="none"> - --define(macro2(X, Y), {a,X,b,Y). </code> - <p>The replacement value of the macro is not a valid Erlang term because the closing right curly bracket is missing. <c>macro2</c> expands into a sequence of tokens <c>{</c>, <c>a</c>, <c>X</c> which are then pasted into the place where the macro is used.</p> - <p>We might use this macro as follows:</p> - <code type="none"> - -bar() -> - ?macro2(x,y)}. </code> - <p>This will expand into the valid sequence of tokens <c>{a,x,y,b}</c> before being parsed and compiled.</p> - <note> - <p>It is good programming practise to ensure that the replacement text of a macro is a valid Erlang syntactic form.</p> - </note> - </section> - - <section> - <title>Pre-Defined Macros</title> - <p>The following macros are pre-defined:</p> - <taglist> - <tag><c>?MODULE</c>. </tag> - <item>This macro returns the name of the current module. - </item> - <tag><c>?MODULE_STRING</c>. </tag> - <item>This macro returns the name of the current module, as a string.</item> - <tag><c>?FILE</c>.</tag> - <item>This macro returns the current file name.</item> - <tag><c>?LINE</c>.</tag> - <item>This macro returns the current line number.</item> - <tag><c>?MACHINE</c>.</tag> - <item>This macro returns the current machine name, - <c>'BEAM'</c>,</item> - </taglist> - </section> - - <section> - <title>Stringifying Macro Arguments</title> - <p>The construction <c>??Arg</c> for an argument to a macro expands to a - string containing the tokens of the argument, similar to the - <c>#arg</c> stringifying construction in C. This was added in Erlang - 5.0 (OTP R7A).</p> - <p>Example:</p> - <code type="none"> --define(TESTCALL(Call), io:format("Call ~s: ~w~n", [??Call, Call])). - -?TESTCALL(myfunction(1,2)), -?TESTCALL(you:function(2,1)).</code> - <p>results in</p> - <code type="none"> -io:format("Call ~s: ~w~n",["myfunction ( 1 , 2 )",m:myfunction(1,2)]), -io:format("Call ~s: ~w~n",["you : function ( 2 , 1 )",you:function(2,1)]).</code> - </section> - - <section> - <title>Flow Control in Macros</title> - <p>The following macro directives are supplied:</p> - <taglist> - <tag>-undef(Macro).</tag> - <item>Causes the macro to behave as if it had never been defined.</item> - <tag>-ifdef(Macro).</tag> - <item>Do the following lines if <c>Macro</c> is defined.</item> - <tag>-ifndef(Macro).</tag> - <item>Do the following lines if <c>Macro</c> is not defined.</item> - <tag>-else.</tag> - <item>"else" macro</item> - <tag>-endif.</tag> - <item>"endif" macro.</item> - </taglist> - <p>The conditional macros must be properly nested. They are usually grouped as follows:</p> - <code type="none"> - --ifdef(debug) --define(....) --else --define(...) --endif </code> - <p>The following example illustrates this grouping:</p> - <code type="none"> - --define(debug, true). --ifdef(debug). --define(trace(Str, X), io:format("Mod:~w line:~w ~p ~p~n", - [?MODULE,?LINE, Str, X])). --else. --define(trace(X, Y), true). --endif. </code> - <p>Given these definitions, the expression <c>?trace("X=", X).</c> in line 10 of the module <c>foo</c> expands to:</p> - <code type="none"> - -io:format("Mod:~w line:~w ~p ~p~n",[foo,100,"X=",[X]]), </code> - <p>If we remove the <c>-define(debug, true).</c> line, then the same expression expands to <c>true</c>.</p> - </section> - - <section> - <title>A Macro Expansion Utility</title> - <p>The following code can be used to expand a macro and display the result:</p> - <code type="none"> - --module(mexpand). --export([file/1]). --import(lists, [foreach/2]). -file(File) -> - case epp:parse_file(File ++ ".erl", [],[]) of - {ok, L} -> - {ok, Stream} = file:open(File ++ ".out", write), - foreach(fun(X) -> - io:format(Stream,"~s~n",[erl_pp:form(X)]) - end, L), - file:close(Stream) - end.</code> - <p>Alternatively, we can compile the file with the <c>'P'</c> option. <c>compile:file(File, ['P'])</c> produces a list file <c>File.P</c>, in which the result of any macro expansions can be seen.</p> - </section> -</chapter> - diff --git a/system/doc/extensions/make.dep b/system/doc/extensions/make.dep deleted file mode 100644 index fdac959667..0000000000 --- a/system/doc/extensions/make.dep +++ /dev/null @@ -1,21 +0,0 @@ -# ---------------------------------------------------- -# >>>> Do not edit this file <<<< -# This file was automaticly generated by -# /home/otp/bin/docdepend -# ---------------------------------------------------- - - -# ---------------------------------------------------- -# TeX files that the DVI file depend on -# ---------------------------------------------------- - -book.dvi: bit_syntax.tex book.tex funs.tex include.tex \ - list_comprehensions.tex macros.tex misc.tex \ - part.tex records.tex - -# ---------------------------------------------------- -# Source inlined when transforming from source to LaTeX -# ---------------------------------------------------- - -funs.tex: fun_test.erl funparse.erl funs1.erl - diff --git a/system/doc/extensions/mexpand.erl b/system/doc/extensions/mexpand.erl deleted file mode 100644 index 261f99da46..0000000000 --- a/system/doc/extensions/mexpand.erl +++ /dev/null @@ -1,16 +0,0 @@ --module(mexpand). - --export([file/1]). - --import(lists, [foreach/2]). - -file(File) -> - case epp:parse_file(File ++ ".erl", [],[]) of - {ok, L} -> - {ok, Stream} = file:open(File ++ ".out", write), - foreach(fun(X) -> - io:format(Stream,"~s~n", - [erl_pp:form(X)]) - end, L), - file:close(Stream) - end. diff --git a/system/doc/extensions/misc.xml b/system/doc/extensions/misc.xml deleted file mode 100644 index 576f705278..0000000000 --- a/system/doc/extensions/misc.xml +++ /dev/null @@ -1,310 +0,0 @@ -<?xml version="1.0" encoding="latin1" ?> -<!DOCTYPE chapter SYSTEM "chapter.dtd"> - -<chapter> - <header> - <copyright> - <year>1999</year><year>2009</year> - <holder>Ericsson AB. All Rights Reserved.</holder> - </copyright> - <legalnotice> - 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 - compliance with the License. You should have received a copy of the - Erlang Public License along with this software. If not, it can be - retrieved online at http://www.erlang.org/. - - Software distributed under the License is distributed on an "AS IS" - basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See - the License for the specific language governing rights and limitations - under the License. - - </legalnotice> - - <title>Miscellaneous</title> - <prepared>Arndt Jonasson</prepared> - <docno>1</docno> - <date>99-01-25</date> - <rev>PA1</rev> - <file>misc.sgml</file> - </header> - <p>In this chapter, a number of miscellaneous features of Erlang - are described.</p> - - <section> - <title>Token Syntax</title> - <p>In Erlang 4.8 (OTP R5A) the syntax of Erlang tokens have been - extended to allow the use of the full ISO-8859-1 (Latin-1) character - set. This is noticeable in the following ways:</p> - <list type="bulleted"> - <item>All the Latin-1 printable characters can be used and are shown without - the escape backslash convention.</item> - <item>Atoms and variables can use all Latin-1 letters.</item> - </list> - <p>The new characters from Latin-1 have the following - classifications in Erlang:</p> - <table> - <row> - <cell align="left" valign="middle"><em>Octal</em></cell> - <cell align="left" valign="middle"><em>Decimal</em></cell> - <cell align="left" valign="middle"> </cell> - <cell align="left" valign="middle"><em>Class</em></cell> - </row> - <row> - <cell align="left" valign="middle">200 - 237</cell> - <cell align="left" valign="middle">128 - 159</cell> - <cell align="left" valign="middle"> </cell> - <cell align="left" valign="middle">Control characters</cell> - </row> - <row> - <cell align="left" valign="middle">240 - 277</cell> - <cell align="left" valign="middle">160 - 191</cell> - <cell align="right" valign="middle">- ¿</cell> - <cell align="left" valign="middle">Punctuation characters</cell> - </row> - <row> - <cell align="left" valign="middle">300 - 326</cell> - <cell align="left" valign="middle">192 - 214</cell> - <cell align="center" valign="middle">À - Ö</cell> - <cell align="left" valign="middle">Uppercase letters</cell> - </row> - <row> - <cell align="center" valign="middle">327</cell> - <cell align="center" valign="middle">215</cell> - <cell align="center" valign="middle">×</cell> - <cell align="left" valign="middle">Punctuation character</cell> - </row> - <row> - <cell align="left" valign="middle">330 - 336</cell> - <cell align="left" valign="middle">216 - 222</cell> - <cell align="center" valign="middle">Ø - Þ</cell> - <cell align="left" valign="middle">Uppercase letters</cell> - </row> - <row> - <cell align="left" valign="middle">337 - 366</cell> - <cell align="left" valign="middle">223 - 246</cell> - <cell align="center" valign="middle">ß - ö</cell> - <cell align="left" valign="middle">Lowercase letters</cell> - </row> - <row> - <cell align="center" valign="middle">367</cell> - <cell align="center" valign="middle">247</cell> - <cell align="center" valign="middle">÷</cell> - <cell align="left" valign="middle">Punctuation character</cell> - </row> - <row> - <cell align="left" valign="middle">370 - 377</cell> - <cell align="left" valign="middle">248 - 255</cell> - <cell align="center" valign="middle">ø - ÿ</cell> - <cell align="left" valign="middle">Lowercase letters</cell> - </row> - <tcaption>Character classes</tcaption> - </table> - </section> - - <section> - <title>String Concatenation</title> - <p>Two adjacent string literals are concatenated into one. This is done already - at compile-time, and doesn't incur any runtime overhead. Example:</p> - <code type="none"> - "string" "42" </code> - <p>is equivalent to</p> - <code type="none"> - "string42" </code> - <p>This feature is convenient in at least two situations:</p> - <list type="bulleted"> - <item>when one of the - strings is the result of a macro expansion;</item> - <item>when a string is very - long, and would otherwise either have to wrap, making the source code - harder to read, or force the use of some runtime append operation.</item> - </list> - </section> - - <section> - <title>The ++ list Concatenation Operator</title> - <p>Since list concatenation is a very common operation, it is convenient - to have a terse way of expressing it. The ++ operator appends its second - argument to its first. Example: - </p> - <code type="none"> - X = [1,2,3], - Y = [4,5], - X ++ Y. </code> - <p>results in <c>[1,2,3,4,5]</c>.</p> - <p>The ++ operator has precedence between the binary '+' operator and - the comparison operators. - </p> - </section> - - <section> - <title>The - - list Subtraction Operator</title> - <p>The - - operator produces a list which is a copy of the first - argument, subjected to the following procedure: for each element in - the second argument, its first occurrence in the first argument is - removed.</p> - <code type="none"> - X = [1,2,3,2,1,2], - Y = [2,1,2], - X -- Y. </code> - <p>results in <c>[3,1,2]</c>.</p> - <p>The - - operator has precedence between the binary '+' operator and - the comparison operators. - </p> - </section> - - <section> - <title>Bitwise Operator bnot</title> - <p>Apart from the binary bitwise operators <c>band</c>, <c>bor</c> - and <c>bxor</c>, there is a unary operator <c>bnot</c> with the same - precedence as the other unary operators + and -, i.e., higher than - the binary operators. Example:</p> - <code type="none"> - bnot 7. </code> - <p>returns -8. - </p> - </section> - - <section> - <title>Logical Operators</title> - <p>The atoms <c>true</c> and <c>false</c> are usually used for representing - Boolean values. With the binary operators <c>and</c>, <c>or</c> and - <c>xor</c>, and the unary operator <c>not</c>, Boolean values can be - combined. Example:</p> - <code type="none"> - - M1 = lists:member(A, List1), - M2 = lists:member(A, List2), - M1 and M2.</code> - <p>Note that the operators are strict, i.e., they always evaluate both - their arguments.</p> - <p><c>not</c> has the same priority as the other unary operators. The - binary logical operators have precedence between the <c>=</c> operator - and the comparison operators, the <c>and</c> operator having higher - precedence than <c>or</c> and <c>xor</c>. - </p> - </section> - - <section> - <title>Match Operator = In Patterns</title> - <p>This extension was added in Erlang 4.8 (OTP R5A).</p> - <p>The = operator is also called the `match' operator. The match operator - can now be used in a pattern, so that <c>P1 = P2</c> is a valid pattern, - where both <c>P1</c> and <c>P2</c> are patterns. This compound pattern - when matched against a term causes the term to be matched against both - <c>P1</c> and <c>P2</c>.</p> - <p>One use for this construction is to avoid reconstructing a term which - was part of an argument to a function. Example:</p> - <code type="none"> - f({'+',X,Y}=T) -> {X+Y,T}.</code> - <p>It also makes it possible to rewrite the construction</p> - <code type="none"> - f(X) when X == #rec{x=1, y=a} -> ... </code> - <p>as</p> - <code type="none"> - f(#rec{x=1, y=a} = X) -> ... </code> - <p>In the absence of optimization for the former case, the - latter case is more efficient. - </p> - </section> - - <section> - <title>Literal String Prefix in Patterns</title> - <p>This extension was added in Erlang 4.8 (OTP R5A).</p> - <p>A new construction is allowed in patterns, namely a literal - string as the first operand of the ++ operator. Example:</p> - <code type="none"> - f("prefix" ++ L) -> ... </code> - <p>This is syntactic sugar for the equivalent, but harder to read</p> - <code type="none"> - f([$p,$r,$e,$f,$i,$x | L]) -> ... </code> - </section> - - <section> - <title>Disjunctions in Guards</title> - <p>This extension was added in Erlang 4.9 (OTP R6A).</p> - <p>A new construction is allowed in guards, the disjunction operator - ';'. The construction is syntactic sugar which removes the bother of - writing the same body after several guards.</p> - <code type="none"> - f(X) when xxx ; yyy ; zzz -> - pop(X).</code> - <p>This is syntactic sugar for the equivalent</p> - <code type="none"> - f(X) when xxx -> - pop(X); - f(X) when yyy -> - pop(X); - f(X) when zzz -> - pop(X). </code> - <p>The abstract format has been changed accordingly to contain a list of - (conjunctive) guards where there was previously only one guard. - </p> - </section> - - <section> - <title>Expressions in Patterns</title> - <p>This extension was added in Erlang 5.0 (OTP R7A).</p> - <p>An arithmetic expression can be used within a pattern, if it uses - only numeric or bitwise operators, and if its value can be evaluated - to a constant at compile-time. This is especially useful when the - expression is defined by a macro. - </p> - <p>Example:</p> - <code type="none"> - case X of - {1+2, T} -> T - end.</code> - </section> - - <section> - <title>Boolean expresions in guards</title> - <p>This extension was added in Erlang 5.1 (OTP R8).</p> - <p>In guards, the use of <c>and</c>, <c>or</c> and <c>not</c> is - now allowed. Guard expressions can combine these with - parenthesis. This allows for more elaborate guards than what - may be given with <c>,</c> and <c>;</c>.</p> - <note> - <p>The guard expressions written with these operators are boolean - expressions, and the boolean functions <c>is_list</c>, - <c>is_integer</c> etc. should be used, rather than - <c>list</c>, <c>integer</c> etc.</p> - </note> - <p>Example 1:</p> - <code type="none"> - f(X) when not (is_tuple(X) or is_list(X)) -> - ... </code> - <p>Example 2:</p> - <code type="none"><![CDATA[ - g(A, B) when (A > 0) and (B > 0) and not (A*A < B*B) -> - ... ]]></code> - </section> - - <section> - <title>Short-circuit boolean expressions</title> - <p>This extension was added in Erlang 5.1 (OTP R8).</p> - <p>In a boolean expression it is unnecessary to always evaluate all - terms. If the first term gives a result that determines the - result, the second term is not needed. In Erlang two new - keywords handles boolean expressions without evaluating both - terms, if it's unnecessary. (This is called short-curcuit - boolean evaluation.)</p> - <p>The keyword <c>andalso</c> is a short-curcuit version of - <c>and</c>. The keyword <c>orelse</c> is a short-curcuit version - of <c>or</c>. They can be used in boolean expressions (not - guards) instead of <c>and</c> and <c>or</c>.</p> - <p>Example 1:</p> - <code type="none"> - case A >= -1.0 andalso math:sqrt(A+1) > B of </code> - <p>This will work even if <c>A</c> is less than <c>-1.0</c>, since - in that case, the second term (after <c>andalso</c>) is never - evaluated. (Of course, the same effects could have been done - using guards. In guards, evaluation is always short-circuited, - since guard tests are known to be free of side-effects.)</p> - <p>Example 2:</p> - <code type="none"> - OnlyOne = is_atom(L) orelse - (is_list(L) andalso length(L) == 1), </code> - </section> -</chapter> - diff --git a/system/doc/extensions/part.xml b/system/doc/extensions/part.xml deleted file mode 100644 index 56fd2c09a6..0000000000 --- a/system/doc/extensions/part.xml +++ /dev/null @@ -1,57 +0,0 @@ -<?xml version="1.0" encoding="latin1" ?> -<!DOCTYPE part SYSTEM "part.dtd"> - -<part> - <header> - <copyright> - <year>1997</year> - <year>2007</year> - <holder>Ericsson AB, All Rights Reserved</holder> - </copyright> - <legalnotice> - 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 - compliance with the License. You should have received a copy of the - Erlang Public License along with this software. If not, it can be - retrieved online at http://www.erlang.org/. - - Software distributed under the License is distributed on an "AS IS" - basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See - the License for the specific language governing rights and limitations - under the License. - - The Initial Developer of the Original Code is Ericsson AB. - </legalnotice> - - <title>Erlang Extensions Since 4.4</title> - <prepared>OTP Team</prepared> - <docno></docno> - <date>1997-02-21</date> - <rev>E</rev> - <file>part.sgml</file> - </header> - <description> - <p>This chapter describes extensions made to the Erlang language - since version 4.4 (where nothing is said to the contrary, an extension - was added in version 4.4). - The chapter contains the following sections: - </p> - <list type="bulleted"> - <item>Records</item> - <item>Functional Objects (Funs)</item> - <item>List Comprehensions</item> - <item>Macros</item> - <item>File inclusion</item> - <item>Bit syntax</item> - <item>Miscellaneous</item> - </list> - </description> - <include file="records"></include> - <include file="funs"></include> - <include file="list_comprehensions"></include> - <include file="macros"></include> - <include file="include"></include> - <include file="bit_syntax"></include> - <include file="misc"></include> -</part> - diff --git a/system/doc/extensions/records.xml b/system/doc/extensions/records.xml deleted file mode 100644 index 21ec73ab77..0000000000 --- a/system/doc/extensions/records.xml +++ /dev/null @@ -1,284 +0,0 @@ -<?xml version="1.0" encoding="latin1" ?> -<!DOCTYPE chapter SYSTEM "chapter.dtd"> - -<chapter> - <header> - <copyright> - <year>1997</year> - <year>2007</year> - <holder>Ericsson AB, All Rights Reserved</holder> - </copyright> - <legalnotice> - 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 - compliance with the License. You should have received a copy of the - Erlang Public License along with this software. If not, it can be - retrieved online at http://www.erlang.org/. - - Software distributed under the License is distributed on an "AS IS" - basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See - the License for the specific language governing rights and limitations - under the License. - - The Initial Developer of the Original Code is Ericsson AB. - </legalnotice> - - <title>Records</title> - <prepared>Joe Armstrong</prepared> - <responsible>Bjarne Däcker</responsible> - <docno>1</docno> - <approved>Bjarne DäKer</approved> - <checked></checked> - <date>96-09-10</date> - <rev>PA1</rev> - <file>records.sgml</file> - </header> - <p>A record is a data structure intended for storing a fixed number of related data items. It is - similar to a <c>struct</c> in C, or a <c>record</c> in Pascal. </p> - <p>The main advantage of using records instead of tuples is that fields in a record are accessed by name, whereas fields in a tuple are accessed by position. To illustrate these differences, suppose that we want to represent a person with the <em>tuple</em><c>{Name, Address, Phone}</c>.</p> - <p>We must remember that the <c>Name</c> field is the first element of the tuple, the <c>Address</c> field is the second element, and so on, in order to write functions which manipulate this data. For example, to extract data from a variable <c>P</c> which contains such a tuple we might write the following code and then use pattern matching to extract the relevant fields.</p> - <code type="none"> - -Name = element(1, P), -Address = element(2, P), -... </code> - <p>Code like this is difficult to read and understand and errors occur if we get the numbering of the elements in the tuple wrong. If we change the data representation by re-ordering the fields, or by adding or removing a field, then all references to the person tuple, wherever they occur, must be checked and possibly modified.</p> - <p><em>Records</em> allow us to refer to the fields by name and not position. We use a record instead of a tuple to store the data . If we write a record definition of the type shown below, we can then refer to the fields of the record by name.</p> - <code type="none"> - --record(person, {name, phone, address}). </code> - <p>For example, if <c>P</c> is now a variable whose value is a <c>person</c> record, we can code as follows in order to access the name and address fields of the records.</p> - <code type="none"> - -Name = P#person.name, -Address = P#person.address, -... </code> - <p>In the following sections we describe the different operations which can be performed on records:</p> - - <section> - <title>Defining a Record</title> - <p>A record is defined with the following syntax:</p> - <code type="none"> - --record(RecordName, {Field1 [= DefaultValue1], - Field2 [= DefaultValue2], - ..., - FieldN [= DefaultValueN]}). </code> - <p>The record name and field names must be atoms. The optional default values, which are terms, are used if no value is supplied for a field when a new instance of the record is created. If the default value is not supplied, then the atom <c>undefined</c> is assumed.</p> - <p>For example, in the following record definition, the address field is <c>undefined</c>.</p> - <pre> --record(person, {name = "", phone = [], address}). </pre> - <p>This definition of a person will be used in many of the examples which follow.</p> - </section> - - <section> - <title>Including a Record Definition</title> - <p>If the record is used in several modules, its definition should be placed in a <c>.hrl</c> header file. Each module which uses the record definition should have a <c>-include(FileName).</c> statement. For example:</p> - <code type="none"> - --include("my_data_structures.hrl"). </code> - <note> - <p>The definition of the record must come before it is used.</p> - </note> - </section> - - <section> - <title>Creating a Record</title> - <p>A new record is created with the following syntax:</p> - <code type="none"> - -#RecordName{Field1=Expr1, - ..., - FieldM=ExprM}. </code> - <p>If any of the fields is omitted, then the default value supplied in the record definition is used. For example:</p> - <pre> -> #person{phone = [0,8,2,3,4,3,1,2], name = "Robert"}. -{person, "Robert", [0,8,2,3,4,3,1,2], undefined}. </pre> - <p>There is a new feature introduced in Erlang 5.1 (OTP release - R8), with which you can set a value to all fields in a record, - overriding the defaults in the record specification. The special - field <c>_</c>, means "all fields not explicitly specified".</p> - <pre> -> #person{name = "Jakob", _ = '_'} -{person, "Jakob", '_', '_'} </pre> - <p>It is primarily intended to be used in <c>ets:match/2</c> and - <c>mnesia:match_object/3</c>, to set record fields to the atom - <c>'_'</c>. (This is a wildcard in <c>ets:match/2</c>.)</p> - </section> - - <section> - <title>Selectors</title> - <p>The following syntax is used to select an individual field from a record:</p> - <code type="none"> - -Variable#RecordName.Field </code> - <note> - <p>The values contained in record names and fields must be constants, not variables.</p> - </note> - <note> - <p>For the purposes of illustration, we will demonstrate the use of records using an imaginary dialogue with the Erlang shell. Currently the Erlang evaluator does not support records so you may not be able to reproduce this dialogue.</p> - </note> - <pre> - -> <input>P = #person{name = "Joe", phone = [0,8,2,3,4,3,1,2]}.</input> -{person, "Joe", [0,8,2,3,4,3,1,2], undefined} -> <input>P#person.name.</input> -"Joe" </pre> - <note> - <p>Selectors for records are allowed in guards.</p> - </note> - </section> - - <section> - <title>Updating a Record</title> - <p>The following syntax is used to create a new copy of the record with some of the fields changed. Only the fields to be changed need to be referred to, all other fields retain their old values.</p> - <code type="none"> - -OldVariable#RecordName{Field1 = NewValue1, - ..., - FieldM = NewValueM} </code> - <p>For example:</p> - <pre> -> P1 = #person{name="Joe", phone=[1,2,3], address="A street"}. -{person, "Joe", [1,2,3], "A street"} -> P2 = P1#person{name="Robert"}. -{person, "Robert", [1,2,3], "A street"} </pre> - </section> - - <section> - <title>Type Testing</title> - <p>The following guard test is used to test the type of a record:</p> - <code type="none"> - -record(Variable, RecordName) </code> - <p>The following example shows that the guard succeeds if <c>P</c> is record of type <c>person</c>.</p> - <pre> -foo(P) when record(P, person) -> a_person; -foo(_) -> not_a_person. </pre> - <note> - <p>This test checks that <c>P</c> is a tuple of arity <c>N + 1</c>, where <c>N</c> is the number - of fields in the record, and the first element in the tuple is the atom <c>person</c>.</p> - </note> - </section> - - <section> - <title>Pattern Matching</title> - <p>Matching can be used in combination with records as shown in the following example:</p> - <pre> -> P = #person{name="Joe", phone=[0,0,7], address="A street"}. -{person, "Joe", [0,0,7], "A street"} -> #person{name = Name} = P, Name. -"Joe" </pre> - <p>The following function takes a list of <c>person</c> records and searches for the phone number of a person with a particular name:</p> - <code type="none"> - -find_phone([#person{name=Name, phone=Phone} | _], Name) -> - {found, Phone}; -find_phone([_| T], Name) -> - find_phone(T, Name); -find_phone([], Name) -> - not_found. </code> - <note> - <p>The fields referred to in the pattern can be given in any order.</p> - </note> - </section> - - <section> - <title>Nested Records</title> - <p>The value of a field in a record might be an instance of a record. Retrieval of nested data can be done stepwise, or in a single step, as shown in the following example:</p> - <pre> --record(name, {first = "Robert", last = "Ericsson"}). --record(person, {name = #name{}, phone}). - -demo() -> - P = #person{name= #name{first="Robert",last="Virding"}, phone=123}, - First = (P#person.name)#name.first. </pre> - <note> - <p>In this example, <c>demo()</c> evaluates to <c>"Robert"</c>.</p> - </note> - </section> - - <section> - <title>Internal Representation of Records</title> - <p>It is often desirable to write generic functions which will work on any record, not just a record of a particular type. For this reason, records are represented internally as tuples and the ordering of the fields in the tuple is strictly defined.</p> - <p>For example, the record <c>-record(person, {name, phone, address}).</c> is represented internally by the tuple <c>{person, X, Y, Z}</c>.</p> - <p>The arity of the tuple is one more than the number of fields in the tuple. The first element of the tuple is the name of the record, and the elements of the tuple are the fields in the record. The variables <c>X</c>, <c>Y</c> and <c>Z</c> will store the data contained in the record fields.</p> - <p>The following two functions determine the indices in the tuple which refer to the named fields in the record:</p> - <list type="bulleted"> - <item><c>record_info(fields, Rec) -> [Names]</c>. This function returns the names of the fields in the record <c>Rec</c>. For example, <c>record_info(fields, person)</c> evaluates to <c>[name, address, phone]</c>.</item> - <item><c>record_info(size, Rec) -> Size</c>. This function returns the size of the record <c>Rec</c> when represented as a tuple, which is one more than the number of fields. For example, <c>record_info(size, person)</c> returns <c>4</c>.</item> - </list> - <p>In addition, <c>#Rec.Name</c> returns the index in the tuple representation of <c>Name</c> of the record <c>Rec</c>.</p> - <note> - <p><c>Name</c> must be an atom.</p> - </note> - <p>For example, the following test function <c>test()</c> might return the result shown:</p> - <pre> -test() -> - {record_info(fields, person), - record_info(size, person), - #person.name}. </pre> - <pre> -> <input>Mod:test().</input> -{[name,address,phone],4,2} </pre> - <p>The order in which records map onto tuples is implementation dependent.</p> - <note> - <p><c>record_info</c> is a pseudo-function which cannot be exported from the module where it occurs.</p> - </note> - </section> - - <section> - <title>Example</title> - <pre> -%% File: person.hrl - -%%----------------------------------------------------------- -%% Data Type: person -%% where: -%% name: A string (default is undefined). -%% age: An integer (default is undefined). -%% phone: A list of integers (default is []). -%% dict: A dictionary containing various information -%% about the person. -%% A {Key, Value} list (default is the empty list). -%%------------------------------------------------------------ --record(person, {name, age, phone = [], dict = []}). - </pre> - <pre> --module(person). --include("person.hrl"). --compile(export_all). % For test purposes only. - -%% This creates an instance of a person. -%% Note: The phone number is not supplied so the -%% default value [] will be used. - -make_hacker_without_phone(Name, Age) -> - #person{name = Name, age = Age, - dict = [{computer_knowledge, excellent}, - {drinks, coke}]}. - -%% This demonstrates matching in arguments - -print(#person{name = Name, age = Age, - phone = Phone, dict = Dict}) -> - io:format("Name: ~s, Age: ~w, Phone: ~w ~n" - "Dictionary: ~w.~n", [Name, Age, Phone, Dict]). - -%% Demonstrates type testing, selector, updating. - -birthday(P) when record(P, person) -> - P#person{age = P#person.age + 1}. - -register_two_hackers() -> - Hacker1 = make_hacker_without_phone("Joe", 29), - OldHacker = birthday(Hacker1), - % The central_register_server should have - % an interface function for this. - central_register_server ! {register_person, Hacker1}, - central_register_server ! {register_person, - OldHacker#person{name = "Robert", - phone = [0,8,3,2,4,5,3,1]}}. </pre> - </section> -</chapter> - diff --git a/system/doc/extensions/warning.gif b/system/doc/extensions/warning.gif Binary files differdeleted file mode 100644 index 96af52360e..0000000000 --- a/system/doc/extensions/warning.gif +++ /dev/null diff --git a/system/doc/images/.gitignore b/system/doc/images/.gitignore deleted file mode 100644 index e69de29bb2..0000000000 --- a/system/doc/images/.gitignore +++ /dev/null diff --git a/system/doc/pics/Makefile b/system/doc/pics/Makefile deleted file mode 100644 index fc5996259d..0000000000 --- a/system/doc/pics/Makefile +++ /dev/null @@ -1,58 +0,0 @@ -# -# Copyright (C) 1996,1997 Ericsson Telecommunications -# Author: Lars Thorsen -# -include $(ERL_TOP)/make/target.mk -include $(ERL_TOP)/make/$(TARGET)/otp.mk - -# ---------------------------------------------------- -# Release directory specification -# ---------------------------------------------------- -RELSYSDIR = $(RELEASE_PATH)/doc - -# ---------------------------------------------------- -# Target Specs -# ---------------------------------------------------- -# -# Common macros -# - -GIF_FILES= \ - min_head.gif \ - ps.gif - -# ---------------------------------------------------- -# Target Specs -# ---------------------------------------------------- - -docs: - -pdf: - -ps: - -debug opt: - - - -clean: - @echo "No action" >/dev/null - -# -# Release Targets -# -include $(ERL_TOP)/make/otp_release_targets.mk - -ifeq ($(DOCTYPE),pdf) -release_docs_spec: pdf -else -ifeq ($(DOCTYPE),ps) -release_docs_spec: ps -else -release_docs_spec: docs - $(INSTALL_DIR) $(RELSYSDIR)/pics - $(INSTALL_DATA) $(GIF_FILES) $(RELSYSDIR)/pics -endif -endif - -release_spec: diff --git a/system/doc/pics/app.gif b/system/doc/pics/app.gif Binary files differdeleted file mode 100644 index 345d5795b1..0000000000 --- a/system/doc/pics/app.gif +++ /dev/null diff --git a/system/doc/pics/ede.gif b/system/doc/pics/ede.gif Binary files differdeleted file mode 100644 index 7a51766898..0000000000 --- a/system/doc/pics/ede.gif +++ /dev/null diff --git a/system/doc/pics/ede_logo.gif b/system/doc/pics/ede_logo.gif Binary files differdeleted file mode 100644 index f7c902791b..0000000000 --- a/system/doc/pics/ede_logo.gif +++ /dev/null diff --git a/system/doc/pics/min_head.gif b/system/doc/pics/min_head.gif Binary files differdeleted file mode 100644 index 67948a6378..0000000000 --- a/system/doc/pics/min_head.gif +++ /dev/null diff --git a/system/doc/pics/notes.gif b/system/doc/pics/notes.gif Binary files differdeleted file mode 100644 index e000cca26a..0000000000 --- a/system/doc/pics/notes.gif +++ /dev/null diff --git a/system/doc/pics/otp.gif b/system/doc/pics/otp.gif Binary files differdeleted file mode 100644 index 48c4ca9c02..0000000000 --- a/system/doc/pics/otp.gif +++ /dev/null diff --git a/system/doc/pics/otp_logo.gif b/system/doc/pics/otp_logo.gif Binary files differdeleted file mode 100644 index d1a1f7f72d..0000000000 --- a/system/doc/pics/otp_logo.gif +++ /dev/null diff --git a/system/doc/pics/ps.gif b/system/doc/pics/ps.gif Binary files differdeleted file mode 100644 index 186dfc7e24..0000000000 --- a/system/doc/pics/ps.gif +++ /dev/null diff --git a/system/doc/pics/ref_man.gif b/system/doc/pics/ref_man.gif Binary files differdeleted file mode 100644 index b13c4efd53..0000000000 --- a/system/doc/pics/ref_man.gif +++ /dev/null diff --git a/system/doc/pics/user_guide.gif b/system/doc/pics/user_guide.gif Binary files differdeleted file mode 100644 index e6275a803d..0000000000 --- a/system/doc/pics/user_guide.gif +++ /dev/null diff --git a/system/doc/top/bin/otp_man_index b/system/doc/top/bin/otp_man_index index bb913b25df..57a0f12d32 120000..100755 --- a/system/doc/top/bin/otp_man_index +++ b/system/doc/top/bin/otp_man_index @@ -1 +1,106 @@ -../../../../internal_tools/integration/scripts/otp_man_index
\ No newline at end of file +#!/opt/local/bin/perl + +use File::Find; +use strict; + +######################################### +# Usage: +# $ cd $ERLANG_RELEASE +# otp_man_index > doc/man_index.html +######################################### + +my (@list,$info); + +find(\&wanted,'.'); + +header(); + +foreach $info (sort {lc($a->[0]) cmp lc($b->[0])} @list) { + my ($module,$application,$dir,$path) = @$info; + + my $idx = -f "$dir/index.html" ? "$dir/index.html" : "$dir/../index.html"; + # Remove .html extension from module name, if there is one + if ($module =~ /(\w+).html$/) { + $module = "$1"; + } + print " <TR>\n"; + print " <TD><A HREF=\"../$path\">$module</A></TD>\n"; + print " <TD><A HREF=\"../$idx\">$application</A></TD>\n"; + print " </TR>\n"; +} + +footer(); + +########################################################################### + +sub wanted { + return unless /\.html$/ and -f $_; + + open(FILE,$_) or die "ERROR: Can't open $File::Find::name: $!\n"; + my $line; + + while (defined ($line = <FILE>)) { + if ($line =~ /<!-- refpage -->/) { + close FILE; + my $path = $File::Find::name; + $path =~ s/\.\///; # Remove './' prefix + my $dir = $File::Find::dir; + $dir =~ s/\.\///; # Remove './' prefix + $dir =~ m&([^/]+)/doc/html$&; + my $application = $1; + push(@list, [$_,$application,$dir,$path]); + return; + } + } + close FILE; +} + + +sub header { + print <<EOS; +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<!-- This file was generated by the otp_man_index script --> +<HTML> +<HEAD> + <link rel="stylesheet" href="otp_doc.css" type="text/css"/> + <TITLE>Erlang/OTP Manual Page Index</TITLE> +</HEAD> +<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#FF00FF" + ALINK="#FF0000"> +<CENTER> +<!-- A HREF="http://www.erlang.org/"> +<img alt="Erlang logo" src="erlang-logo.png"/ > +</A><BR --> +<SMALL> +[<A HREF="index.html">Up</A> | +<A HREF="http://www.erlang.org/">Erlang</A>] +</SMALL><BR> +<P><FONT SIZE="+4">Manual Page Index</FONT><BR> +</CENTER> +<CENTER> +<P> +<TABLE BORDER=1> +<TR> + <TH>Manual Page</TH><TH>Application</TH> +</TR> +EOS +} + +sub footer { + my $year = (localtime)[5] + 1900; + print <<EOS; +</TABLE> +</CENTER> +<P> +<CENTER> +<HR> +<SMALL> +Copyright © 1991-$year +<a href="http://www.ericsson.com/technology/opensource/erlang/"> +Ericsson AB</a> +</SMALL> +</CENTER> +</BODY> +</HTML> +EOS +} diff --git a/system/doc/top/src/erl_html_tools.erl b/system/doc/top/src/erl_html_tools.erl index 35a199b08d..d93516768e 120000..100644 --- a/system/doc/top/src/erl_html_tools.erl +++ b/system/doc/top/src/erl_html_tools.erl @@ -1 +1,727 @@ -../../../../internal_tools/integration/scripts/make_index/erl_html_tools.erl
\ No newline at end of file +%% ``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 +%% compliance with the License. You should have received a copy of the +%% Erlang Public License along with this software. If not, it can be +%% retrieved via the world wide web at http://www.erlang.org/. +%% +%% Software distributed under the License is distributed on an "AS IS" +%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +%% the License for the specific language governing rights and limitations +%% under the License. +%% +%% The Initial Developer of the Original Code is Ericsson Utvecklings AB. +%% Portions created by Ericsson are Copyright 1999, Ericsson Utvecklings +%% AB. All Rights Reserved.'' +%% +-module(erl_html_tools). + +%% This file contains tools for updating HTML files in an installed system +%% depending on the installed applications. Currently the only use is +%% to update the top index file. + + +%% ------ VERY IMPORTANT ------ +%% +%% Original location for this file: +%% /clearcase/otp/internal_tools/integration/scripts/make_index/ +%% When updating this file, copy the source to +%% /home/otp/patch/share/program/ +%% and place .beam files (compiled with correct release) in all +%% /home/otp/patch/share/program/<release> +%% for releases >= R9C +%% +%% ---------------------------- + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% +% This program generate the top index files for the OTP documentation. +% Part of the HTML code is in templates, like "index.html.src" and +% part is written out from this module. So the program and the templates +% has to match. +% +% The templates are searched from the current directory, a directory +% "templates" relative to the current directory or at RootDir. +% +% RootDir is given as an argument or assumed to be code:root_dir(), +% i.e. the root of the system running this program. +% +% The output is put into DestDir or RootDir if not given. +% +% The functions to call are +% +% top_index() +% top_index([RootDir]) +% top_index([RootDir,DestDir,OtpRel]) +% top_index(RootDir) +% top_index(RootDir, DestDir, OtpRel) +% +% where RootDir can be a string or an atom. +% +% +% USING THIS SCRIPT FROM THE UNIX COMMAND LINE +% -------------------------------------------- +% If the Erlang started is the same as the Erlang to create index.html +% for the use +% +% % erl -noshell -s erl_html_tools top_index +% +% If you want to create an index for another Erlang installation or +% documentation located separate from the object code, then use +% +% % erl -noshell -s erl_html_tools top_index /path/to/erlang/root +% +% +% COLLECTING INFORMATION +% ---------------------- +% This script assumes that all applications have an "info" file +% in their top directory. This file should have some keywords with +% values defined. The keys are 'group' and 'short' (for "short +% description). See the OTP applications for examples. +% +% Some HTML code is generated by this program, others are taken from +% the file "index.html.src" that may be located in the patch directory +% or in the "$ERLANG_ROOT/doc/" directory. +% +% The code for creating the top index page assumes all applications +% have a file "info" with some fields filled in +% +% short: Text Short text describing the application +% group: tag [Heading] Group tag optionally followed by a description. +% Only one app need to describe the group but +% more than one can. +% +% FIXME: Check that there is documentation for the application, not just +% an info file. +% FIXME: Use records, it is now unreadable :-( +% FIXME: Use a separate URL and URLIndexFile +% FIXME: Pass the OTP release name as an argument instead of in +% process dictionary (for elegance). + +-export([top_index/0,top_index/1,top_index/3,top_index_silent/3]). + +% This is the order groups are inserted into the file. Groups +% not in this list is inserted in undefined order. + +group_order() -> + [ + basic, + dat, + oam, + orb, + comm, + tools + ]. + +top_index() -> + top_index(code:root_dir()). + +top_index([RootDir]) when atom(RootDir) -> + top_index(atom_to_list(RootDir)); +top_index([RootDir,DestDir,OtpRel]) + when is_atom(RootDir), is_atom(DestDir), is_atom(OtpRel) -> + top_index(atom_to_list(RootDir), atom_to_list(DestDir), atom_to_list(OtpRel)); +top_index(RootDir) -> + {_,RelName} = init:script_id(), + top_index(RootDir, filename:join(RootDir, "doc"), RelName). + +top_index(RootDir, DestDir, OtpRel) -> + report("****\nRootDir: ~p", [RootDir]), + report("****\nDestDir: ~p", [DestDir]), + report("****\nOtpRel: ~p", [OtpRel]), + + put(otp_release, OtpRel), + + Templates = find_templates(["","templates",DestDir]), + report("****\nTemplates: ~p", [Templates]), + Bases = [{"../lib/", filename:join(RootDir,"lib")}, + {"../", RootDir}], + Groups = find_information(Bases), + report("****\nGroups: ~p", [Groups]), + process_templates(Templates, DestDir, Groups). + +top_index_silent(RootDir, DestDir, OtpRel) -> + put(silent,true), + Result = top_index(RootDir, DestDir, OtpRel), + erase(silent), + Result. + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% Main loop - process templates +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +process_templates([], _DestDir, _Groups) -> + report("\n", []); +process_templates([Template | Templates], DestDir, Groups) -> + report("****\nIN-FILE: ~s", [Template]), + BaseName = filename:basename(Template, ".src"), + case lists:reverse(filename:rootname(BaseName)) of + "_"++_ -> + %% One template expands to several output files. + process_multi_template(BaseName, Template, DestDir, Groups); + _ -> + %% Standard one-to-one template. + OutFile = filename:join(DestDir, BaseName), + subst_file("", OutFile, Template, Groups) + end, + process_templates(Templates, DestDir, Groups). + + +process_multi_template(BaseName0, Template, DestDir, Info) -> + Ext = filename:extension(BaseName0), + BaseName1 = filename:basename(BaseName0, Ext), + [_|BaseName2] = lists:reverse(BaseName1), + BaseName = lists:reverse(BaseName2), + Groups0 = [{[$_|atom_to_list(G)],G} || G <- group_order()], + Groups = [{"",basic}|Groups0], + process_multi_template_1(Groups, BaseName, Ext, Template, DestDir, Info). + +process_multi_template_1([{Suffix,Group}|Gs], BaseName, Ext, Template, DestDir, Info) -> + OutFile = filename:join(DestDir, BaseName++Suffix++Ext), + subst_file(Group, OutFile, Template, Info), + process_multi_template_1(Gs, BaseName, Ext, Template, DestDir, Info); +process_multi_template_1([], _, _, _, _, _) -> ok. + +subst_file(Group, OutFile, Template, Info) -> + report("\nOUTFILE: ~s", [OutFile]), + case subst_template(Group, Template, Info) of + {ok,Text,_NewInfo} -> + case file:open(OutFile, [write]) of + {ok, Stream} -> + file:write(Stream, Text), + file:close(Stream); + Error -> + error("Can't write to file ~s: ~w", [OutFile,Error]) + end; + Error -> + error("Can't write to file ~s: ~w", [OutFile,Error]) + end. + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% Find the templates +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +find_templates(SearchPaths) -> + find_templates(SearchPaths, SearchPaths). + +find_templates([SearchPath | SearchPaths], AllSearchPaths) -> + case filelib:wildcard(filename:join(SearchPath, "*.html.src")) of + [] -> + find_templates(SearchPaths, AllSearchPaths); + Result -> + Result + end; +find_templates([], AllSearchPaths) -> + error("No templates found in ~p",[AllSearchPaths]). + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% This function read all application names and if present all "info" files. +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +find_information(Bases) -> + Paths = find_application_paths(Bases), +% report("****\nPaths: ~p", [Paths]), + Apps = find_application_infos(Paths), +% report("****\nApps: ~p", [Apps]), + form_groups(Apps). + +% The input is a list of tuples of the form +% +% IN: [{BaseURL,SearchDir}, ...] +% +% and the output is a list +% +% OUT: [{Appname,AppVersion,AppPath,IndexUTL}, ...] +% +% We know URL ends in a slash. + +find_application_paths([]) -> + []; +find_application_paths([{URL,Dir} | Paths]) -> + Sub1 = "doc/html/index.html", +%% Sub2 = "doc/index.html", + case file:list_dir(Dir) of + {ok, Dirs} -> + AppDirs = + lists:filter( + fun(E) -> + is_match(E, "^[A-Za-z0-9_]+-[0-9\\.]+") + end, Dirs), + AppPaths = + lists:map( + fun(AppDir) -> + {ok,[App,Ver]} = regexp:split(AppDir, "-"), + DirPath = filename:join(Dir,AppDir), + AppURL = URL ++ AppDir, + {App,Ver,DirPath,AppURL ++ "/" ++ Sub1} +%% case file:read_file_info( +%% filename:join(DirPath, Sub1)) of +%% {ok, _} -> +%% {App,Ver,DirPath,AppURL ++ "/" ++ Sub1}; +%% _ -> +%% {App,Ver,DirPath,AppURL ++ "/" ++ Sub2} +%% end + end, AppDirs), + AppPaths ++ find_application_paths(Paths) + end. + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% Find info for one application. +% Read the "info" file for each application. Look at "group" and "short". +% key words. +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +% IN: [{Appname,AppVersion,AppPath,IndexUTL}, ...] +% OUT: [{Group,Heading,[{AppName,[{AppVersion,Path,URL,Text} | ...]} +% | ...]}, ...] + +find_application_infos([]) -> + []; +find_application_infos([{App,Ver,AppPath,IndexURL} | Paths]) -> + case read_info(filename:join(AppPath,"info")) of + {error,_Reason} -> + warning("No info for app ~p", [AppPath]), + find_application_infos(Paths); + Db -> + {Group,Heading} = + case lists:keysearch("group", 1, Db) of + {value, {_, G0}} -> + % This value may be in two parts, + % tag and desciption + case string:str(G0," ") of + 0 -> + {list_to_atom(G0),""}; + N -> + {list_to_atom(string:substr(G0,1,N-1)), + string:substr(G0,N+1)} + end; + false -> + error("No group given",[]) + end, + Text = + case lists:keysearch("short", 1, Db) of + {value, {_, G1}} -> + G1; + false -> + "" + end, + [{Group,Heading,{App,{Ver,AppPath,IndexURL,Text}}} + | find_application_infos(Paths)] + end. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% Group into one list element for each group name. +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +% IN : {Group,Heading,{AppName,{AppVersion,Path,URL,Text}}} +% OUT: {Group,Heading,[{AppName,[{AppVersion,Path,URL,Text} | ...]} | ...]} + +form_groups(Apps) -> + group_apps(lists:sort(Apps)). + +group_apps([{Group,Heading,AppInfo} | Info]) -> + group_apps(Info, Group, Heading, [AppInfo]); +group_apps([]) -> + []. + +% First description +group_apps([{Group,"",AppInfo} | Info], Group, Heading, AppInfos) -> + group_apps(Info, Group, Heading, [AppInfo | AppInfos]); +group_apps([{Group,Heading,AppInfo} | Info], Group, "", AppInfos) -> + group_apps(Info, Group, Heading, [AppInfo | AppInfos]); +% Exact match +group_apps([{Group,Heading,AppInfo} | Info], Group, Heading, AppInfos) -> + group_apps(Info, Group, Heading, [AppInfo | AppInfos]); +% Different descriptions +group_apps([{Group,_OtherHeading,AppInfo} | Info], Group, Heading, AppInfos) -> + warning("Group ~w descriptions differ",[Group]), + group_apps(Info, Group, Heading, [AppInfo | AppInfos]); +group_apps(Info, Group, Heading, AppInfos) -> + [{Group,Heading,combine_apps(AppInfos)} | group_apps(Info)]. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% Group into one list element for each application name. +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +% IN : {AppName,{AppVersion,Path,URL,Text}} +% OUT: {AppName,[{AppVersion,Path,URL,Text} | ...]} + +combine_apps(Apps) -> + combine_apps(Apps,[],[]). + +combine_apps([{AppName,{Vsn1,Path1,URL1,Text1}}, + {AppName,{Vsn2,Path2,URL2,Text2}} | Apps], AppAcc, Acc) -> + combine_apps([{AppName,{Vsn2,Path2,URL2,Text2}} | Apps], + [{Vsn1,Path1,URL1,Text1} | AppAcc], + Acc); +combine_apps([{AppName,{Vsn1,Path1,URL1,Text1}}, + {NewAppName,{Vsn2,Path2,URL2,Text2}} | Apps], AppAcc, Acc) -> + App = lists:sort(fun vsncmp/2,[{Vsn1,Path1,URL1,Text1}|AppAcc]), + combine_apps([{NewAppName,{Vsn2,Path2,URL2,Text2}} | Apps], + [], + [{AppName,App}|Acc]); +combine_apps([{AppName,{Vsn,Path,URL,Text}}], AppAcc, Acc) -> + App = lists:sort(fun vsncmp/2,[{Vsn,Path,URL,Text}|AppAcc]), + [{AppName,App}|Acc]. + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% Open a template and fill in the missing parts +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +% IN : {Group,Heading,[{AppName,[{AppVersion,Path,URL,Text} | ...]} | ...]} +% OUT: String that is the HTML code + +subst_template(Group, File, Info) -> + case file:open(File, read) of + {ok,Stream} -> + Res = subst_template_1(Group, Stream, Info), + file:close(Stream), + Res; + {error,Reason} -> + {error, Reason} + end. + +subst_template_1(Group, Stream, Info) -> + case file:read(Stream, 100000) of + {ok, Template} -> + Fun = fun(Match, _) -> {subst(Match, Info, Group),Info} end, + gsub(Template, "#[A-Za-z0-9]+#", Fun, Info); + {error, Reason} -> + {error, Reason} + end. + +get_version(Info) -> + case lists:keysearch('runtime', 1, Info) of + {value, {_,_,Apps}} -> + case lists:keysearch("erts", 1, Apps) of + {value, {_,[{Vers,_,_,_} | _]}} -> + Vers; + _ -> + "" + end; + _ -> + "" + end. + +subst("#release#", _Info, _Group) -> + get(otp_release); +subst("#version#", Info, _Group) -> + get_version(Info); +subst("#copyright#", _Info, _Group) -> + "copyright Copyright © 1991-2004"; +subst("#groups#", Info, _Group) -> + [ + "<table border=0 width=\"90%\" cellspacing=3 cellpadding=5>\n", + subst_groups(Info), + "</table>\n" + ]; +subst("#applinks#", Info, Group) -> + subst_applinks(Info, Group); +subst(KeyWord, Info, _Group) -> + case search_appname(KeyWord -- "##", Info) of + {ok,URL} -> + URL; + _ -> + warning("Can't substitute keyword ~s~n",[KeyWord]), + "" + end. + +search_appname(App, [{_Group,_,Apps} | Groups]) -> + case lists:keysearch(App, 1, Apps) of + {value, {_,[{_Vers,_Path,URL,_Text} | _]}} -> + {ok,lists:sublist(URL, length(URL) - length("/index.html"))}; + _ -> + search_appname(App, Groups) + end; +search_appname(_App, []) -> + {error,noapp}. + +subst_applinks(Info, Group) -> + subst_applinks_1(group_order(), Info, Group). + +subst_applinks_1([G|Gs], Info0, Group) -> + case lists:keysearch(G, 1, Info0) of + {value,{G,Heading,Apps}} -> + Info = lists:keydelete(G, 1, Info0), + ["\n<li>",Heading,"\n<ul>\n", + html_applinks(Apps),"\n</ul></li>\n"| + subst_applinks_1(Gs, Info, Group)]; + false -> + warning("No applications in group ~w\n", [G]), + subst_applinks_1(Gs, Info0, Group) + end; +subst_applinks_1([], [], _) -> []; +subst_applinks_1([], Info, _) -> + error("Info left:\n", [Info]), + []. + +html_applinks([{Name,[{_,_,URL,_}|_]}|AppNames]) -> + ["<li><a href=\"",URL,"\">",Name, + "</a></li>\n"|html_applinks(AppNames)]; +html_applinks([]) -> []. + + +% Info: [{Group,Heading,[{AppName,[{AppVersion,Path,URL,Text} | ..]} | ..]} ..] + +subst_groups(Info0) -> + {Html1,Info1} = subst_known_groups(group_order(), Info0, ""), + {Html2,Info} = subst_unknown_groups(Info1, Html1, []), + Fun = fun({_Group,_GText,Applist}, Acc) -> Applist ++ Acc end, + case lists:foldl(Fun, [], Info) of + [] -> + Html2; + Apps -> + [Html2,group_table("Misc Applications",Apps)] + end. + + +subst_known_groups([], Info, Text) -> + {Text,Info}; +subst_known_groups([Group | Groups], Info0, Text0) -> + case lists:keysearch(Group, 1, Info0) of + {value,{_,Heading,Apps}} -> + Text = group_table(Heading,Apps), + Info = lists:keydelete(Group, 1, Info0), + subst_known_groups(Groups, Info, Text0 ++ Text); + false -> + warning("No applications in group ~w~n",[Group]), + subst_known_groups(Groups, Info0, Text0) + end. + + +subst_unknown_groups([], Text0, Left) -> + {Text0,Left}; +subst_unknown_groups([{Group,"",Apps} | Groups], Text0, Left) -> + warning("No text describes ~w",[Group]), + subst_unknown_groups(Groups, Text0, [{Group,"",Apps} | Left]); +subst_unknown_groups([{_Group,Heading,Apps} | Groups], Text0, Left) -> + Text = group_table(Heading,Apps), + subst_unknown_groups(Groups, Text0 ++ Text, Left). + + +group_table(Heading,Apps) -> + [ + " <tr>\n", + " <td colspan=2 class=header>\n", + " <font size=\"+1\"><b>",Heading,"</b></font>\n", + " </td>\n", + " </tr>\n", + subst_apps(Apps), + " <tr>\n", + " <td colspan=2><font size=1> </font></td>\n", + " </tr>\n" + ]. + +% Count and split the applications in half to get the right sort +% order in the table. + +subst_apps([{App,VersionInfo} | Apps]) -> + [subst_app(App, VersionInfo) | subst_apps(Apps)]; +subst_apps([]) -> + []. + + +subst_app(App, [{VSN,_Path,Link,Text}]) -> + [ + " <tr class=app>\n", + " <td align=left valign=top>\n", + " <table border=0 width=\"100%\" cellspacing=0 cellpadding=0>\n", + " <tr class=app>\n", + " <td align=left valign=top>\n", + " <a href=\"",Link,"\" target=\"_top\">",uc(App),"</a>\n", + " <a href=\"",Link,"\" target=\"_top\">",VSN,"</a>\n", + " </td>\n", + " </tr>\n", + " </table>\n" + " </td>\n", + " <td align=left valign=top>\n", + Text,"\n", + " </td>\n", + " </tr>\n" + ]; +subst_app(App, [{VSN,_Path,Link,Text} | VerInfos]) -> + [ + " <tr class=app>\n", + " <td align=left valign=top>\n", + " <table border=0 width=\"100%\" cellspacing=0 cellpadding=0>\n", + " <tr class=app>\n", + " <td align=left valign=top>\n", + " <a href=\"",Link,"\" target=\"_top\">",uc(App), + "</a> <br>\n", + " <a href=\"",Link,"\" target=\"_top\">",VSN,"</a>\n", + " </td>\n", + " <td align=right valign=top width=50>\n", + " <table border=0 width=40 cellspacing=0 cellpadding=0>\n", + " <tr class=app>\n", + " <td align=left valign=top class=appnums>\n", + subst_vsn(VerInfos), + " </td>\n", + " </tr>\n", + " </table>\n" + " </td>\n", + " </tr>\n", + " </table>\n" + " </td>\n", + " <td align=left valign=top>\n", + Text,"\n", + " </td>\n", + " </tr>\n" + ]. + + +subst_vsn([{VSN,_Path,Link,_Text} | VSNs]) -> + [ + " <font size=\"2\"><a class=anum href=\"",Link,"\" target=\"_top\">", + VSN, + "</a></font><br>\n", + subst_vsn(VSNs) + ]; +subst_vsn([]) -> + "". + + +% Yes, this is very inefficient an is done for every comarision +% in the sort but it doesn't matter in this case. + +vsncmp({Vsn1,_,_,_}, {Vsn2,_,_,_}) -> + L1 = [list_to_integer(N1) || N1 <- string:tokens(Vsn1, ".")], + L2 = [list_to_integer(N2) || N2 <- string:tokens(Vsn2, ".")], + L1 > L2. + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% +% GENERIC FUNCTIONS, NOT SPECIFIC FOR GENERATING INDEX.HTML +% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% Read the "info" file into a list of Key/Value pairs +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +read_info(File) -> + case file:open(File, read) of + {ok,Stream} -> + Res = + case file:read(Stream,10000) of + {ok, Text} -> + Lines = string:tokens(Text, "\n\r"), + KeyValues0 = lines_to_key_value(Lines), + combine_key_value(KeyValues0); + {error, Reason} -> + {error, Reason} + end, + file:close(Stream), + Res; + {error,Reason} -> + {error,Reason} + end. + +combine_key_value([{Key,Value1},{Key,Value2} | KeyValues]) -> + combine_key_value([{Key,Value1 ++ "\n" ++ Value2} | KeyValues]); +combine_key_value([KeyValue | KeyValues]) -> + [KeyValue | combine_key_value(KeyValues)]; +combine_key_value([]) -> + []. + +lines_to_key_value([]) -> + []; +lines_to_key_value([Line | Lines]) -> + case regexp:first_match(Line, "^[a-zA-Z_\\-]+:") of + nomatch -> + case regexp:first_match(Line, "[\041-\377]") of + nomatch -> + lines_to_key_value(Lines); + _ -> + warning("skipping line \"~s\"",[Line]), + lines_to_key_value(Lines) + end; + {match, _, Length} -> + Value0 = lists:sublist(Line, Length+1, length(Line) - Length), + {ok, Value1, _} = regexp:sub(Value0, "^[ \t]*", ""), + {ok, Value, _} = regexp:sub(Value1, "[ \t]*$", ""), + Key = lists:sublist(Line, Length-1), + [{Key,Value} | lines_to_key_value(Lines)] + end. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% Extensions to the 'regexp' module. +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +is_match(Ex, Re) -> + case regexp:first_match(Ex, Re) of + {match, _, _} -> + true; + nomatch -> + false + end. + +%% -type gsub(String, RegExp, Fun, Acc) -> subres(). +%% Substitute every match of the regular expression RegExp with the +%% string returned from the function Fun(Match, Acc). Accept pre-parsed +%% regular expressions. Acc is an argument to the Fun. The Fun should return +%% a tuple {Replacement, NewAcc}. + +gsub(String, RegExp, Fun, Acc) when list(RegExp) -> + case regexp:parse(RegExp) of + {ok,RE} -> gsub(String, RE, Fun, Acc); + {error,E} -> {error,E} + end; +gsub(String, RE, Fun, Acc) -> + {match,Ss} = regexp:matches(String, RE), + {NewString, NewAcc} = sub_repl(Ss, Fun, Acc, String, 1), + {ok,NewString,NewAcc}. + + +% New code that uses fun for finding the replacement. Also uses accumulator +% to pass argument between the calls to the fun. +sub_repl([{St,L}|Ss], Fun, Acc0, S, Pos) -> + Match = string:substr(S, St, L), + {Rep, Acc} = Fun(Match, Acc0), + {Rs, NewAcc} = sub_repl(Ss, Fun, Acc, S, St+L), + {string:substr(S, Pos, St-Pos) ++ Rep ++ Rs, NewAcc}; +sub_repl([], _Fun, Acc, S, Pos) -> {string:substr(S, Pos), Acc}. + + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% Error and warnings +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +error(Format, Args) -> + io:format("ERROR: " ++ Format ++ "\n", Args), + exit(1). + +warning(Format, Args) -> + case get(silent) of + true -> ok; + _ -> io:format("WARNING: " ++ Format ++ "\n", Args) + end. + +report(Format, Args) -> + case get(silent) of + true -> ok; + _ -> io:format(Format ++ "\n", Args) + end. + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% Extensions to the 'string' module. +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +uc(String) -> + lists:reverse(uc(String, [])). + +uc([], Acc) -> + Acc; +uc([H | T], Acc) when is_integer(H), [97] =< H, H =< $z -> + uc(T, [H - 32 | Acc]); +uc([H | T], Acc) -> + uc(T, [H | Acc]). diff --git a/system/doc/top/src/erlresolvelinks.erl b/system/doc/top/src/erlresolvelinks.erl index 8d277ad17a..a891b67421 120000..100644 --- a/system/doc/top/src/erlresolvelinks.erl +++ b/system/doc/top/src/erlresolvelinks.erl @@ -1 +1,144 @@ -../../../../internal_tools/integration/scripts/resolve_links/erlresolvelinks.erl
\ No newline at end of file +-module(erlresolvelinks). + +%% ------ VERY IMPORTANT ------ +%% +%% Original location for this file: +%% /clearcase/otp/internal_tools/integration/scripts/resolve_links/ +%% When updating this file, copy the source to +%% /usr/local/otp/patch/share/program/ +%% and place .beam files (compiled with correct release) in all +%% /usr/local/otp/patch/share/program/<release> +%% for releases >= R10B +%% +%% ---------------------------- + +-export([make/1, do_make/1, do_make/2, do_make/3]). +-include_lib("kernel/include/file.hrl"). + +-define(JAVASCRIPT_NAME, "erlresolvelinks.js"). + +make([RootDir]) -> + do_make(RootDir); +make([RootDir, DestDir]) -> + do_make(RootDir, DestDir); +make([RootDir, DestDir, Name]) -> + do_make(RootDir, DestDir, Name). + +do_make(RootDir) -> + DestDir = filename:join(RootDir, "doc"), + do_make(RootDir, DestDir). + +do_make(RootDir, DestDir) -> + do_make(RootDir, DestDir, ?JAVASCRIPT_NAME). + +do_make(RootDir, DestDir, Name) -> + %% doc/Dir + %% erts-Vsn + %% lib/App-Vsn + DocDirs0 = get_dirs(filename:join([RootDir, "doc"])), + DocDirs = lists:map(fun(Dir) -> + D = filename:join(["doc", Dir]), + {D, D} end, DocDirs0), + + ErtsDirs = latest_app_dirs(RootDir, ""), + AppDirs = latest_app_dirs(RootDir, "lib"), + + AllAppDirs = + lists:map( + fun({App, AppVsn}) -> {App, filename:join([AppVsn, "doc", "html"])} + end, ErtsDirs ++ AppDirs), + + AllDirs = DocDirs ++ AllAppDirs, + {ok, Fd} = file:open(filename:join([DestDir, Name]), [write]), + UTC = calendar:universal_time(), + io:fwrite(Fd, "/* Generated by ~s at ~w UTC */\n", + [atom_to_list(?MODULE), UTC]), + io:fwrite(Fd, "function erlhref(ups, app, rest) {\n", []), + io:fwrite(Fd, " switch(app) {\n", []), + lists:foreach( + fun({Tag, Dir}) -> + io:fwrite(Fd, " case ~p:\n", [Tag]), + io:fwrite(Fd, " location.href=ups + \"~s/\" + rest;\n", + [Dir]), + io:fwrite(Fd, " break;\n", []) + end, AllDirs), + io:fwrite(Fd, " default:\n", []), + io:fwrite(Fd, " location.href=ups + \"Unresolved\";\n", []), + io:fwrite(Fd, " }\n", []), + io:fwrite(Fd, "}\n", []), + file:close(Fd), + ok. + +get_dirs(Dir) -> + {ok, Files} = file:list_dir(Dir), + AFiles = + lists:map(fun(File) -> {File, filename:join([Dir, File])} end, Files), + lists:zf(fun is_dir/1, AFiles). + +is_dir({File, AFile}) -> + {ok, FileInfo} = file:read_file_info(AFile), + case FileInfo#file_info.type of + directory -> + {true, File}; + _ -> + false + end. + +latest_app_dirs(RootDir, Dir) -> + ADir = filename:join(RootDir, Dir), + RDirs0 = get_dirs(ADir), + RDirs1 = lists:filter(fun is_app_dir/1, RDirs0), + %% Build a list of {{App, VsnNumList}, AppVsn} + SDirs0 = + lists:map(fun(AppVsn) -> + [App, VsnStr] = string:tokens(AppVsn, "-"), + VsnNumList = vsnstr_to_numlist(VsnStr), + {{App, VsnNumList}, AppVsn} end, + RDirs1), + SDirs1 = lists:keysort(1, SDirs0), + App2Dirs = lists:foldr(fun({{App, _VsnNumList}, AppVsn}, Acc) -> + case lists:keymember(App, 1, Acc) of + true -> + Acc; + false -> + [{App, AppVsn}| Acc] + end + end, [], SDirs1), + lists:map(fun({App, AppVsn}) -> {App, filename:join([Dir, AppVsn])} end, + App2Dirs). + +is_app_dir(Dir) -> + case string:tokens(Dir, "-") of + [_Name, Rest] -> + is_vsnstr(Rest); + _ -> + false + end. + +is_vsnstr(Str) -> + case string:tokens(Str, ".") of + [_] -> + false; + Toks -> + lists:all(fun is_numstr/1, Toks) + end. + +is_numstr(Cs) -> + lists:all(fun(C) when $0 =< C, C =< $9 -> + true; + (_) -> + false + end, Cs). + +%% We know: + +vsnstr_to_numlist(VsnStr) -> + lists:map(fun(NumStr) -> list_to_integer(NumStr) end, + string:tokens(VsnStr, ".")). + + + + + + + diff --git a/system/doc/top/src/permuted_index.erl b/system/doc/top/src/permuted_index.erl deleted file mode 120000 index e65338a517..0000000000 --- a/system/doc/top/src/permuted_index.erl +++ /dev/null @@ -1 +0,0 @@ -../../../../internal_tools/integration/scripts/make_index/permuted_index.erl
\ No newline at end of file diff --git a/system/doc/top/templates/erlang.gif b/system/doc/top/templates/erlang.gif Binary files differdeleted file mode 100644 index 91fd4b9647..0000000000 --- a/system/doc/top/templates/erlang.gif +++ /dev/null diff --git a/system/doc/top/templates/first.html.src b/system/doc/top/templates/first.html.src deleted file mode 100644 index edef1c0e5c..0000000000 --- a/system/doc/top/templates/first.html.src +++ /dev/null @@ -1,104 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> - <title>Erlang/OTP #release# Documentation</title> - <style type="text/css"> -<!-- - BODY { background: white } - - BODY { font-family: Verdana, Arial, Helvetica, sans-serif } - TH { font-family: Verdana, Arial, Helvetica, sans-serif } - TD { font-family: Verdana, Arial, Helvetica, sans-serif } - P { font-family: Verdana, Arial, Helvetica, sans-serif } - - .header { background: #222; color: #fff } - .app { background: #ccc } ---> - </style> -</head> -<body bgcolor=white text="#000000" link="#0000ff" vlink="#ff00ff" - alink="#ff0000"> -<center> -<p> -<font size="+1">Welcome to Erlang/OTP, a complete<br> -development environment<br> -for concurrent programming.</font> -</p> -</center> -<br> -<br> -<br> -<p><b> -<font size"+1"> -Some hints that may get you started faster -</font> -</b></p> - -<ul> - -<li>In addition the the documentation here Erlang is described in the book -<a href="http://www.pragprog.com/titles/jaerlang" target="_top">"Programming Erlang"</a>, ISBN 978-1-934356-00-5 which we really recommend as a start.<br/ > -The complete language is also described in the <a href="reference_manual/part_frame.html" target="_top">Erlang Reference Manual</a>. An Erlang tutorial can be found in <a href="getting_started/part_frame.html" target="_top">Getting Started With Erlang</a>. -</li> -<li>Erlang/OTP is divided into a number of OTP <a -href="applications.html">applications</a>. An application normally contains -Erlang <a href="man_index.html">modules</a>. Some OTP applications, -such as the C interface <em>Erl_Interface</em>, are written in other languages and have no Erlang -modules. - -<p> -Note that functions that are not imported or prefixed with a module -name belong to the module -<a href="#kernel#/erlang.html" target="_top">erlang</a> -(in the <em>Kernel</em> application). -</p> -<p> -<li>On a Unix system you can view the manual pages from the command -line using -<pre> - % erl -man <module> -</pre> -<p> - -<li> You can of course use any editor you like to write Erlang -programs, but if you use Emacs there exists editing support such as -indentation, syntax highlighting, electric commands, module name -verification, comment support including paragraph filling, skeletons, -tags support and more. See the <a href="#tools#/index.html" -target="_top">Tools</a> application for details. -<p> -There is also an -<a href="http://erlide.sourceforge.net" target="_top"> -Erlang plugin (ErlIde) for Eclipse</a> if you prefer a more graphical -environment. ErlIde is under development and should at the time -of writing this be quite stable and useful. -<li>When developing with Erlang/OTP you usually test your programs -from the interactive shell (see <a href="getting_started/part_frame.html" -target="_top">Getting Started With Erlang</a>) where you can call individual -functions. There is also a number of tools available, such as the graphical <a -href="#debugger#/index.html" target="_top">Debugger</a>, the process -manager <a href="#pman#/index.html" target="_top">Pman</a> and table -viewer <a href="#tv#/index.html" target="_top">TV</a>. -<p> Also note that there are some shell features like history list -(control-p and control-n), inline editing (emacs key bindings) and -module and function name completion (tab) if the module is loaded. -<p> - -<li>OpenSource users can ask questions -and share experiences on the <a href="http://www.erlang.org/faq.html" -target="_top">Erlang questions mailing list</a>. <p> - -<li>Before asking a question you can browse the <a -href="http://www.erlang.org/pipermail/erlang-questions/" -target="_top">mailing list archive</a> and read the <a -href="http://www.erlang.org/faq/faq.html" target="_top">Frequently -Asked Questions</a>. <p> - -<li>Additional information and links of interest for Erlang programmers can be found on the Erlang Open Source site -<a href="http://www.erlang.org/" target="_top">http://www.erlang.org</a>. -<p> - -</ul> - -</body> -</html> diff --git a/system/doc/top/templates/flip_closed.gif b/system/doc/top/templates/flip_closed.gif Binary files differdeleted file mode 100755 index 9a27c7c25d..0000000000 --- a/system/doc/top/templates/flip_closed.gif +++ /dev/null diff --git a/system/doc/top/templates/flip_google.gif b/system/doc/top/templates/flip_google.gif Binary files differdeleted file mode 100755 index 3f0543c2bb..0000000000 --- a/system/doc/top/templates/flip_google.gif +++ /dev/null diff --git a/system/doc/top/templates/flip_open.gif b/system/doc/top/templates/flip_open.gif Binary files differdeleted file mode 100755 index 9dda60e73a..0000000000 --- a/system/doc/top/templates/flip_open.gif +++ /dev/null diff --git a/system/doc/top/templates/flip_static.gif b/system/doc/top/templates/flip_static.gif Binary files differdeleted file mode 100755 index 2b3ddb5382..0000000000 --- a/system/doc/top/templates/flip_static.gif +++ /dev/null diff --git a/system/doc/top/templates/flipmenu.js b/system/doc/top/templates/flipmenu.js deleted file mode 100755 index 92a5a58a06..0000000000 --- a/system/doc/top/templates/flipmenu.js +++ /dev/null @@ -1,342 +0,0 @@ -// ######################################################################
-
-// ## flipMenu 5.0.0 (c) J. Reijers
-// ## Last modifications: 23 March 2007
-
-// ######################################################################
-
-// ## Degree of indentation from the left.
- flipIndentation = "5px";
-
-// ## Padding inbetween menu items.
- flipVerticalPadding = "4px";
-
-// ## Margin between the left of the browser and the menu.
- flipLeftMargin = "16px";
-
-// ## Margin between the top of the browser and the menu.
- flipTopMargin = "10px";
-
-// ## Allow multiple menus to fold out without closing all the other open ones.
- flipOpenMultipleMenus = false;
-
-// ## Preserve the current state of the menu (requires cookies).
- flipSaveMenuState = true;
-
-// ## Use custom images for bullets
- flipImages = true;
-
-// ## Images to use (specify full path)
- flipImg_open = "flip_open.gif";
- flipImg_closed = "flip_closed.gif";
- flipImg_static = "flip_static.gif";
-
-// ## Initialise all flipMenus onload
- flipInitOnLoad = true;
-
-// ## Message to display in status bar while loading
- flipLoadingMessage = "Loading...";
-
-// ######################################################################
-
-function alterSize(someSize, alterAmount) {
- someSize = String(someSize);
- var tmpNr = parseFloat(someSize.replace(/\D/g, ""));
- var tmpChar = someSize.replace(/\d/g, "");
- return isNaN(tmpNr) ? someSize : ((tmpNr + alterAmount) + tmpChar);
-}
-
-isIE = (String(navigator.appVersion).indexOf("MSIE") > -1);
-if (!isIE) flipIndentation = alterSize(flipIndentation, -16);
-if (!isIE) flipLeftMargin = alterSize(flipLeftMargin, -16);
-
-document.write(
- "<style type=\"text/css\">" +
-
- "ul.flipMenu { margin-top: " + flipTopMargin + "; margin-left: " + flipLeftMargin + "; " + (flipImages ? "" : "list-style-type: none;") + " }" +
- "ul.flipMenu ul, ul.flipMenu li { padding-top: " + flipVerticalPadding + "; margin-left: " + flipIndentation + "; margin-right: 0px; " + (flipImages ? "" : "list-style-type: none;") + " }" +
-
- "li.flipFolderOpen { cursor: pointer; " + (flipImages ? "list-style-image: url(" + flipImg_open + ");" : "") + " }" +
- "li.flipFolderClosed { cursor: pointer; " + (flipImages ? "list-style-image: url(" + flipImg_closed + ");" : "") + " }" +
-
- "</style>"
-);
-
-if (flipImages) {
- aFlipPreloads = [];
- aFlipPreloads[0] = new Image;
- aFlipPreloads[0].src = flipImg_open;
- aFlipPreloads[1] = new Image;
- aFlipPreloads[1].src = flipImg_closed;
- aFlipPreloads[2] = new Image;
- aFlipPreloads[2].src = flipImg_static;
-}
-
-function addEvent(someObj, someEvent, someFunction) {
- if (someObj.addEventListener) { someObj.addEventListener(someEvent, someFunction, true); return true; } else if (someObj.attachEvent) return someObj.attachEvent("on" + someEvent, someFunction); else return false;
-}
-
-function openCloseFlip(theItem, newSetting, openParents) {
- if (theItem.flipID) {
- if (openParents) {
- var tmpItem = theItem;
- while (tmpItem.parentElement || tmpItem.parentNode) {
- tmpItem = (tmpItem.parentElement) ? tmpItem.parentElement : tmpItem.parentNode;
- openCloseFlip(tmpItem, newSetting);
- }
- }
- if ((theItem.className == "flipFolderOpen" && newSetting == "closed") || (theItem.className == "flipFolderClosed" && newSetting == "open")) {
- if (!theItem.childrenInitialised) {
- for (var j = 0; j < theItem.childNodes.length; j++) if (theItem.childNodes[j].nodeName == "UL" && !theItem.childNodes[j].initialised) initFlip(theItem.childNodes[j]);
- theItem.childrenInitialised = true;
- }
- theItem.getElementsByTagName("UL")[0].style.display = (newSetting == "open") ? "" : "none";
- theItem.className = newSetting == "open" ? "flipFolderOpen" : "flipFolderClosed";
- }
- }
-}
-
-function openFlip(theItem, openParents) {
- openCloseFlip(theItem, "open", openParents);
-}
-
-function closeFlip(theItem, closeParents) {
- openCloseFlip(theItem, "closed", closeParents);
-}
-
-function toggleFlip(theElement) {
- if (theElement.flipID) {
- var theItem = theElement;
- var isContained = true;
- } else {
- if (theElement && theElement.button > 0) return false;
- var theItem = (isIE) ? event.srcElement : theElement.target;
-
- var isContained = false;
- if (theItem.className == "flipFolderOpen" || theItem.className == "flipFolderClosed") isContained = true; else while (theItem.parentElement || theItem.parentNode) {
- if (theItem.className == "flipStatic" || theItem.className == "flipFolderOpen" || theItem.className == "flipFolderClosed") {
- isContained = (theItem.className == "flipFolderOpen" || theItem.className == "flipFolderClosed");
- break;
- }
- theItem = (theItem.parentElement) ? theItem.parentElement : theItem.parentNode;
- }
- }
-
- var toOpenFlip = (isContained && theItem.className == "flipFolderClosed");
-
- if (!flipOpenMultipleMenus && (toOpenFlip || theItem.className == "flipStatic")) {
- if (theItem.parentElement || theItem.parentNode) {
- var parentUL = (theItem.parentElement) ? theItem.parentElement : theItem.parentNode;
- for (var i = 0; i < parentUL.childNodes.length; i++) closeFlip(parentUL.childNodes[i]);
- }
- }
-
- if (isContained) {
- if (toOpenFlip) openFlip(theItem); else closeFlip(theItem);
- }
-}
-
-function setAllFlips(startElement, newSetting) {
- if (typeof startElement == "undefined") var startElement = document;
- if (typeof newSetting == "undefined") var newSetting = "closed";
-
- var aUL = startElement.getElementsByTagName("UL");
- for (var i = 0; i < aUL.length; i++) {
- var parentFlip = aUL[i].parentElement ? aUL[i].parentElement : aUL[i].parentNode;
- openCloseFlip(parentFlip, newSetting);
- }
-}
-
-function openAllFlips(startElement) {
- setAllFlips(startElement, "open");
-}
-
-function closeAllFlips(startElement) {
- setAllFlips(startElement, "closed");
-}
-
-function initFlip(startElement) {
- if (!document.createElement) return false;
-
- if (!startElement || !startElement.nodeName) {
- var aUL = document.getElementsByTagName("UL");
- for (var i = 0; i < aUL.length; i++) {
- if (flipLoadingMessage != "") window.status = flipLoadingMessage + " " + parseInt((i / (aUL.length - 1)) * 100, 10) + "%";
- var curUL = aUL[i];
- if (curUL.className == "flipMenu") {
- initFlip(curUL);
-
- // ## Fix text selecting problem in Mozilla
- curUL.onselectstart = new Function("return false");
- curUL.onmousedown = new Function("return false");
- curUL.onclick = new Function("return true");
- }
- }
-
- if (flipSaveMenuState) loadMenuState();
-
- if (flipLoadingMessage != "") window.status = "";
- return true;
- }
-
- if (startElement.className == "flipMenu") startElement.style.display = "";
-
- if (!startElement.childNodes || startElement.childNodes.length == 0) return false;
-
- if (typeof flipIDCur == "undefined") flipIDCur = 0;
- if (!startElement.initialised) {
- var aUL = startElement.getElementsByTagName("UL");
- for (var i = 0; i < aUL.length; i++) aUL[i].style.display = "none";
- }
-
- for (var i = 0; i < startElement.childNodes.length; i++) {
- var curNode = startElement.childNodes[i];
- if (curNode.nodeName == "LI") {
- flipIDCur++;
- curNode.flipID = flipIDCur;
-
- var nodeHasChildren = curNode.getElementsByTagName("UL").length > 0;
- if (nodeHasChildren) {
- if (flipImages && curNode.flipClosed) curNode.style.listStyleImage = "url(" + curNode.flipClosed + ")";
-
- if (curNode.className == null || curNode.className == "") curNode.className = "flipFolderClosed";
- } else {
- curNode.className = "flipStatic";
- if (flipImages && !curNode.style.listStyleImage) {
- if (!curNode.flipStatic) curNode.flipStatic = flipImg_static;
- curNode.style.listStyleImage = "url(" + curNode.flipStatic + ")";
- }
- }
-
- if (!curNode.flipOpen) curNode.flipOpen = flipImg_open;
- if (!curNode.flipClosed) curNode.flipClosed = flipImg_closed;
-
- if (curNode.flipIsOpen) openFlip(curNode);
- }
- }
-
- startElement.initialised = true;
-}
-
-function rootOfFlip(flipID, startElement) {
-
- function containsFlip(startElement, flipID) {
- var flipFound = false;
- var i = 0;
- while (i < startElement.childNodes.length && !flipFound) {
- var curNode = startElement.childNodes[i];
- flipFound = (curNode.flipID == flipID) ? true : containsFlip(curNode, flipID);
- i++;
- }
- return flipFound;
- }
-
- var rootFlip = null;
-
- if (!startElement || !startElement.nodeName) {
- var aUL = document.getElementsByTagName("UL");
- var i = 0;
- while (rootFlip == null && i < aUL.length) {
- var curUL = aUL[i];
- if (curUL.nodeName == "UL" && curUL.className == "flipMenu") rootFlip = rootOfFlip(flipID, curUL);
- i++;
- }
- return rootFlip;
- }
-
- if (startElement.childNodes) for (var i = 0; i < startElement.childNodes.length; i++) {
- var curNode = startElement.childNodes[i];
- if (curNode.flipID == flipID || containsFlip(curNode, flipID)) rootFlip = curNode;
- }
-
- return rootFlip;
-}
-
-function getCookie(cookieName) {
- var allCookies = document.cookie;
- var indexStr = allCookies.indexOf(cookieName + "=");
- if (indexStr == -1) return "";
- indexStr = allCookies.indexOf("=", indexStr) + 1;
- var endStr = allCookies.indexOf(";", indexStr);
- if (endStr == -1) endStr = allCookies.length;
- return unescape(allCookies.substring(indexStr, endStr));
-}
-
-function inArray(someID, someArray) {
- for (var i = 0; i < someArray.length; i++) if (someArray[i] == someID) return true;
- return false;
-}
-
-function getMenuState(startElement) {
- if (!startElement.childNodes || startElement.childNodes.length == 0) return "";
-
- var openItems = "";
- var aUL = startElement.getElementsByTagName("UL");
- for (var i = 0; i < aUL.length; i++) {
- var curNode = aUL[i];
- var parentFlip = (curNode.parentElement) ? curNode.parentElement : curNode.parentNode;
- if (curNode.style.display == "" && parentFlip.flipID) openItems += " " + parentFlip.flipID;
- }
- return openItems;
-}
-
-function putMenuState(startElement) {
- if (!startElement.childNodes || startElement.childNodes.length == 0) return false;
-
- var aUL = startElement.getElementsByTagName("UL");
- for (var i = 0; i < aUL.length; i++) {
- var curNode = aUL[i];
- var parentFlip = (curNode.parentElement) ? curNode.parentElement : curNode.parentNode;
- if (inArray(parentFlip.flipID, aOpenItems)) {
- openFlip(parentFlip);
- if (typeof prevFlipRoot == "undefined") {
- var testRoot = rootOfFlip(parentFlip.flipID);
- if (testRoot.flipID == parentFlip.flipID) prevFlipRoot = testRoot;
- }
- }
- }
-}
-
-function saveMenuState() {
- if (flipSaveMenuState) {
- var aUL = document.getElementsByTagName("UL");
- for (var i = 0; i < aUL.length; i++) {
- var curUL = aUL[i];
- var curID = curUL.id ? curUL.id : i;
- if (curUL.className == "flipMenu") document.cookie = cookiePrefix + curID + "=" + getMenuState(curUL) + ";";
- }
- }
-}
-
-function loadMenuState() {
- var aUL = document.getElementsByTagName("UL");
- for (var i = 0; i < aUL.length; i++) {
- var curUL = aUL[i];
- var curID = curUL.id ? curUL.id : i;
- if (curUL.className == "flipMenu") {
- var savedState = String(getCookie(cookiePrefix + curID));
- if (savedState != "") {
- aOpenItems = savedState.split(" ");
- putMenuState(curUL);
- }
- }
- }
-
- addEvent(window, "unload", saveMenuState);
-}
-
-function clearMenuState(flipMenuID) {
- if (typeof flipMenuID == "undefined") {
- var aUL = document.getElementsByTagName("UL");
- for (var i = 0; i < aUL.length; i++) {
- var curUL = aUL[i];
- var curID = curUL.id ? curUL.id : i;
- if (curUL.className == "flipMenu") document.cookie = cookiePrefix + curID + "=;";
- }
- } else document.cookie = cookiePrefix + flipMenuID + "=;";
-}
-
-cookiePrefix = document.location.pathname + "_";
-
-addEvent(document, "click", toggleFlip);
-if (flipInitOnLoad) addEvent(window, "load", initFlip);
diff --git a/system/doc/top/templates/index.html.src b/system/doc/top/templates/index.html.src index 935bb11c80..257a656316 100644 --- a/system/doc/top/templates/index.html.src +++ b/system/doc/top/templates/index.html.src @@ -2,7 +2,7 @@ <!-- %CopyrightBegin% -Copyright Ericsson AB 2001-2009. All Rights Reserved. +Copyright Ericsson AB 2009-2010. 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 @@ -169,7 +169,7 @@ Asked Questions</a>. <p> <center> <small> -Copyright © 1999-2009 +Copyright © 1999-2010 <a href="http://www.ericsson.com">Ericsson AB</a> </small> </center> diff --git a/system/doc/top/templates/otp_top.css b/system/doc/top/templates/otp_top.css deleted file mode 100644 index 1c6d27bd8d..0000000000 --- a/system/doc/top/templates/otp_top.css +++ /dev/null @@ -1,53 +0,0 @@ - BODY { background: white } - - BODY { font-family: Verdana, Arial, Helvetica, sans-serif } - TH { font-family: Verdana, Arial, Helvetica, sans-serif } - TD { font-family: Verdana, Arial, Helvetica, sans-serif } - P { font-family: Verdana, Arial, Helvetica, sans-serif } - - .header { background: #222; color: #fff } - .top { background: #efe } - .otp { background: #efe } - .erlang { background: #ffe } - .otp2 { background: #efe } - .app { background: #ffe } - - a:link { color: blue; text-decoration: none } - a:active { color: blue; text-decoration: none } - a:visited { color: blue; text-decoration: none } - body { - margin: 0; - padding: 0; - border: 0; - overflow: scroll; - height: 100%; - max-height: 100% - } - #container { - width: 100%; - margin: 10px auto; - background-color: #fff; - } - #leftnav { - float: left; - width: 200px; - margin: 0; - padding: 1em; - } - #content { - margin-left: 220px; /* set left value to WidthOfFrameDiv */ - border-left: 1px solid red; - } - - .innertube { - margin: 15px; /* Magins for inner DIV inside each DIV (to provide padding) */ - } - - * html body{ /* IE6 hack */ - padding: 0 0 0 200px; /* Set value to (0 0 0 WidthOfFrameDiv)*/ - } - * html #maincontent{ /* IE6 hack*/ - height: 100%; - width: 100%; - } - diff --git a/system/doc/top/templates/system.html.src b/system/doc/top/templates/system.html.src deleted file mode 100644 index 761bc96ed0..0000000000 --- a/system/doc/top/templates/system.html.src +++ /dev/null @@ -1,281 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> - <title>Erlang/OTP #release#</title> - <style type="text/css"> -<!-- - BODY { background: white } - - BODY { font-family: Verdana, Arial, Helvetica, sans-serif } - TH { font-family: Verdana, Arial, Helvetica, sans-serif } - TD { font-family: Verdana, Arial, Helvetica, sans-serif } - P { font-family: Verdana, Arial, Helvetica, sans-serif } - - .header { background: #222; color: #fff } - .app { background: #ccc } - - a.anum:link { color: green; text-decoration: none } - a.anum:active { color: green; text-decoration: none } - a.anum:visited { color: green; text-decoration: none } - - a:link { text-decoration: none } - a:active { text-decoration: none } - a:visited { text-decoration: none } ---> - </style> -</head> - -<body bgcolor=white text="#000000" link="#0000ff" vlink="#ff00ff" - alink="#ff0000"> -<center> -<table border=0 width="90%" cellspacing=3 cellpadding=5> - - <tr> - <td colspan=2 class=header> - <font size="+1"><b>General</b></font> - </td> - </tr> - - <tr class=app> - <td align=left valign=top> - <table border=0 width="100%" cellspacing=0 cellpadding=0> - <tr class=app> - <td align=left valign=top> - <a href="system_architecture_intro/part_frame.html" target="_top" - name=system_architecture_intro> - Introduction - </a> - </td> - <td align=right valign=top width=50> - </td> - </tr> - </table> - </td> - <td align=left valign=top> -About Erlang, OTP, Erlang/OTP and this documentation - </td> - </tr> - - <tr class=app> - <td align=left valign=top> - <table border=0 width="100%" cellspacing=0 cellpadding=0> - <tr class=app> - <td align=left valign=top> - <a href="installation_guide/part_frame.html" target="_top" - name=installation_guide> - Installation Guide - </a> - </td> - <td align=right valign=top width=50> - </td> - </tr> - </table> - </td> - <td align=left valign=top> -The Erlang/OTP Installation Guide - </td> - </tr> - - <tr class=app> - <td align=left valign=top> - <table border=0 width="100%" cellspacing=0 cellpadding=0> - <tr class=app> - <td align=left valign=top> - <a href="system_principles/part_frame.html" target="_top" - name=system_principles> - System Principles - </a> - </td> - <td align=right valign=top width=20> - </td> - </tr> - </table> - </td> - <td align=left valign=top> -Starting, stopping and configuring the Erlang runtime system - </td> - </tr> - - <tr class=app> - <td align=left valign=top> - <table border=0 width="100%" cellspacing=0 cellpadding=0> - <tr class=app> - <td align=left valign=top> - <a href="embedded/part_frame.html" target="_top" name=embedded> - Embedded System - </a> - </td> - <td align=right valign=top width=50> - </td> - </tr> - </table> - </td> - <td align=left valign=top> -Erlang in an Embedded System - </td> - </tr> - - <tr> - <td colspan=2><font size=1> </font></td> - </tr> - -<!-- ====================================================================== --> - - <tr> - <td colspan=2 class=header> - <font size="+1"><b>Programming in Erlang</b></font> - </td> - </tr> - - <tr class=app> - <td align=left valign=top> - <table border=0 width="100%" cellspacing=0 cellpadding=0> - <tr class=app> - <td align=left valign=top> - <a href="reference_manual/part_frame.html" target="_top" name=reference_manual> - Erlang Reference Manual - </a> - </td> - <td align=right valign=top width=50> - </td> - </tr> - </table> - </td> - <td align=left valign=top> -Description of data types, language constructs and more - </td> - </tr> - - <tr class=app> - <td align=left valign=top> - <table border=0 width="100%" cellspacing=0 cellpadding=0> - <tr class=app> - <td align=left valign=top> - <a href="getting_started/part_frame.html" target="_top" name=getting_started> - Getting Started - </a> - </td> - <td align=right valign=top width=50> - </td> - </tr> - </table> - </td> - <td align=left valign=top> -Getting started with Erlang - </td> - </tr> - - <tr class=app> - <td align=left valign=top> - <table border=0 width="100%" cellspacing=0 cellpadding=0> - <tr class=app> - <td align=left valign=top> - <a href="programming_examples/part_frame.html" target="_top" name=programming_examples> - Programming Examples - </a> - </td> - <td align=right valign=top width=50> - </td> - </tr> - </table> - </td> - <td align=left valign=top> -Examples of using records, funs, list comprehensions and the bit syntax - </td> - </tr> - - <tr class=app> - <td align=left valign=top> - <table border=0 width="100%" cellspacing=0 cellpadding=0> - <tr class=app> - <td align=left valign=top> - <a href="efficiency_guide/part_frame.html" target="_top" name=efficiency_guide>Efficiency Guide</a> - </td> - <td align=right valign=top width=20> - </td> - </tr> - </table> - </td> - <td align=left valign=top> -Learn how to write efficient programs in Erlang - </td> - </tr> - - <tr class=app> - <td align=left valign=top> - <table border=0 width="100%" cellspacing=0 cellpadding=0> - <tr class=app> - <td align=left valign=top> - <a href="tutorial/part_frame.html" target="_top" name=tutorial>Interoperability Tutorial</a> - </td> - <td align=right valign=top width=20> - </td> - </tr> - </table> - </td> - <td align=left valign=top> -About interoperating with programs written in other programming languages - </td> - </tr> - - <tr> - <td colspan=2><font size=1> </font></td> - </tr> - -<!-- ====================================================================== --> - - <tr> - <td colspan=2 class=header> - <font size="+1"><b>Working with OTP</b></font> - </td> - </tr> - - <tr class=app> - <td align=left valign=top> - <table border=0 width="100%" cellspacing=0 cellpadding=0> - <tr class=app> - <td align=left valign=top> - <a href="design_principles/part_frame.html" target="_top" - name=design_principles> - Design Principles - </a> - </td> - <td align=right valign=top width=20> - </td> - </tr> - </table> - </td> - <td align=left valign=top> -Structure your programs with applications, supervisors and generic behaviors (gen_server, gen_event and gen_fsm). -Also use the built in error logger. - </td> - </tr> - - <tr class=app> - <td align=left valign=top> - <table border=0 width="100%" cellspacing=0 cellpadding=0> - <tr class=app> - <td align=left valign=top> - <a href="oam/part_frame.html" target="_top" name=oam>OAM Principles</a> - </td> - <td align=right valign=top width=20> - </td> - </tr> - </table> - </td> - <td align=left valign=top> -OTP Operation and Management Principles - </td> - </tr> - - <tr> - <td colspan=2><font size=1> </font></td> - </tr> - -</table> - -</center> -</body> -</html> - - diff --git a/system/doc/top/templates/toc_.html.src b/system/doc/top/templates/toc_.html.src deleted file mode 100644 index 5e79bc0ac8..0000000000 --- a/system/doc/top/templates/toc_.html.src +++ /dev/null @@ -1,105 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> - <title>Erlang/OTP #release#</title> - <style type="text/css"> -<!-- - BODY { background: white } - - BODY { font-family: Verdana, Arial, Helvetica, sans-serif } - TH { font-family: Verdana, Arial, Helvetica, sans-serif } - TD { font-family: Verdana, Arial, Helvetica, sans-serif } - P { font-family: Verdana, Arial, Helvetica, sans-serif } - - .header { background: #222; color: #fff } - .top { background: #efe } - .otp { background: #efe } - .erlang { background: #ffe } - .otp2 { background: #efe } - .app { background: #ffe } - - a:link { color: blue; text-decoration: none } - a:active { color: blue; text-decoration: none } - a:visited { color: blue; text-decoration: none } ---> - </style> -</head> - -<body bgcolor=white text="#000000" link="#0000ff" vlink="#ff00ff" - alink="#ff0000"> -<center> -<font size="+1"><b>Erlang/OTP #release#</b></font><br> -</center> - -<div class=top> -<small><a href="glossary.html" target=body>Glossary</a> | -<a href="man_index.html" target=body>Modules</a> | -<a href="permuted_index/pidxa.html" target=body>Index</a></small> -<p> -<small><a href="highlights.html" target=body>Release highlights</a><br> -<a href="incompatible.html" target=body>Potential incompatibilities</a> -</small> -</div> - -<p> -<div class=otp> -Erlang/OTP -<br> -·<small><a href="installation_guide/part_frame.html" target="_top" - name=installation_guide>Installation Guide</a></small> - -<br> -·<small><a href="system_principles/part_frame.html" target="_top" - name=system_principles>System Principles</a></small> - -<br> -·<small><a href="embedded/part_frame.html" target="_top" name=embedded>Embedded System</a></small> - -</div> - -<p> -<div class=erlang> -Erlang Programming -<br> -·<small><a href="getting_started/part_frame.html" target="_top" name=getting_started>Getting -Started</a></small> - -<br> -·<small><a href="reference_manual/part_frame.html" target="_top" name=reference_manual>Erlang -Reference Manual</a></small> - -<br> -·<small><a href="programming_examples/part_frame.html" target="_top" name=programming_examples>Programming -Examples</a></small> - -<br> -·<small><a href="efficiency_guide/part_frame.html" target="_top" name=efficiency_guide>Efficiency Guide</a></small> - -<br> -·<small><a href="tutorial/part_frame.html" target="_top" name=tutorial>Interoperability Tutorial</a></small> -</div> - -<p> -<div class=otp2> -Working with OTP -<br> -·<small><a href="design_principles/part_frame.html" target="_top" - name=design_principles>Design Principles</a> -</small> - -<br> -·<small><a href="oam/part_frame.html" target="_top" name=oam>OAM Principles</a></small> - -</div> - -<p> -<div class=app> -Applications -<small>#applinks#</small> -</div> - -<p> -<a href="http://www.erlang.se/" target=body>http://www.erlang.se</a> - -</body> -</html> |
