File 0437-ct-Fix-ct_suite-links.patch of Package erlang
From 7fc244693521b1155cd15bcae5ea2eb99542dbd9 Mon Sep 17 00:00:00 2001
From: Lukas Larsson <lukas@erlang.org>
Date: Fri, 15 Sep 2023 12:54:43 +0200
Subject: [PATCH 1/2] ct: Fix ct_suite links
---
lib/common_test/doc/src/basics_chapter.xml | 2 +-
lib/common_test/doc/src/ct_cover.xml | 2 +-
lib/common_test/doc/src/ct_hooks.xml | 2 +-
lib/common_test/doc/src/getting_started_chapter.xml | 2 +-
lib/common_test/doc/src/write_test_chapter.xml | 4 ++--
5 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/lib/common_test/doc/src/basics_chapter.xml b/lib/common_test/doc/src/basics_chapter.xml
index 359237289e..5f4da5f44b 100644
--- a/lib/common_test/doc/src/basics_chapter.xml
+++ b/lib/common_test/doc/src/basics_chapter.xml
@@ -143,7 +143,7 @@
</p>
<p>
The test suite module must conform to a
- <seeerl marker="common_test">callback interface</seeerl>
+ <seeerl marker="ct_suite">callback interface</seeerl>
specified by the <c>Common Test</c> test server. For details, see section
<seeguide marker="write_test_chapter#intro">Writing Test Suites</seeguide>.
</p>
diff --git a/lib/common_test/doc/src/ct_cover.xml b/lib/common_test/doc/src/ct_cover.xml
index 836a651db6..600e3e51d6 100644
--- a/lib/common_test/doc/src/ct_cover.xml
+++ b/lib/common_test/doc/src/ct_cover.xml
@@ -61,7 +61,7 @@
<p>To have effect, this function is to be called from
<c>init_per_suite/1</c> (see
- <seeerl marker="common_test"><c>common_test</c></seeerl>)
+ <seeerl marker="ct_suite"><c>ct_suite</c></seeerl>)
before any tests are performed.</p>
</desc>
</func>
diff --git a/lib/common_test/doc/src/ct_hooks.xml b/lib/common_test/doc/src/ct_hooks.xml
index 84d0fdf7df..b6fb1bff3a 100644
--- a/lib/common_test/doc/src/ct_hooks.xml
+++ b/lib/common_test/doc/src/ct_hooks.xml
@@ -752,7 +752,7 @@
</func>
<func>
- <name since="OTP R14B02">Module:terminate(CTHState)</name>
+ <name since="OTP R14B02">Module:terminate(CTHState) -> term()</name>
<fsummary>Called after the CTH scope ends.</fsummary>
<type>
<v>CTHState = term()</v>
diff --git a/lib/common_test/doc/src/getting_started_chapter.xml b/lib/common_test/doc/src/getting_started_chapter.xml
index 2940090eee..0a12a96536 100644
--- a/lib/common_test/doc/src/getting_started_chapter.xml
+++ b/lib/common_test/doc/src/getting_started_chapter.xml
@@ -95,7 +95,7 @@
<p>As shown in section
<seeguide marker="basics_chapter#External_Interfaces">Common Test Basics</seeguide>,
the test suite module implements
- <seeerl marker="common_test">callback functions</seeerl>
+ <seeerl marker="ct_suite">callback functions</seeerl>
(mandatory or optional) for various purposes, for example:
</p>
<list type="bulleted">
diff --git a/lib/common_test/doc/src/write_test_chapter.xml b/lib/common_test/doc/src/write_test_chapter.xml
index 17b76bf4d5..248ef317b9 100644
--- a/lib/common_test/doc/src/write_test_chapter.xml
+++ b/lib/common_test/doc/src/write_test_chapter.xml
@@ -73,7 +73,7 @@
</p>
<p>The callback functions to be implemented by the test suite are
- all listed in module <seeerl marker="common_test">common_test
+ all listed in module <seeerl marker="ct_suite">ct_suite
</seeerl>. They are also described in more detail later in this User's Guide.
</p>
@@ -957,7 +957,7 @@
When the timetrap function returns, the time-out is triggered, <em>unless</em>
the return value is a valid timetrap time, such as an integer,
or a <c>{SecMinOrHourTag,Time}</c> tuple (for details, see module
- <seeerl marker="common_test">common_test</seeerl>). If a time value
+ <seeerl marker="ct_suite">ct_suite</seeerl>). If a time value
is returned, a new timetrap is started to generate a time-out after
the specified time.</p>
--
2.35.3