File 0635-edoc-Fix-doc-links.patch of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 0635-edoc-Fix-doc-links.patch of Package erlang

From 8eaa16b8718499be9298d855fdd3fde8f060823f Mon Sep 17 00:00:00 2001
From: Hans Bolinder <hasse@erlang.org>
Date: Tue, 9 Apr 2019 10:17:18 +0200
Subject: [PATCH 2/2] edoc: Fix doc links

Links that used to work for 'make edocs' only, now work for 'make
release_docs' and on erlang.org as well.
---
 lib/edoc/doc/edoc.dtd            | 1 +
 lib/edoc/doc/edoc_doclet.hrl     | 1 +
 lib/edoc/doc/src/Makefile        | 6 ++++++
 lib/edoc/include/edoc_doclet.hrl | 2 +-
 lib/edoc/src/edoc.erl            | 2 +-
 lib/edoc/src/edoc_doclet.erl     | 2 +-
 6 files changed, 11 insertions(+), 3 deletions(-)
 create mode 120000 lib/edoc/doc/edoc.dtd
 create mode 120000 lib/edoc/doc/edoc_doclet.hrl

diff --git a/lib/edoc/doc/edoc.dtd b/lib/edoc/doc/edoc.dtd
new file mode 120000
index 0000000000..43f4b27db6
--- /dev/null
+++ b/lib/edoc/doc/edoc.dtd
@@ -0,0 +1 @@
+../priv/edoc.dtd
\ No newline at end of file
diff --git a/lib/edoc/doc/edoc_doclet.hrl b/lib/edoc/doc/edoc_doclet.hrl
new file mode 120000
index 0000000000..4623b18bb4
--- /dev/null
+++ b/lib/edoc/doc/edoc_doclet.hrl
@@ -0,0 +1 @@
+../include/edoc_doclet.hrl
\ No newline at end of file
diff --git a/lib/edoc/doc/src/Makefile b/lib/edoc/doc/src/Makefile
index aba94a6802..3e53e75c75 100644
--- a/lib/edoc/doc/src/Makefile
+++ b/lib/edoc/doc/src/Makefile
@@ -79,6 +79,11 @@ HTML_REF_MAN_FILE = $(HTMLDIR)/index.html
 
 TOP_PDF_FILE = $(PDFDIR)/$(APPLICATION)-$(VSN).pdf
 
+INCLUDES_DIR = ../../include
+INCLUDES = $(INCLUDES_DIR)/edoc_doclet.hrl
+
+DTDS_DIR = ../../priv
+DTDS = $(DTDS_DIR)/edoc.dtd
 
 # ----------------------------------------------------
 # FLAGS 
@@ -135,5 +140,6 @@ release_docs_spec: docs
 	$(INSTALL_DATA) $(INFO_FILE) "$(RELSYSDIR)"
 	$(INSTALL_DIR) "$(RELEASE_PATH)/man/man3"
 	$(INSTALL_DATA) $(MAN3DIR)/* "$(RELEASE_PATH)/man/man3"
+	$(INSTALL_DATA) $(INCLUDES) $(DTDS) "$(RELSYSDIR)/doc/html"
 
 release_spec:
diff --git a/lib/edoc/include/edoc_doclet.hrl b/lib/edoc/include/edoc_doclet.hrl
index 1429ee5971..a05a9cb2bc 100644
--- a/lib/edoc/include/edoc_doclet.hrl
+++ b/lib/edoc/include/edoc_doclet.hrl
@@ -43,7 +43,7 @@
 %% @type no_app().
 %%    A value used to mark absence of an Erlang application
 %%    context. Use the macro `NO_APP' defined in
-%%    <a href="../include/edoc_doclet.hrl">`edoc_doclet.hrl'</a>
+%%    <a href="edoc_doclet.hrl">`edoc_doclet.hrl'</a>
 %%    to produce this value.
 
 %% @type doclet_gen() = #doclet_gen{sources = [string()],
diff --git a/lib/edoc/src/edoc.erl b/lib/edoc/src/edoc.erl
index e9d62d3283..62483602aa 100644
--- a/lib/edoc/src/edoc.erl
+++ b/lib/edoc/src/edoc.erl
@@ -734,7 +734,7 @@ get_doc(File) ->
 %%
 %% @type edoc_module(). The EDoc documentation data for a module,
 %% expressed as an XML document in {@link //xmerl. XMerL} format. See
-%% the file <a href="../priv/edoc.dtd">`edoc.dtd'</a> for details.
+%% the file <a href="edoc.dtd">`edoc.dtd'</a> for details.
 %%
 %% @doc Reads a source code file and extracts EDoc documentation data.
 %% Note that without an environment parameter (see {@link get_doc/3}),
diff --git a/lib/edoc/src/edoc_doclet.erl b/lib/edoc/src/edoc_doclet.erl
index 6cb3095507..604291374a 100644
--- a/lib/edoc/src/edoc_doclet.erl
+++ b/lib/edoc/src/edoc_doclet.erl
@@ -62,7 +62,7 @@
 
 %% @spec (Command::doclet_gen() | doclet_toc(), edoc_context()) -> ok
 %% @doc Main doclet entry point. See the file <a
-%% href="../include/edoc_doclet.hrl">`edoc_doclet.hrl'</a> for the data
+%% href="edoc_doclet.hrl">`edoc_doclet.hrl'</a> for the data
 %% structures used for passing parameters.
 %%
 %% Also see {@link edoc:layout/2} for layout-related options, and
-- 
2.16.4

Places

File 0635-edoc-Fix-doc-links.patch of Package erlang

Places