Skip to content

Commit c4ab873

Browse files
lthorlthor
committed
Update build of Corba documentation
1 parent e89cc19 commit c4ab873

File tree

8 files changed

+227
-13
lines changed

8 files changed

+227
-13
lines changed

‎COPYRIGHT

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
This software is subject to the following Copyrights and Licenses:
2+
3+
---------------------------------------------------------------------------
4+
5+
%CopyrightBegin%
6+
7+
Copyright Ericsson AB 1997-2018. All Rights Reserved.
8+
9+
Licensed under the Apache License, Version 2.0 (the "License");
10+
you may not use this file except in compliance with the License.
11+
You may obtain a copy of the License at
12+
13+
http://www.apache.org/licenses/LICENSE-2.0
14+
15+
Unless required by applicable law or agreed to in writing, software
16+
distributed under the License is distributed on an "AS IS" BASIS,
17+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18+
See the License for the specific language governing permissions and
19+
limitations under the License.
20+
21+
%CopyrightEnd%

‎Makefile

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#
22
# %CopyrightBegin%
33
#
4-
# Copyright Ericsson AB 1997-2016. All Rights Reserved.
4+
# Copyright Ericsson AB 1997-2018. All Rights Reserved.
55
#
66
# Licensed under the Apache License, Version 2.0 (the "License");
77
# you may not use this file except in compliance with the License.
@@ -27,7 +27,8 @@ include $(ERL_TOP)/make/$(TARGET)/otp.mk
2727

2828
SUB_DIRECTORIES = lib/orber lib/ic lib/cosEvent \
2929
lib/cosTime lib/cosNotification lib/cosEventDomain \
30-
lib/cosProperty lib/cosFileTransfer lib/cosTransactions
30+
lib/cosProperty lib/cosFileTransfer lib/cosTransactions \
31+
doc
3132

3233
SPECIAL_TARGETS =
3334

‎doc/Makefile

+113
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
#
2+
# %CopyrightBegin%
3+
#
4+
# Copyright Ericsson AB 1997-2017. All Rights Reserved.
5+
#
6+
# Licensed under the Apache License, Version 2.0 (the "License");
7+
# you may not use this file except in compliance with the License.
8+
# You may obtain a copy of the License at
9+
#
10+
# http://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
#
18+
# %CopyrightEnd%
19+
#
20+
#
21+
include $(ERL_TOP)/make/target.mk
22+
include $(ERL_TOP)/make/$(TARGET)/otp.mk
23+
24+
CORBA_TOP=..
25+
26+
# ----------------------------------------------------
27+
# Application version
28+
# ----------------------------------------------------
29+
include $(CORBA_TOP)/vsn.mk
30+
VSN=$(CORBA_VSN)
31+
#APPLICATION=
32+
33+
# ----------------------------------------------------
34+
# Release directory specification
35+
# ----------------------------------------------------
36+
RELDOC_DIR = "$(RELEASE_PATH)/doc"
37+
38+
# ----------------------------------------------------
39+
# Target Specs
40+
# ----------------------------------------------------
41+
INFO_FILES = ../README.md ../COPYRIGHT
42+
43+
TOPDOCDIR=.
44+
45+
# ----------------------------------------------------
46+
47+
INDEX_FILE = index.html
48+
49+
CSS_PATH=$(ERL_TOP)/lib/erl_docgen/priv/css
50+
51+
CSS_FILES= \
52+
$(CSS_PATH)/otp_doc.css \
53+
$(CSS_PATH)/highlight.css
54+
55+
JS_PATH=$(ERL_TOP)/lib/erl_docgen/priv/js
56+
57+
HIGHLIGHT_FILES= \
58+
$(JS_PATH)/highlight.js \
59+
$(JS_PATH)/highlight.pack.js
60+
61+
FLIPMENU_FILES= \
62+
$(JS_PATH)/flipmenu/flipmenu.js \
63+
$(JS_PATH)/flipmenu/flip_closed.gif \
64+
$(JS_PATH)/flipmenu/flip_open.gif \
65+
$(JS_PATH)/flipmenu/flip_static.gif
66+
67+
68+
IMAGE_FILES=$(ERL_TOP)/lib/erl_docgen/priv/images/erlang-logo.png
69+
# ----------------------------------------------------
70+
# FLAGS
71+
# ----------------------------------------------------
72+
XML_FLAGS +=
73+
DVIPS_FLAGS +=
74+
75+
# ----------------------------------------------------
76+
# Targets
77+
# ----------------------------------------------------
78+
$(HTMLDIR)/%.gif: %.gif
79+
$(INSTALL_DATA) $< $@
80+
81+
docs: pdf html man
82+
83+
pdf:
84+
85+
html: gifs $(INDEX_FILE)
86+
87+
$(INDEX_FILE): $(INDEX_FILE).src
88+
$(vsn_verbose)sed 's/#corba_base_vsn#/$(VSN)/g' $< > $@
89+
90+
clean clean_docs:
91+
$(RM) $(INDEX_FILE)
92+
man:
93+
94+
gifs:
95+
96+
debug opt:
97+
98+
# ----------------------------------------------------
99+
# Release Target
100+
# ----------------------------------------------------
101+
include $(ERL_TOP)/make/otp_release_targets.mk
102+
103+
release_docs_spec: docs
104+
$(INSTALL_DIR) "$(RELDOC_DIR)"
105+
$(INSTALL_DATA) $(INDEX_FILE) "$(RELDOC_DIR)"
106+
$(INSTALL_DATA) $(IMAGE_FILES) "$(RELDOC_DIR)"
107+
$(INSTALL_DATA) $(CSS_FILES) "$(RELDOC_DIR)"
108+
$(INSTALL_DIR) "$(RELDOC_DIR)/js/flipmenu"
109+
$(INSTALL_DATA) $(HIGHLIGHT_FILES) "$(RELDOC_DIR)/js"
110+
$(INSTALL_DATA) $(FLIPMENU_FILES) "$(RELDOC_DIR)/js/flipmenu"
111+
$(INSTALL_DATA) $(INFO_FILES) "$(RELEASE_PATH)"
112+
113+
release_spec:

‎doc/index.html.src

+82
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2+
<!--
3+
%CopyrightBegin%
4+
5+
Copyright Ericsson AB 2009-2018. All Rights Reserved.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
%CopyrightEnd%
20+
-->
21+
22+
<html>
23+
<head>
24+
<link rel="stylesheet" href="otp_doc.css" type="text/css"/>
25+
<title>CORBA #corba_base_vsn#</title>
26+
27+
<script id="js" type="text/javascript" language="JavaScript" src="js/flipmenu/flipmenu.js">
28+
29+
</script>
30+
</head>
31+
32+
<body>
33+
34+
<div id="container">
35+
<div id="leftnav">
36+
<div class="innertube">
37+
<div class="erlang-logo-wrapper">
38+
<img alt="Erlang logo" src="erlang-logo.png" class="erlang-logo"/ >
39+
</div>
40+
41+
<ul class="expand-collapse-items">
42+
<li><a href="javascript:openAllFlips()">Expand All</a></li>
43+
<li><a href="javascript:closeAllFlips()">Contract All</a></li>
44+
</ul>
45+
46+
47+
<h3>Applications</h3>
48+
49+
<ul class="flipMenu">
50+
<li><a href="../lib/cosEvent-#corba_base_vsn#/doc/html/index.html">cosEvent</a></li>
51+
<li><a href="../lib/cosEventDomain-#corba_base_vsn#/doc/html/index.html">cosEventDomain</a></li>
52+
<li><a href="../lib/cosFileTransfer-#corba_base_vsn#/doc/html/index.html">cosFileTransfer</a></li>
53+
<li><a href="../lib/cosNotification-#corba_base_vsn#/doc/html/index.html">cosNotification</a></li>
54+
<li><a href="../lib/cosProperty-#corba_base_vsn#/doc/html/index.html">cosProperty</a></li>
55+
<li><a href="../lib/cosTime-#corba_base_vsn#/doc/html/index.html">cosTime</a></li>
56+
<li><a href="../lib/cosTransactions-#corba_base_vsn#/doc/html/index.html">cosTransactions</a></li>
57+
<li><a href="../lib/ic-#corba_base_vsn#/doc/html/index.html">ic</a></li>
58+
<li><a href="../lib/orber-#corba_base_vsn#/doc/html/index.html">orber</a></li>
59+
</ul>
60+
61+
</div>
62+
</div>
63+
64+
65+
<div id="content">
66+
<div class="innertube">
67+
<h1 class="main-title">CORBA #corba_base_vsn#</h1>
68+
<p class="main-description">
69+
Welcome to Erlang CORBA Applications
70+
</p>
71+
72+
<center>
73+
<small>
74+
Copyright &copy; 1999-2018
75+
<a href="http://www.ericsson.com">Ericsson AB</a>
76+
</small>
77+
</center>
78+
</div>
79+
</div>
80+
</div>
81+
</body>
82+
</html>

‎lib/cosNotification/doc/src/Makefile

-3
Original file line numberDiff line numberDiff line change
@@ -146,9 +146,6 @@ man: $(MAN3_FILES)
146146

147147
gifs: $(GIF_FILES:%=$(HTMLDIR)/%)
148148

149-
$(INDEX_TARGET): $(INDEX_SRC)
150-
sed -e 's;%VSN%;$(VSN);' $(INDEX_SRC) > $(INDEX_TARGET)
151-
152149
debug opt:
153150

154151
# ----------------------------------------------------

‎lib/orber/doc/src/Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ CORBA_TOP=../../../..
2727
# Application version
2828
# ----------------------------------------------------
2929
include $(CORBA_TOP)/vsn.mk
30-
VSN=$(ORBER_VSN)
30+
VSN=$(CORBA_VSN)
3131
APPLICATION=orber
3232

3333
# ----------------------------------------------------

‎lib/orber/doc/src/ch_install.xml

+4-4
Original file line numberDiff line numberDiff line change
@@ -397,13 +397,13 @@ nodeB@hostB> orber:start().
397397
<row>
398398
<cell align="left" valign="middle">ssl_server_options</cell>
399399
<cell align="left" valign="middle">list()</cell>
400-
<cell align="left" valign="middle">See the <seealso marker="ssl:ssl">SSL application</seealso>
400+
<cell align="left" valign="middle">See the <url href="http://erlang.org/doc/man/ssl.html">SSL application</url>
401401
for valid options.</cell>
402402
</row>
403403
<row>
404404
<cell align="left" valign="middle">ssl_client_options</cell>
405405
<cell align="left" valign="middle">list()</cell>
406-
<cell align="left" valign="middle">See the <seealso marker="ssl:ssl">SSL application</seealso>
406+
<cell align="left" valign="middle">See the <url href="http://erlang.org/doc/man/ssl.html">SSL application</url>
407407
for valid options.</cell>
408408
</row>
409409
<row>
@@ -635,14 +635,14 @@ nodeB@hostB> orber:start().
635635
<item>A list of the SSL options when Orber is the server.
636636
In general it's just to remove the 'ssl_server_' prefix from the old options,
637637
i.e. <c>ssl_server_verify</c> will just be <c>verify</c> in this option list.
638-
See the <seealso marker="ssl:ssl">SSL application</seealso> for the correct list of possible
638+
See the <url href="http://erlang.org/doc/man/ssl.html">SSL application</url> for the correct list of possible
639639
options and their values.
640640
</item>
641641
<tag><em>ssl_client_options</em></tag>
642642
<item>A list of the SSL options when Orber is the client.
643643
In general it's just to remove the <c>ssl_client_</c> prefix from the old options,
644644
i.e. <c>ssl_client_depth</c> will just be <c>depth</c> in this option list.
645-
See the <seealso marker="ssl:ssl">SSL application</seealso> for the correct list of possible
645+
See the <url href="http://erlang.org/doc/man/ssl.html">SSL application</url> for the correct list of possible
646646
options and their values.
647647
</item>
648648
<tag><em>iiop_ssl_out_keepalive</em></tag>

‎lib/orber/doc/src/ch_security.xml

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<chapter>
55
<header>
66
<copyright>
7-
<year>1999</year><year>2016</year>
7+
<year>1999</year><year>2018</year>
88
<holder>Ericsson AB. All Rights Reserved.</holder>
99
</copyright>
1010
<legalnotice>
@@ -59,7 +59,7 @@
5959
<p>There is a variable to conficure Orber's SSL behavior on the server side.</p>
6060
<list type="bulleted">
6161
<item><em>ssl_server_options</em> - which is a list of options to ssl.
62-
See the <seealso marker="ssl:ssl">SSL</seealso> application for further
62+
See the <url href="http://erlang.org/doc/man/ssl.html">SSL</url> application for further
6363
descriptions on these options.</item>
6464
</list>
6565
<p>There also exist an API function for accessing the value of this variable:</p>
@@ -77,7 +77,7 @@
7777
per client process.</p>
7878
<list type="bulleted">
7979
<item><em>ssl_client_options</em> - which is a list of options to ssl.
80-
See the <seealso marker="ssl:ssl">SSL</seealso> application for further
80+
See the <url href="http://erlang.org/doc/man/ssl.html">SSL</url> application for further
8181
descriptions on these options.</item>
8282
</list>
8383
<p>There also exist two API functions for accessing and changing the values of this

0 commit comments

Comments
 (0)