File 1343-ct-Fix-doc-type-for-common_test_app.patch of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 1343-ct-Fix-doc-type-for-common_test_app.patch of Package erlang

From a9fb1f343687055c9e998ffddc421de2f685309e Mon Sep 17 00:00:00 2001
From: Lukas Larsson <lukas@erlang.org>
Date: Fri, 15 Sep 2023 12:55:01 +0200
Subject: [PATCH 2/2] ct: Fix doc type for common_test_app

This doc page used to include callback docs and then
needed to be an erlref, but as they are moved to ct_suite
this no longer needs to be.
---
 lib/common_test/doc/src/common_test_app.xml | 10 +++++-----
 lib/common_test/doc/src/ct_hooks.xml        |  3 ++-
 2 files changed, 7 insertions(+), 6 deletions(-)

diff --git a/lib/common_test/doc/src/common_test_app.xml b/lib/common_test/doc/src/common_test_app.xml
index 07a2a3e2cd..a74777c56e 100644
--- a/lib/common_test/doc/src/common_test_app.xml
+++ b/lib/common_test/doc/src/common_test_app.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8" ?>
-<!DOCTYPE erlref SYSTEM "erlref.dtd">
+<!DOCTYPE appref SYSTEM "appref.dtd">
 
-<erlref>
+<appref>
   <header>
     <copyright>
       <year>2003</year><year>2020</year>
@@ -32,8 +32,8 @@
     <rev>PA1</rev>
     <file>common_test_app.sgml</file>
   </header>
-  <module since="">common_test</module> 
-  <modulesummary>A framework for automated testing of any target nodes.</modulesummary>
+  <app>common_test</app>
+  <appsummary>A framework for automated testing of any target nodes.</appsummary>
 
   <description>
 
@@ -54,5 +54,5 @@
 
   </description>
 
-</erlref>
+</appref>
 
diff --git a/lib/common_test/doc/src/ct_hooks.xml b/lib/common_test/doc/src/ct_hooks.xml
index b6fb1bff3a..f3040b5c09 100644
--- a/lib/common_test/doc/src/ct_hooks.xml
+++ b/lib/common_test/doc/src/ct_hooks.xml
@@ -761,7 +761,8 @@
         <p>OPTIONAL</p>
 
         <p>This function is called at the end of a CTH
-          <seeguide marker="ct_hooks_chapter#scope">scope</seeguide>.</p>
+          <seeguide marker="ct_hooks_chapter#scope">scope</seeguide>.
+          The returned term is ignored.</p>
       </desc>
     </func>
 
-- 
2.35.3

Places

File 1343-ct-Fix-doc-type-for-common_test_app.patch of Package erlang

Places