Skip to content

Commit

Permalink
Update build of Corba documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
lthor committed May 22, 2018
1 parent e89cc19 commit c4ab873
Show file tree
Hide file tree
Showing 8 changed files with 227 additions and 13 deletions.
21 changes: 21 additions & 0 deletions COPYRIGHT
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
This software is subject to the following Copyrights and Licenses:

---------------------------------------------------------------------------

%CopyrightBegin%

Copyright Ericsson AB 1997-2018. 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%
5 changes: 3 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#
# %CopyrightBegin%
#
# Copyright Ericsson AB 1997-2016. All Rights Reserved.
# Copyright Ericsson AB 1997-2018. 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.
Expand All @@ -27,7 +27,8 @@ include $(ERL_TOP)/make/$(TARGET)/otp.mk

SUB_DIRECTORIES = lib/orber lib/ic lib/cosEvent \
lib/cosTime lib/cosNotification lib/cosEventDomain \
lib/cosProperty lib/cosFileTransfer lib/cosTransactions
lib/cosProperty lib/cosFileTransfer lib/cosTransactions \
doc

SPECIAL_TARGETS =

Expand Down
113 changes: 113 additions & 0 deletions doc/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
#
# %CopyrightBegin%
#
# Copyright Ericsson AB 1997-2017. 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%
#
#
include $(ERL_TOP)/make/target.mk
include $(ERL_TOP)/make/$(TARGET)/otp.mk

CORBA_TOP=..

# ----------------------------------------------------
# Application version
# ----------------------------------------------------
include $(CORBA_TOP)/vsn.mk
VSN=$(CORBA_VSN)
#APPLICATION=

# ----------------------------------------------------
# Release directory specification
# ----------------------------------------------------
RELDOC_DIR = "$(RELEASE_PATH)/doc"

# ----------------------------------------------------
# Target Specs
# ----------------------------------------------------
INFO_FILES = ../README.md ../COPYRIGHT

TOPDOCDIR=.

# ----------------------------------------------------

INDEX_FILE = index.html

CSS_PATH=$(ERL_TOP)/lib/erl_docgen/priv/css

CSS_FILES= \
$(CSS_PATH)/otp_doc.css \
$(CSS_PATH)/highlight.css

JS_PATH=$(ERL_TOP)/lib/erl_docgen/priv/js

HIGHLIGHT_FILES= \
$(JS_PATH)/highlight.js \
$(JS_PATH)/highlight.pack.js

FLIPMENU_FILES= \
$(JS_PATH)/flipmenu/flipmenu.js \
$(JS_PATH)/flipmenu/flip_closed.gif \
$(JS_PATH)/flipmenu/flip_open.gif \
$(JS_PATH)/flipmenu/flip_static.gif


IMAGE_FILES=$(ERL_TOP)/lib/erl_docgen/priv/images/erlang-logo.png
# ----------------------------------------------------
# FLAGS
# ----------------------------------------------------
XML_FLAGS +=
DVIPS_FLAGS +=

# ----------------------------------------------------
# Targets
# ----------------------------------------------------
$(HTMLDIR)/%.gif: %.gif
$(INSTALL_DATA) $< $@

docs: pdf html man

pdf:

html: gifs $(INDEX_FILE)

$(INDEX_FILE): $(INDEX_FILE).src
$(vsn_verbose)sed 's/#corba_base_vsn#/$(VSN)/g' $< > $@

clean clean_docs:
$(RM) $(INDEX_FILE)
man:

gifs:

debug opt:

# ----------------------------------------------------
# Release Target
# ----------------------------------------------------
include $(ERL_TOP)/make/otp_release_targets.mk

release_docs_spec: docs
$(INSTALL_DIR) "$(RELDOC_DIR)"
$(INSTALL_DATA) $(INDEX_FILE) "$(RELDOC_DIR)"
$(INSTALL_DATA) $(IMAGE_FILES) "$(RELDOC_DIR)"
$(INSTALL_DATA) $(CSS_FILES) "$(RELDOC_DIR)"
$(INSTALL_DIR) "$(RELDOC_DIR)/js/flipmenu"
$(INSTALL_DATA) $(HIGHLIGHT_FILES) "$(RELDOC_DIR)/js"
$(INSTALL_DATA) $(FLIPMENU_FILES) "$(RELDOC_DIR)/js/flipmenu"
$(INSTALL_DATA) $(INFO_FILES) "$(RELEASE_PATH)"

release_spec:
82 changes: 82 additions & 0 deletions doc/index.html.src
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!--
%CopyrightBegin%

Copyright Ericsson AB 2009-2018. 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%
-->

<html>
<head>
<link rel="stylesheet" href="otp_doc.css" type="text/css"/>
<title>CORBA #corba_base_vsn#</title>

<script id="js" type="text/javascript" language="JavaScript" src="js/flipmenu/flipmenu.js">

</script>
</head>

<body>

<div id="container">
<div id="leftnav">
<div class="innertube">
<div class="erlang-logo-wrapper">
<img alt="Erlang logo" src="erlang-logo.png" class="erlang-logo"/ >
</div>

<ul class="expand-collapse-items">
<li><a href="javascript:openAllFlips()">Expand All</a></li>
<li><a href="javascript:closeAllFlips()">Contract All</a></li>
</ul>


<h3>Applications</h3>

<ul class="flipMenu">
<li><a href="../lib/cosEvent-#corba_base_vsn#/doc/html/index.html">cosEvent</a></li>
<li><a href="../lib/cosEventDomain-#corba_base_vsn#/doc/html/index.html">cosEventDomain</a></li>
<li><a href="../lib/cosFileTransfer-#corba_base_vsn#/doc/html/index.html">cosFileTransfer</a></li>
<li><a href="../lib/cosNotification-#corba_base_vsn#/doc/html/index.html">cosNotification</a></li>
<li><a href="../lib/cosProperty-#corba_base_vsn#/doc/html/index.html">cosProperty</a></li>
<li><a href="../lib/cosTime-#corba_base_vsn#/doc/html/index.html">cosTime</a></li>
<li><a href="../lib/cosTransactions-#corba_base_vsn#/doc/html/index.html">cosTransactions</a></li>
<li><a href="../lib/ic-#corba_base_vsn#/doc/html/index.html">ic</a></li>
<li><a href="../lib/orber-#corba_base_vsn#/doc/html/index.html">orber</a></li>
</ul>

</div>
</div>


<div id="content">
<div class="innertube">
<h1 class="main-title">CORBA #corba_base_vsn#</h1>
<p class="main-description">
Welcome to Erlang CORBA Applications
</p>

<center>
<small>
Copyright &copy; 1999-2018
<a href="http://www.ericsson.com">Ericsson AB</a>
</small>
</center>
</div>
</div>
</div>
</body>
</html>
3 changes: 0 additions & 3 deletions lib/cosNotification/doc/src/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -146,9 +146,6 @@ man: $(MAN3_FILES)

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

$(INDEX_TARGET): $(INDEX_SRC)
sed -e 's;%VSN%;$(VSN);' $(INDEX_SRC) > $(INDEX_TARGET)

debug opt:

# ----------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion lib/orber/doc/src/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ CORBA_TOP=../../../..
# Application version
# ----------------------------------------------------
include $(CORBA_TOP)/vsn.mk
VSN=$(ORBER_VSN)
VSN=$(CORBA_VSN)
APPLICATION=orber

# ----------------------------------------------------
Expand Down
8 changes: 4 additions & 4 deletions lib/orber/doc/src/ch_install.xml
Original file line number Diff line number Diff line change
Expand Up @@ -397,13 +397,13 @@ nodeB@hostB> orber:start().
<row>
<cell align="left" valign="middle">ssl_server_options</cell>
<cell align="left" valign="middle">list()</cell>
<cell align="left" valign="middle">See the <seealso marker="ssl:ssl">SSL application</seealso>
<cell align="left" valign="middle">See the <url href="http://erlang.org/doc/man/ssl.html">SSL application</url>
for valid options.</cell>
</row>
<row>
<cell align="left" valign="middle">ssl_client_options</cell>
<cell align="left" valign="middle">list()</cell>
<cell align="left" valign="middle">See the <seealso marker="ssl:ssl">SSL application</seealso>
<cell align="left" valign="middle">See the <url href="http://erlang.org/doc/man/ssl.html">SSL application</url>
for valid options.</cell>
</row>
<row>
Expand Down Expand Up @@ -635,14 +635,14 @@ nodeB@hostB> orber:start().
<item>A list of the SSL options when Orber is the server.
In general it's just to remove the 'ssl_server_' prefix from the old options,
i.e. <c>ssl_server_verify</c> will just be <c>verify</c> in this option list.
See the <seealso marker="ssl:ssl">SSL application</seealso> for the correct list of possible
See the <url href="http://erlang.org/doc/man/ssl.html">SSL application</url> for the correct list of possible
options and their values.
</item>
<tag><em>ssl_client_options</em></tag>
<item>A list of the SSL options when Orber is the client.
In general it's just to remove the <c>ssl_client_</c> prefix from the old options,
i.e. <c>ssl_client_depth</c> will just be <c>depth</c> in this option list.
See the <seealso marker="ssl:ssl">SSL application</seealso> for the correct list of possible
See the <url href="http://erlang.org/doc/man/ssl.html">SSL application</url> for the correct list of possible
options and their values.
</item>
<tag><em>iiop_ssl_out_keepalive</em></tag>
Expand Down
6 changes: 3 additions & 3 deletions lib/orber/doc/src/ch_security.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<chapter>
<header>
<copyright>
<year>1999</year><year>2016</year>
<year>1999</year><year>2018</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
Expand Down Expand Up @@ -59,7 +59,7 @@
<p>There is a variable to conficure Orber's SSL behavior on the server side.</p>
<list type="bulleted">
<item><em>ssl_server_options</em> - which is a list of options to ssl.
See the <seealso marker="ssl:ssl">SSL</seealso> application for further
See the <url href="http://erlang.org/doc/man/ssl.html">SSL</url> application for further
descriptions on these options.</item>
</list>
<p>There also exist an API function for accessing the value of this variable:</p>
Expand All @@ -77,7 +77,7 @@
per client process.</p>
<list type="bulleted">
<item><em>ssl_client_options</em> - which is a list of options to ssl.
See the <seealso marker="ssl:ssl">SSL</seealso> application for further
See the <url href="http://erlang.org/doc/man/ssl.html">SSL</url> application for further
descriptions on these options.</item>
</list>
<p>There also exist two API functions for accessing and changing the values of this
Expand Down

0 comments on commit c4ab873

Please sign in to comment.