Skip to content

Commit

Permalink
Merge branch 'anders/diameter/SoC/OTP-10688'
Browse files Browse the repository at this point in the history
* anders/diameter/SoC/OTP-10688:
  Add RFC 6733 commentary to SoC chapter
  Add RFC 6737 Capabilities Update dictionary
  Remove cruft from doc Makefile
  • Loading branch information
Anders Svensson committed Feb 23, 2013
2 parents e23e5d9 + acb318e commit df465d7
Show file tree
Hide file tree
Showing 7 changed files with 8,762 additions and 50 deletions.
51 changes: 9 additions & 42 deletions lib/diameter/doc/src/Makefile
@@ -1,7 +1,7 @@
#
# %CopyrightBegin%
#
# Copyright Ericsson AB 2010-2012. All Rights Reserved.
# Copyright Ericsson AB 2010-2013. 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
Expand Down Expand Up @@ -35,45 +35,17 @@ XML_REF_FILES = $(XML_REF1_FILES) $(XML_REF3_FILES) $(XML_REF4_FILES)
XML_FILES = $(BOOK_FILES) $(XML_APPLICATION_FILES) \
$(XML_REF_FILES) \
$(XML_PART_FILES) $(XML_CHAPTER_FILES) \
seealso.ent

INTERNAL_HTML_FILES = $(TECHNICAL_DESCR_FILES:%.xml=$(HTMLDIR)/%.html)

HTML_APP_FILES = $(XML_APPLICATION_FILES:%.xml=$(HTMLDIR)/%.html)
HTML_EXTRA_FILES = $(XML_EXTRA_FILES:%.xml=$(HTMLDIR)/%.html)
HTML_PART_FILES = $(XML_PART_FILES:%.xml=$(HTMLDIR)/%.html)

HTML_FILES = $(HTML_APP_FILES) $(HTML_EXTRA_FILES) $(HTML_PART_FILES)
$(XML_EXTRA_FILES)

INFO_FILE = ../../info

HTML_REF_FILES = $(XML_REF_FILES:%.xml=$(HTMLDIR)/%.html)

HTML_CHAPTER_FILES = $(XML_CHAPTER_FILES:%.xml=$(HTMLDIR)/%.html)

EXTRA_FILES = \
$(DEFAULT_GIF_FILES) \
$(DEFAULT_HTML_FILES) \
$(HTML_REF_FILES) \
$(HTML_CHAPTER_FILES)

MAN1_FILES = $(XML_REF1_FILES:%.xml=$(MAN1DIR)/%.1)
MAN3_FILES = $(XML_REF3_FILES:%.xml=$(MAN3DIR)/%.3)
MAN4_FILES = $(XML_REF4_FILES:%.xml=$(MAN4DIR)/%.4)

HTML_REF_MAN_FILE = $(HTMLDIR)/index.html

TOP_PDF_FILE = $(PDFDIR)/$(APPLICATION)-$(VSN).pdf
PDF_FILE = $(PDFDIR)/$(APPLICATION)-$(VSN).pdf

STANDARD_DIR = ../standard
STANDARDS =

# ----------------------------------------------------
# FLAGS
# ----------------------------------------------------

XML_FLAGS +=
DVIPS_FLAGS +=

# ----------------------------------------------------
# Targets
Expand All @@ -86,11 +58,11 @@ docs: pdf html man

ldocs: local_docs $(INDEX_TARGET)

$(TOP_PDF_FILE): $(XML_FILES)
$(PDF_FILE): $(XML_FILES)

pdf: $(TOP_PDF_FILE)
pdf: $(PDF_FILE)

html: gifs $(HTML_REF_MAN_FILE)
html: gifs $(HTMLDIR)/index.html

clean clean_docs: clean_pdf clean_html clean_man
rm -f errs core *~
Expand Down Expand Up @@ -120,7 +92,6 @@ depend: depend.mk
debug opt:

info:
@echo "->Makefile<-"
@echo ""
@echo "INDEX_FILE = $(INDEX_FILE)"
@echo "INDEX_SRC = $(INDEX_SRC)"
Expand All @@ -139,13 +110,9 @@ info:
@echo "MAN3_FILES = $(MAN3_FILES)"
@echo "MAN4_FILES = $(MAN4_FILES)"
@echo ""
@echo "HTML_FILES = $(HTML_FILES)"
@echo "TOP_HTML_FILES = $(TOP_HTML_FILES)"
@echo ""
@echo "DEFAULT_HTML_FILES = $(DEFAULT_HTML_FILES)"
@echo "DEFAULT_GIF_FILES = $(DEFAULT_GIF_FILES)"
@echo ""
@echo ""


# ----------------------------------------------------
Expand All @@ -160,7 +127,7 @@ release_docs_spec: $(LOCAL)docs
$(INSTALL_DIR) "$(RELEASE_PATH)/man/man1"
$(INSTALL_DIR) "$(RELEASE_PATH)/man/man3"
$(INSTALL_DIR) "$(RELEASE_PATH)/man/man4"
$(INSTALL_DATA) $(TOP_PDF_FILE) "$(RELSYSDIR)/doc/pdf"
$(INSTALL_DATA) $(PDF_FILE) "$(RELSYSDIR)/doc/pdf"
$(INSTALL_DATA) $(HTMLDIR)/*.* "$(RELSYSDIR)/doc/html"
$(INSTALL_DATA) $(INFO_FILE) "$(RELSYSDIR)"
$(INSTALL_DATA) $(MAN1_FILES) "$(RELEASE_PATH)/man/man1"
Expand All @@ -173,8 +140,8 @@ release_spec:

depend.mk: depend.sed Makefile seealso.ent \
$(XML_REF_FILES) $(XML_CHAPTER_FILES)
$(gen_verbose)sed -f seehere.sed seealso.ent > seehere.ent
$(V_at)(for f in $(XML_REF_FILES) $(XML_CHAPTER_FILES); do \
sed -f seehere.sed seealso.ent > seehere.ent
(for f in $(XML_REF_FILES) $(XML_CHAPTER_FILES); do \
sed -f $< $$f | sed "s@%FILE%@`basename $$f .xml`@g"; \
done) \
> $@
Expand Down
6 changes: 4 additions & 2 deletions lib/diameter/doc/src/diameter_soc.xml
Expand Up @@ -4,12 +4,12 @@
%also;
]>

<chapter>
<chapter xmlns:xi="http://www.w3.org/2001/XInclude">

<header>
<copyright>
<year>2011</year>
<year>2012</year>
<year>2013</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>

Expand Down Expand Up @@ -80,6 +80,8 @@ just be unnecessary configuration of a value that it has no control over.</p>

</list>

<xi:include href="diameter_soc_rfc6733.xml"/>

</section>

<!-- ===================================================================== -->
Expand Down

0 comments on commit df465d7

Please sign in to comment.