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
This commit is contained in:
Daniel Stenberg 2025-05-27 08:06:37 +02:00
parent 46733c585b
commit fa3f889752
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
9 changed files with 14 additions and 25 deletions

View File

@ -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}

View File

@ -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)

View File

@ -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