aboutsummaryrefslogtreecommitdiffstats
path: root/lib/kernel/doc
diff options
context:
space:
mode:
authorLukas Larsson <[email protected]>2013-09-30 15:07:49 +0200
committerLukas Larsson <[email protected]>2014-02-24 15:15:58 +0100
commitfa3dd14716b2a7ad0c223ebacd2ffc6ecf6437e6 (patch)
tree9e01ad087ca43085f2b7efb80bf5f203d27124eb /lib/kernel/doc
parent8ed59e4a9dddf083d2046e1bd58f397221928c0e (diff)
downloadotp-fa3dd14716b2a7ad0c223ebacd2ffc6ecf6437e6.tar.gz
otp-fa3dd14716b2a7ad0c223ebacd2ffc6ecf6437e6.tar.bz2
otp-fa3dd14716b2a7ad0c223ebacd2ffc6ecf6437e6.zip
ose: Add module that allows interaction with any OSE process
The interface of this module is made to be as generic as possible in order for other IPC mechanisms to mimic it and allow porting of code between different os:es.
Diffstat (limited to 'lib/kernel/doc')
-rw-r--r--lib/kernel/doc/src/Makefile27
-rw-r--r--lib/kernel/doc/src/ref_man.xml.src (renamed from lib/kernel/doc/src/ref_man.xml)5
2 files changed, 26 insertions, 6 deletions
diff --git a/lib/kernel/doc/src/Makefile b/lib/kernel/doc/src/Makefile
index de3ca1e176..7f8023aba4 100644
--- a/lib/kernel/doc/src/Makefile
+++ b/lib/kernel/doc/src/Makefile
@@ -32,6 +32,12 @@ APPLICATION=kernel
RELSYSDIR = $(RELEASE_PATH)/lib/$(APPLICATION)-$(VSN)
# ----------------------------------------------------
+# Help application directory specification
+# ----------------------------------------------------
+EDOC_DIR = $(ERL_TOP)/lib/edoc
+SYNTAX_TOOLS_DIR = $(ERL_TOP)/lib/syntax_tools
+
+# ----------------------------------------------------
# Target Specs
# ----------------------------------------------------
XML_APPLICATION_FILES = ref_man.xml
@@ -65,6 +71,12 @@ XML_REF3_FILES = application.xml \
user.xml \
zlib_stub.xml
+ifeq ($(findstring ose,$(TARGET)),ose)
+XML_EDOC_FILES = ose.xml
+else
+XML_EDOC_FILES =
+endif
+
XML_REF4_FILES = app.xml config.xml
XML_REF6_FILES = kernel_app.xml
@@ -76,8 +88,8 @@ BOOK_FILES = book.xml
XML_FILES = \
$(BOOK_FILES) $(XML_CHAPTER_FILES) \
- $(XML_PART_FILES) $(XML_REF3_FILES) $(XML_REF4_FILES) \
- $(XML_REF6_FILES) $(XML_APPLICATION_FILES)
+ $(XML_PART_FILES) $(XML_REF3_FILES) $(XML_EDOC_FILES)\
+ $(XML_REF4_FILES) $(XML_REF6_FILES) $(XML_APPLICATION_FILES)
# ----------------------------------------------------
@@ -103,7 +115,7 @@ TOP_SPECS_FILE = specs.xml
# ----------------------------------------------------
XML_FLAGS +=
-SPECS_ESRC = ../../src
+SRC_DIR = ../../src
SPECS_FLAGS = -I../../include
@@ -148,6 +160,15 @@ $(SPECDIR)/specs_zlib_stub.xml:
escript $(SPECS_EXTRACTOR) $(SPECS_FLAGS) \
-o$(dir $@) -module zlib_stub
+ose.xml: $(SRC_DIR)/ose.erl
+ escript $(DOCGEN)/priv/bin/xml_from_edoc.escript $(SRC_DIR)/$(@:%.xml=%.erl)
+ref_man.xml: ref_man.xml.src
+ifeq ($(findstring ose,$(TARGET)),ose)
+ sed -e 's:\(os.xml"/>\):\1\n<xi\:include href="ose.xml"/>:' $< > $@
+else
+ cp $< $@
+endif
+
# ----------------------------------------------------
# Release Target
# ----------------------------------------------------
diff --git a/lib/kernel/doc/src/ref_man.xml b/lib/kernel/doc/src/ref_man.xml.src
index c1b9eac9d7..bd25d1e78d 100644
--- a/lib/kernel/doc/src/ref_man.xml
+++ b/lib/kernel/doc/src/ref_man.xml.src
@@ -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>Kernel Reference Manual</title>
@@ -65,4 +65,3 @@
<xi:include href="app.xml"/>
<xi:include href="config.xml"/>
</application>
-