diff options
Diffstat (limited to 'erts/doc')
| -rw-r--r-- | erts/doc/Makefile | 37 | ||||
| -rw-r--r-- | erts/doc/src/.gitignore | 3 | ||||
| -rw-r--r-- | erts/doc/src/Makefile | 113 | ||||
| -rw-r--r-- | erts/doc/src/epmd_cmd.xml (renamed from erts/doc/src/epmd.xml) | 13 | ||||
| -rw-r--r-- | erts/doc/src/erl_cmd.xml (renamed from erts/doc/src/erl.xml) | 8 | ||||
| -rw-r--r-- | erts/doc/src/erlang.xml | 3 | ||||
| -rw-r--r-- | erts/doc/src/erlc_cmd.xml (renamed from erts/doc/src/erlc.xml) | 3 | ||||
| -rw-r--r-- | erts/doc/src/erlsrv_cmd.xml (renamed from erts/doc/src/erlsrv.xml) | 13 | ||||
| -rw-r--r-- | erts/doc/src/escript_cmd.xml (renamed from erts/doc/src/escript.xml) | 3 | ||||
| -rw-r--r-- | erts/doc/src/ref_man.xml.src | 18 | ||||
| -rw-r--r-- | erts/doc/src/run_erl_cmd.xml (renamed from erts/doc/src/run_erl.xml) | 5 | ||||
| -rw-r--r-- | erts/doc/src/start_cmd.xml (renamed from erts/doc/src/start.xml) | 5 | ||||
| -rw-r--r-- | erts/doc/src/start_erl_cmd.xml (renamed from erts/doc/src/start_erl.xml) | 7 | ||||
| -rw-r--r-- | erts/doc/src/werl_cmd.xml (renamed from erts/doc/src/werl.xml) | 9 |
14 files changed, 70 insertions, 170 deletions
diff --git a/erts/doc/Makefile b/erts/doc/Makefile deleted file mode 100644 index f26a43592e..0000000000 --- a/erts/doc/Makefile +++ /dev/null @@ -1,37 +0,0 @@ -# -# %CopyrightBegin% -# -# Copyright Ericsson AB 1996-2016. All Rights Reserved. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# %CopyrightEnd% -# - -# -# Default Rules -# -OTP_MAKE_ROOT=/home/super/otp/otp_make -include $(OTP_MAKE_ROOT)/otp.mk - -# -# Macros -# -SUB_DIRECTORIES = src - -SPECIAL_TARGETS = - -# -# Default Subdir Targets -# -include $(OTP_MAKE_ROOT)/otp_subdir.mk diff --git a/erts/doc/src/.gitignore b/erts/doc/src/.gitignore new file mode 100644 index 0000000000..abe9a7d858 --- /dev/null +++ b/erts/doc/src/.gitignore @@ -0,0 +1,3 @@ +ref_man.xml +specs.xml +part.xml
\ No newline at end of file diff --git a/erts/doc/src/Makefile b/erts/doc/src/Makefile index bb96293947..3e2eb80b50 100644 --- a/erts/doc/src/Makefile +++ b/erts/doc/src/Makefile @@ -37,15 +37,15 @@ RELSYSDIR = $(RELEASE_PATH)/$(APPLICATION)-$(VSN) # Target Specs # ---------------------------------------------------- XML_APPLICATION_FILES = ref_man.xml -XML_REF1_FILES = epmd.xml \ - erl.xml \ - erlc.xml \ - escript.xml \ - werl.xml \ - erlsrv.xml \ - start_erl.xml \ - run_erl.xml \ - start.xml +XML_REF1_FILES = epmd_cmd.xml \ + erl_cmd.xml \ + erlc_cmd.xml \ + escript_cmd.xml \ + werl_cmd.xml \ + erlsrv_cmd.xml \ + start_erl_cmd.xml \ + run_erl_cmd.xml \ + start_cmd.xml ifeq ($(USE_ESOCK), yes) XML_REF3_ESOCK_EFILES = socket.xml @@ -72,13 +72,16 @@ XML_REF3_EFILES = \ zlib.xml \ $(XML_REF3_ESOCK_EFILES) -XML_REF3_FILES = \ - $(XML_REF3_EFILES) \ +XML_REF3_CREF = \ driver_entry.xml \ erl_nif.xml \ erl_driver.xml \ erts_alloc.xml +XML_REF3_FILES = \ + $(XML_REF3_EFILES) \ + $(XML_REF3_CREF) + XML_PART_FILES = \ part.xml internal.xml @@ -96,7 +99,6 @@ XML_INTERNAL_FILES = \ SuperCarrier.xml \ CountingInstructions.xml - XML_CHAPTER_FILES = \ introduction.xml \ tty.xml \ @@ -118,32 +120,24 @@ TOPDOCDIR=../../../doc BOOK_FILES = book.xml -GIF_FILES = \ +IMAGE_FILES = \ erl_ext_fig.gif XML_FILES = \ $(BOOK_FILES) $(XML_CHAPTER_FILES) \ $(XML_PART_FILES) $(XML_REF3_FILES) $(XML_REF1_FILES) $(XML_APPLICATION_FILES) +HTML_EXTRA_FILES = $(ERL_TOP)/erts/example/time_compat.erl \ + $(ERL_TOP)/lib/kernel/examples/gen_tcp_dist/src/gen_tcp_dist.erl + XML_GEN_FILES = $(XML_INTERNAL_FILES:%=$(XMLDIR)/%) -# ---------------------------------------------------- +NO_CHUNKS = $(XML_REF3_CREF) erl_tracer.xml -HTML_FILES = $(XML_APPLICATION_FILES:%.xml=$(HTMLDIR)/%.html) \ - $(XML_PART_FILES:%.xml=$(HTMLDIR)/%.html) +# ---------------------------------------------------- -INFO_FILE = ../../info INFO_FILE_SRC = ../../info.src -MAN1_FILES = $(XML_REF1_FILES:%.xml=$(MAN1DIR)/%.1) -MAN3_FILES = $(XML_REF3_FILES:%.xml=$(MAN3DIR)/%.3) - -HTML_REF_MAN_FILE = $(HTMLDIR)/index.html - -TOP_PDF_FILE = $(PDFDIR)/$(APPLICATION)-$(VSN).pdf - -SPECS_FILES = $(XML_REF3_EFILES:%.xml=$(SPECDIR)/specs_%.xml) - TOP_SPECS_FILE = specs.xml XML_FIGURE_DIR = $(XMLDIR)/figures @@ -153,60 +147,24 @@ PNG_FILES = $(notdir $(INTERNAL_DOC_PNG_FILES)) XMLDIR_PNG_FILES = $(PNG_FILES:%=$(XML_FIGURE_DIR)/%) # ---------------------------------------------------- -# FLAGS -# ---------------------------------------------------- -XML_FLAGS += - -KERNEL_SRC=$(ERL_TOP)/lib/kernel/src -KERNEL_INCLUDE=$(ERL_TOP)/lib/kernel/include -SPECS_FLAGS = -I$(KERNEL_SRC) -I$(KERNEL_INCLUDE) - -# ---------------------------------------------------- # Targets # ---------------------------------------------------- -_create_dirs := $(shell mkdir -p $(XML_FIGURE_DIR)) +include $(ERL_TOP)/make/doc.mk -$(HTMLDIR)/%.gif: %.gif - $(INSTALL_DATA) $< $@ +_create_dirs := $(shell mkdir -p $(XML_FIGURE_DIR)) $(XML_FIGURE_DIR)/%.png: ../../emulator/internal_doc/figures/%.png $(INSTALL_DATA) $< $@ -docs: part ref_man specs figures man pdf html $(INFO_FILE) - -$(TOP_PDF_FILE): $(XML_FILES) - -pdf: $(TOP_PDF_FILE) - -html: gifs $(HTML_REF_MAN_FILE) - -man: $(MAN1_FILES) $(MAN3_FILES) - -ref_man: ref_man.xml -part: part.xml -specs: specs.xml - -gifs: $(GIF_FILES:%=$(HTMLDIR)/%) +html: figures $(INFO_FILE): $(INFO_FILE_SRC) $(ERL_TOP)/make/$(TARGET)/otp.mk sed -e 's;%RELEASE%;$(SYSTEM_VSN);' $(INFO_FILE_SRC) > $(INFO_FILE) figures: $(XMLDIR_PNG_FILES) -debug opt: - -ldocs: xmllint local_docs - -clean: - rm -rf $(HTMLDIR)/* - rm -rf $(XMLDIR) - rm -f $(MAN1DIR)/* - rm -f $(MAN3DIR)/* - rm -f $(TOP_PDF_FILE) $(TOP_PDF_FILE:%.pdf=%.fo) - rm -f $(SPECDIR)/* - rm -f errs core *~ - -$(SPECDIR)/specs_%.xml: +## This rule generate dummy specs for all XML_REF3_CREF's +$(XML_REF3_CREF:%.xml=$(SPECDIR)/specs_%.xml): $(@:%.xml=%.xml) $(gen_verbose)escript $(SPECS_EXTRACTOR) $(SPECS_FLAGS) \ -o$(dir $@) -module $(patsubst $(SPECDIR)/specs_%.xml,%,$@) @@ -229,25 +187,10 @@ specs.xml: specs.xml.src # ---------------------------------------------------- # Release Target # ---------------------------------------------------- -include $(ERL_TOP)/make/otp_release_targets.mk -release_docs_spec: docs - $(INSTALL_DIR) "$(RELSYSDIR)/doc/pdf" - $(INSTALL_DATA) $(TOP_PDF_FILE) "$(RELSYSDIR)/doc/pdf" - $(INSTALL_DIR) "$(RELSYSDIR)/doc/html" +release_html_spec: release_figures + +release_figures: $(INSTALL_DIR) "$(RELSYSDIR)/doc/html/figures" - $(INSTALL_DATA) $(HTMLDIR)/* \ - "$(RELSYSDIR)/doc/html" $(INSTALL_DATA) $(XMLDIR)/figures/* \ "$(RELSYSDIR)/doc/html/figures" - $(INSTALL_DATA) $(ERL_TOP)/erts/example/time_compat.erl \ - "$(RELSYSDIR)/doc/html" - $(INSTALL_DATA) $(ERL_TOP)/lib/kernel/examples/gen_tcp_dist/src/gen_tcp_dist.erl \ - "$(RELSYSDIR)/doc/html" - $(INSTALL_DATA) $(INFO_FILE) "$(RELSYSDIR)" - $(INSTALL_DIR) "$(RELEASE_PATH)/man/man3" - $(INSTALL_DATA) $(MAN3DIR)/* "$(RELEASE_PATH)/man/man3" - $(INSTALL_DIR) "$(RELEASE_PATH)/man/man1" - $(INSTALL_DATA) $(MAN1_FILES) "$(RELEASE_PATH)/man/man1" - -release_spec: diff --git a/erts/doc/src/epmd.xml b/erts/doc/src/epmd_cmd.xml index 75353cbc07..ee886bd68e 100644 --- a/erts/doc/src/epmd.xml +++ b/erts/doc/src/epmd_cmd.xml @@ -11,7 +11,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - + http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software @@ -19,11 +19,11 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. - + </legalnotice> <title>epmd</title> - <prepared>Claes Wikström</prepared> + <prepared>Claes Wikström</prepared> <responsible></responsible> <docno>1</docno> <approved></approved> @@ -295,9 +295,8 @@ <title>Logging</title> <p>On some operating systems <em>syslog</em> will be used for error reporting when <c>epmd</c> runs as a daemon. To enable - the error logging, you must edit the - <path unix="" windows="">/etc/syslog.conf</path> file and add an - entry:</p> + the error logging, you must edit the /etc/syslog.conf file and + add an entry:</p> <code type="none"><![CDATA[ !epmd @@ -334,5 +333,3 @@ <p>To restrict access further, firewall software must be used.</p> </section> </comref> - - diff --git a/erts/doc/src/erl.xml b/erts/doc/src/erl_cmd.xml index e94d71e27b..64663ce95e 100644 --- a/erts/doc/src/erl.xml +++ b/erts/doc/src/erl_cmd.xml @@ -11,7 +11,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - + http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software @@ -181,7 +181,7 @@ which is used to start the system; see <seealso marker="init"><c>init(3)</c></seealso>. Unless <c><![CDATA[File]]></c> contains an absolute path, the system searches - for <c><![CDATA[File.boot]]></c> in the current and + for <c><![CDATA[File.boot]]></c> in the current and <c><![CDATA[$ROOT/bin]]></c> directories.</p> <p>Defaults to <c><![CDATA[$ROOT/bin/start.boot]]></c>.</p> </item> @@ -852,7 +852,7 @@ <p>Sets the range of characters that the system considers printable in heuristic detection of strings. This typically affects the shell, debugger, and <c>io:format</c> functions (when <c>~tp</c> is used in - the format string).</p> + the format string).</p> <p>Two values are supported for <c>Range</c>:</p> <taglist> <tag><c>latin1</c></tag> @@ -1275,7 +1275,7 @@ node identifiers can be omitted. If omitted, the thread ID defaults to <c>t0</c>, the core ID defaults to <c>c0</c>, the processor ID defaults to <c>p0</c>, and the node ID is - left undefined. Either each logical processor must + left undefined. Either each logical processor must belong to only one NUMA node, or no logical processors must belong to any NUMA nodes.</p> <p>Both increasing and decreasing <c><![CDATA[<IdRange>]]></c>s diff --git a/erts/doc/src/erlang.xml b/erts/doc/src/erlang.xml index ec30006fad..7c8591f719 100644 --- a/erts/doc/src/erlang.xml +++ b/erts/doc/src/erlang.xml @@ -8271,7 +8271,7 @@ Metadata = #{ pid => pid(), </func> <func> - <name name="system_info" arity="1" clause_i="76" since=""/> + <name name="system_info" arity="1" clause_i="77" since=""/> <fsummary>System info overview.</fsummary> <desc> <p>Returns information about the current system. @@ -9602,6 +9602,7 @@ Metadata = #{ pid => pid(), <name name="system_info" arity="1" clause_i="75" since=""/> <!-- version --> <name name="system_info" arity="1" clause_i="76" since=""/> <!-- wordsize --> <!-- <name name="system_info" arity="1" clause_i="77"/> overview --> + <!-- When adding any entry, make sure to update the overview clause_i --> <fsummary>Information about the system.</fsummary> <desc> <marker id="system_info_misc_tags"/> diff --git a/erts/doc/src/erlc.xml b/erts/doc/src/erlc_cmd.xml index f1f2c786da..55a4712b25 100644 --- a/erts/doc/src/erlc.xml +++ b/erts/doc/src/erlc_cmd.xml @@ -11,7 +11,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - + http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software @@ -387,4 +387,3 @@ erlc +export_all file.erl</pre> <seealso marker="snmp:snmp"><c>snmp(3)</c></seealso></p> </section> </comref> - diff --git a/erts/doc/src/erlsrv.xml b/erts/doc/src/erlsrv_cmd.xml index 6c08b25220..1db5fcd9db 100644 --- a/erts/doc/src/erlsrv.xml +++ b/erts/doc/src/erlsrv_cmd.xml @@ -11,7 +11,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - + http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software @@ -43,7 +43,7 @@ Windows services applet in a manner similar to other services.</p> <p>Notice that <c>erlsrv</c> is not a general service utility for Windows, - but designed for embedded Erlang systems.</p> + but designed for embedded Erlang systems.</p> <p><c>erlsrv</c> also provides a command-line interface for registering, changing, starting, and stopping services.</p> @@ -471,10 +471,10 @@ <code type="none"><![CDATA[ #include <windows.h> -/* +/* ** A Console control handler that ignores the log off events, ** and lets the default handler take care of other events. -*/ +*/ BOOL WINAPI service_aware_handler(DWORD ctrl){ if(ctrl == CTRL_LOGOFF_EVENT) return TRUE; @@ -485,8 +485,8 @@ BOOL WINAPI service_aware_handler(DWORD ctrl){ void initialize_handler(void){ char buffer[2]; - /* - * We assume we are running as a service if this + /* + * We assume we are running as a service if this * environment variable is defined. */ if(GetEnvironmentVariable("ERLSRV_SERVICE_NAME",buffer, @@ -530,4 +530,3 @@ void initialize_handler(void){ <c>release_handler(3)</c></seealso></p> </section> </comref> - diff --git a/erts/doc/src/escript.xml b/erts/doc/src/escript_cmd.xml index be1664b39f..4ca7e46e6e 100644 --- a/erts/doc/src/escript.xml +++ b/erts/doc/src/escript_cmd.xml @@ -11,7 +11,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - + http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software @@ -448,4 +448,3 @@ ok </taglist> </section> </comref> - diff --git a/erts/doc/src/ref_man.xml.src b/erts/doc/src/ref_man.xml.src index 7dd003763c..5b327165d4 100644 --- a/erts/doc/src/ref_man.xml.src +++ b/erts/doc/src/ref_man.xml.src @@ -34,24 +34,24 @@ <xi:include href="atomics.xml"/> <xi:include href="counters.xml"/> <xi:include href="driver_entry.xml"/> - <xi:include href="epmd.xml"/> - <xi:include href="erl.xml"/> + <xi:include href="epmd_cmd.xml"/> + <xi:include href="erl_cmd.xml"/> <xi:include href="erlang.xml"/> - <xi:include href="erlc.xml"/> + <xi:include href="erlc_cmd.xml"/> <xi:include href="erl_driver.xml"/> <xi:include href="erl_nif.xml"/> <xi:include href="erl_prim_loader.xml"/> - <xi:include href="erlsrv.xml"/> + <xi:include href="erlsrv_cmd.xml"/> <xi:include href="erl_tracer.xml"/> <xi:include href="erts_alloc.xml"/> - <xi:include href="escript.xml"/> + <xi:include href="escript_cmd.xml"/> <xi:include href="init.xml"/> <xi:include href="persistent_term.xml"/> - <xi:include href="run_erl.xml"/> + <xi:include href="run_erl_cmd.xml"/> %ESOCK_USE_SOCKET_XML% - <xi:include href="start.xml"/> - <xi:include href="start_erl.xml"/> - <xi:include href="werl.xml"/> + <xi:include href="start_cmd.xml"/> + <xi:include href="start_erl_cmd.xml"/> + <xi:include href="werl_cmd.xml"/> <xi:include href="zlib.xml"/> </application> diff --git a/erts/doc/src/run_erl.xml b/erts/doc/src/run_erl_cmd.xml index fa36457489..9f1984f784 100644 --- a/erts/doc/src/run_erl.xml +++ b/erts/doc/src/run_erl_cmd.xml @@ -11,7 +11,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - + http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software @@ -19,7 +19,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. - + </legalnotice> <title>run_erl</title> @@ -213,4 +213,3 @@ <seealso marker="start_erl"><c>start_erl(1)</c></seealso></p> </section> </comref> - diff --git a/erts/doc/src/start.xml b/erts/doc/src/start_cmd.xml index 6eac47fe94..9f208d43bb 100644 --- a/erts/doc/src/start.xml +++ b/erts/doc/src/start_cmd.xml @@ -11,7 +11,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - + http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software @@ -19,7 +19,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. - + </legalnotice> <title>start</title> @@ -70,4 +70,3 @@ <seealso marker="start_erl"><c>start_erl(1)</c></seealso></p> </section> </comref> - diff --git a/erts/doc/src/start_erl.xml b/erts/doc/src/start_erl_cmd.xml index 4887d4606e..e9cb248da4 100644 --- a/erts/doc/src/start_erl.xml +++ b/erts/doc/src/start_erl_cmd.xml @@ -11,7 +11,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - + http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software @@ -19,7 +19,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. - + </legalnotice> <title>start_erl</title> @@ -89,7 +89,7 @@ only option <c>-rootdir</c> is specified, the directory is assumed to be <Erlang root>\\releases.</p> </item> - <tag><c>-rootdir <Erlang root directory></c></tag> + <tag><c>-rootdir <Erlang root directory></c></tag> <item> <p>Mandatory if <c>-reldir</c> is not specified and no <c><![CDATA[RELDIR]]></c> exists in the environment. This @@ -166,4 +166,3 @@ <c>release_handler(3)</c></seealso></p> </section> </comref> - diff --git a/erts/doc/src/werl.xml b/erts/doc/src/werl_cmd.xml index 792fe204e8..4f25565c64 100644 --- a/erts/doc/src/werl.xml +++ b/erts/doc/src/werl_cmd.xml @@ -11,7 +11,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - + http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software @@ -19,7 +19,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. - + </legalnotice> <title>werl</title> @@ -62,7 +62,7 @@ <p>In cases where you want to redirect standard input and/or standard output or use Erlang in a pipeline, <c>werl</c> is not suitable, and the <c>erl</c> program is to be used instead.</p> - + <p>The <c>werl</c> window is in many ways modeled after the <c>xterm</c> window present on other platforms, as the <c>xterm</c> model fits well with line-oriented command-based interaction. This @@ -102,7 +102,7 @@ use <c>Ctrl-P</c>.</p> </item> </list> - + <p>A drop-down box in the toolbar contains the command history. Selecting a command in the drop-down box inserts the command at the prompt, as if you used the keyboard to retrieve the @@ -115,4 +115,3 @@ </list> </description> </comref> - |