From fa3f889752e6b5034966de61a372a60773a69ca8 Mon Sep 17 00:00:00 2001
From: Daniel Stenberg <daniel@haxx.se>
Date: Tue, 27 May 2025 08:06:37 +0200
Subject: [PATCH] tests: move test docs into /docs

In an attempt to make them easier to find.

The man pages runtests.md and testcurl.md are in /docs

The rest of the test documentation is in /docs/tests

Closes #17463
---
 docs/CMakeLists.txt                         |  2 +-
 docs/Makefile.am                            | 14 ++++++++++---
 {tests => docs}/runtests.md                 |  0
 {tests => docs}/testcurl.md                 |  0
 {tests => docs/tests}/CI.md                 |  0
 {tests => docs/tests}/FILEFORMAT.md         |  0
 tests/http/README.md => docs/tests/HTTP.md  |  0
 tests/README.md => docs/tests/TEST-SUITE.md |  0
 tests/Makefile.am                           | 23 ++-------------------
 9 files changed, 14 insertions(+), 25 deletions(-)
 rename {tests => docs}/runtests.md (100%)
 rename {tests => docs}/testcurl.md (100%)
 rename {tests => docs/tests}/CI.md (100%)
 rename {tests => docs/tests}/FILEFORMAT.md (100%)
 rename tests/http/README.md => docs/tests/HTTP.md (100%)
 rename tests/README.md => docs/tests/TEST-SUITE.md (100%)

diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
index f5293c5a29..5f342954cc 100644
--- a/docs/CMakeLists.txt
+++ b/docs/CMakeLists.txt
@@ -30,7 +30,7 @@ if(ENABLE_CURL_MANUAL AND BUILD_CURL_EXE)
 endif()
 
 if(BUILD_MISC_DOCS)
-  foreach(_man_misc IN ITEMS "curl-config" "mk-ca-bundle" "wcurl")
+  foreach(_man_misc IN ITEMS "curl-config" "mk-ca-bundle" "wcurl" "runtests" "testcurl")
     set(_man_target "${CMAKE_CURRENT_BINARY_DIR}/${_man_misc}.1")
     add_custom_command(OUTPUT "${_man_target}"
       WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 150a86821d..862e36536b 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -28,18 +28,25 @@ if BUILD_DOCS
 # if we disable man page building, ignore these
 MK_CA_DOCS = mk-ca-bundle.1
 CURLCONF_DOCS = curl-config.1
+TEST_DOCS = runtests.1 testcurl.1
 man_MANS = curl-config.1 wcurl.1
 endif
 
-CURLPAGES = curl-config.md mk-ca-bundle.md wcurl.md
+CURLPAGES = curl-config.md mk-ca-bundle.md wcurl.md runtests.md testcurl.md
 
 SUBDIRS = . cmdline-opts libcurl
 DIST_SUBDIRS = $(SUBDIRS) examples
 
 if BUILD_DOCS
-CLEANFILES = mk-ca-bundle.1 curl-config.1 wcurl.1
+CLEANFILES = $(MK_CA_DOCS) $(man_MANS) $(TEST_DOCS)
 endif
 
+TESTDOCS =                                      \
+ tests/CI.md                                    \
+ tests/FILEFORMAT.md                            \
+ tests/HTTP.md                                  \
+ tests/TEST-SUITE.md
+
 INTERNALDOCS =                                  \
  internals/BUFQ.md                              \
  internals/BUFREF.md                            \
@@ -67,6 +74,7 @@ INTERNALDOCS =                                  \
 EXTRA_DIST =                                    \
  $(CURLPAGES)                                   \
  $(INTERNALDOCS)                                \
+ $(TESTDOCS)                                    \
  ALTSVC.md                                      \
  BINDINGS.md                                    \
  BUG-BOUNTY.md                                  \
@@ -126,7 +134,7 @@ CD2_ = $(CD2_0)
 
 SUFFIXES = .1 .md
 
-all: $(MK_CA_DOCS) $(CURLCONF_DOCS)
+all: $(MK_CA_DOCS) $(CURLCONF_DOCS) $(TEST_DOCS)
 
 .md.1:
 	$(CD2)$(CD2NROFF)
diff --git a/tests/runtests.md b/docs/runtests.md
similarity index 100%
rename from tests/runtests.md
rename to docs/runtests.md
diff --git a/tests/testcurl.md b/docs/testcurl.md
similarity index 100%
rename from tests/testcurl.md
rename to docs/testcurl.md
diff --git a/tests/CI.md b/docs/tests/CI.md
similarity index 100%
rename from tests/CI.md
rename to docs/tests/CI.md
diff --git a/tests/FILEFORMAT.md b/docs/tests/FILEFORMAT.md
similarity index 100%
rename from tests/FILEFORMAT.md
rename to docs/tests/FILEFORMAT.md
diff --git a/tests/http/README.md b/docs/tests/HTTP.md
similarity index 100%
rename from tests/http/README.md
rename to docs/tests/HTTP.md
diff --git a/tests/README.md b/docs/tests/TEST-SUITE.md
similarity index 100%
rename from tests/README.md
rename to docs/tests/TEST-SUITE.md
diff --git a/tests/Makefile.am b/tests/Makefile.am
index 3030b33500..2c8b1b30d2 100644
--- a/tests/Makefile.am
+++ b/tests/Makefile.am
@@ -22,15 +22,6 @@
 #
 ###########################################################################
 
-if BUILD_DOCS
-# if we disable man page building, ignore these
-RUNTESTS_DOCS = runtests.1
-TESTCURL_DOCS = testcurl.1
-MANFILES = $(RUNTESTS_DOCS) $(TESTCURL_DOCS)
-endif
-
-CURLPAGES = runtests.md testcurl.md
-
 # scripts used in test cases
 TESTSCRIPTS = \
  test1119.pl  \
@@ -56,8 +47,6 @@ TESTSCRIPTS = \
 
 EXTRA_DIST =        \
  CMakeLists.txt     \
- FILEFORMAT.md      \
- README.md          \
  allversions.pm     \
  appveyor.pm        \
  azure.pm           \
@@ -95,8 +84,7 @@ EXTRA_DIST =        \
  util.py            \
  valgrind.pm        \
  valgrind.supp      \
- $(TESTSCRIPTS)     \
- $(CURLPAGES)
+ $(TESTSCRIPTS)
 
 # we have two variables here to make sure DIST_SUBDIRS won't get 'unit'
 # added twice as then targets such as 'distclean' misbehave and try to
@@ -114,7 +102,7 @@ DIST_SUBDIRS = $(SUBDIRS) $(DIST_UNIT)
 
 PERLFLAGS = -I$(srcdir)
 
-CLEANFILES = .http.pid .https.pid .ftp.pid .ftps.pid $(MANDISTPAGES)
+CLEANFILES = .http.pid .https.pid .ftp.pid .ftps.pid
 
 curl:
 	@cd $(top_builddir) && $(MAKE)
@@ -148,13 +136,6 @@ TEST_CI = $(TEST_NF) -r --retry=5 -j20
 PYTEST = pytest
 endif
 
-CD2NROFF = $(top_srcdir)/scripts/cd2nroff $< >$@
-
-SUFFIXES = .1 .md
-
-.md.1:
-	$(CD2)$(CD2NROFF)
-
 # make sure that PERL is pointing to an executable
 perlcheck:
 	@if ! test -x "$(PERL)"; then echo "No perl!"; exit 2; fi
-- 
2.47.2