File 2554-Replace-repeated-test-case-return-value-do... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 2554-Replace-repeated-test-case-return-value-docs-with-a-.patch of Package erlang (Revision 2f15b05a39d64e5cba90e927e8665465)

Currently displaying revision 2f15b05a39d64e5cba90e927e8665465 , Show latest

From 409df69c26f22c6b424fb9a0b2cd94a6b6ca9fd2 Mon Sep 17 00:00:00 2001
From: Maria Scott <maria-12648430@hnc-agency.org>
Date: Thu, 30 Nov 2023 17:38:36 +0100
Subject: [PATCH 4/4] Replace repeated test case return value docs with a link
 to the manual

---
 .../doc/src/write_test_chapter.xml            | 31 ++-----------------
 1 file changed, 3 insertions(+), 28 deletions(-)

diff --git a/lib/common_test/doc/src/write_test_chapter.xml b/lib/common_test/doc/src/write_test_chapter.xml
index 569f35b1a5..b84c54041b 100644
--- a/lib/common_test/doc/src/write_test_chapter.xml
+++ b/lib/common_test/doc/src/write_test_chapter.xml
@@ -282,34 +282,9 @@
 be used. For example: <c>PrivDir = proplists:get_value(priv_dir, Config)</c>.
 
 
- Possible return values of the test case function are:
- <taglist>
- <tag><c>{fail, Reason}</c></tag>
- <item>The test case is considered failed, and the <c>Reason</c>
- will be logged.</item>
- <tag><c>{skip, Reason}</c></tag>
- <item>The test case is considered skipped, and the <c>Reason</c>
- will be logged.</item>
- <tag><c>{comment, Comment}</c></tag>
- <item>The test case is considered successful, and the <c>Comment</c>
- will be logged.</item>
- <tag><c>{save_config, SaveConfig}</c></tag>
- <item>The test case is considered successful, and the <c>SaveConfig</c>
- will be stored in the <c>Config</c> (see section
- <seeguide marker="dependencies_chapter#save_config">Saving
- Configuration Data</seeguide>).</item>
- <tag><c>{skip_and_save, Reason, SaveConfig}</c></tag>
- <item>The test case is considered skipped, the <c>Reason</c>
- will be logged, and the <c>SaveConfig</c> will be stored in the
- <c>Config</c> (see section
- <seeguide marker="dependencies_chapter#save_config">Saving
- Configuration Data</seeguide>).</item>
- </taglist>
-
- If the test case function returns any other term, the test case is considered
- successful.
-
- If the test case function crashes, it is considered failed.
+ The test case result can be customized in several ways. See the manual for
+ <seemfa marker="ct_suite#Module:Testcase/1"><c>Module:Testcase/1</c></seemfa> in
+ the <seeerl marker="ct_suite"><c>ct_suite</c></seeerl> module for details.
 
 </section>
 
-- 
2.35.3

Places

File 2554-Replace-repeated-test-case-return-value-docs-with-a-.patch of Package erlang (Revision 2f15b05a39d64e5cba90e927e8665465)

Places