tools,v.doc: move vlib/v/doc/ to cmd/tools/vdoc/doc/ to reduce the runtime of the CI runs, when v doc is changed (#23483)

spytheman · web-flow · commit 40b574b409e2 · 2025-01-16T14:40:28.000+02:00
diff --git a/TESTS.md b/TESTS.md
@@ -188,7 +188,7 @@ tests in the main V repository, for example:
 
 > [!NOTE]
 The VDOC test vdoc_file_test.v now also supports VAUTOFIX, which is
-useful, if you change anything inside cmd/tools/vdoc or vlib/v/doc/,
+useful, if you change anything inside cmd/tools/vdoc,
 or inside the modules that it depends on (like markdown).
 After such changes, just run this command *2 times*, and commit the
 resulting changes in `cmd/tools/vdoc/testdata` as well:
diff --git a/cmd/tools/vdoc/doc/comment.v b/cmd/tools/vdoc/doc/comment.v
diff --git a/cmd/tools/vdoc/doc/doc.v b/cmd/tools/vdoc/doc/doc.v
@@ -536,28 +536,28 @@ pub fn generate(input_path string, pub_only bool, with_comments bool, platform P
 	if platform == .js {
 		return error('vdoc: Platform `${platform}` is not supported.')
 	}
-	mut doc := new(input_path)
-	doc.pub_only = pub_only
-	doc.with_comments = with_comments
-	doc.filter_symbol_names = filter_symbol_names.filter(it.len != 0)
-	doc.prefs.os = if platform == .auto {
+	mut d := new(input_path)
+	d.pub_only = pub_only
+	d.with_comments = with_comments
+	d.filter_symbol_names = filter_symbol_names.filter(it.len != 0)
+	d.prefs.os = if platform == .auto {
 		pref.get_host_os()
 	} else {
 		unsafe { pref.OS(int(platform)) }
 	}
-	doc.generate()!
-	return doc
+	d.generate()!
+	return d
 }
 
 // generate_with_pos has the same function as the `generate` function but
 // accepts an offset-based position and enables the comments by default.
 pub fn generate_with_pos(input_path string, filename string, pos int) !Doc {
-	mut doc := new(input_path)
-	doc.pub_only = false
-	doc.with_comments = true
-	doc.with_pos = true
-	doc.filename = filename
-	doc.pos = pos
-	doc.generate()!
-	return doc
+	mut d := new(input_path)
+	d.pub_only = false
+	d.with_comments = true
+	d.with_pos = true
+	d.filename = filename
+	d.pos = pos
+	d.generate()!
+	return d
 }
diff --git a/cmd/tools/vdoc/doc/doc_private_fn_test.v b/cmd/tools/vdoc/doc/doc_private_fn_test.v
@@ -43,5 +43,5 @@ fn test_get_parent_mod_normal_cases() {
 	assert get_parent_mod(os.join_path(@VMODROOT, 'vlib', 'os', 'os.v'))? == 'os'
 	assert get_parent_mod(os.join_path(@VMODROOT, 'cmd'))? == ''
 	assert get_parent_mod(os.join_path(@VMODROOT, 'cmd', 'tools', 'modules', 'testing',
-		'common.v'))? == 'testing'
+		'common.v'))? == 'tools.modules.testing'
 }
diff --git a/cmd/tools/vdoc/doc/doc_test.v b/cmd/tools/vdoc/doc/doc_test.v
@@ -1,5 +1,5 @@
 // import v.ast
-import v.doc
+import doc
 
 // fn test_generate_with_pos() {}
 // fn test_generate() {}
diff --git a/cmd/tools/vdoc/doc/module.v b/cmd/tools/vdoc/doc/module.v
diff --git a/cmd/tools/vdoc/doc/node.v b/cmd/tools/vdoc/doc/node.v
diff --git a/cmd/tools/vdoc/doc/utils.v b/cmd/tools/vdoc/doc/utils.v
@@ -107,7 +107,7 @@ pub fn merge_doc_comments(comments []DocComment) string {
 			for key in highlight_keys {
 				if ll.starts_with(key) {
 					comment += '\n\n${key.title()}${l[key.len..]}'
-					// Workaround for compiling with `v -cstrict -cc gcc vlib/v/doc/doc_test.v`
+					// Workaround for compiling with `v -cstrict -cc gcc cmd/tools/vdoc/doc/doc_test.v`
 					// and using multiple continue `<label>`.
 					continue_line_loop = true
 					break
diff --git a/cmd/tools/vdoc/html.v b/cmd/tools/vdoc/html.v
@@ -8,7 +8,7 @@ import markdown
 import v.scanner
 import v.ast
 import v.token
-import v.doc
+import doc
 import v.pref
 import v.util { tabs }
 
diff --git a/cmd/tools/vdoc/main.v b/cmd/tools/vdoc/main.v
@@ -3,7 +3,7 @@ module main
 import os
 import os.cmdline
 import term
-import v.doc
+import doc
 import v.vmod
 
 const vexe = os.getenv_opt('VEXE') or { @VEXE }
diff --git a/cmd/tools/vdoc/markdown.v b/cmd/tools/vdoc/markdown.v
@@ -1,7 +1,7 @@
 module main
 
 import strings
-import v.doc
+import doc
 
 fn (vd &VDoc) gen_markdown(d doc.Doc, with_toc bool) string {
 	cfg := vd.cfg
diff --git a/cmd/tools/vdoc/run_examples.v b/cmd/tools/vdoc/run_examples.v
@@ -1,6 +1,6 @@
 module main
 
-import v.doc
+import doc
 import v.vmod
 import strings
 import os
diff --git a/cmd/tools/vdoc/testdata/basic/basic.comments.out b/cmd/tools/vdoc/testdata/basic/basic.comments.out
@@ -1,4 +1,4 @@
-module basic
+module testdata.basic
 
 const source_root = 'temp' // some const
 const another = int(5)
diff --git a/cmd/tools/vdoc/testdata/basic/basic.out b/cmd/tools/vdoc/testdata/basic/basic.out
@@ -1,4 +1,4 @@
-module basic
+module testdata.basic
 
 const source_root = 'temp' // some const
 const another = int(5)
diff --git a/cmd/tools/vdoc/utils.v b/cmd/tools/vdoc/utils.v
@@ -1,6 +1,6 @@
 module main
 
-import v.doc
+import doc
 
 @[inline]
 fn slug(title string) string {
diff --git a/cmd/tools/vdoc/v.mod b/cmd/tools/vdoc/v.mod
diff --git a/cmd/tools/vdoc/vdoc.v b/cmd/tools/vdoc/vdoc.v
@@ -6,7 +6,7 @@ import time
 import strings
 import sync
 import runtime
-import v.doc
+import doc
 import v.vmod
 import v.util
 import json
diff --git a/cmd/tools/vtest-self.v b/cmd/tools/vtest-self.v
@@ -25,6 +25,7 @@ const vroot = os.dir(os.real_path(os.getenv_opt('VEXE') or { @VEXE }))
 
 const essential_list = [
 	'cmd/tools/vvet/vet_test.v',
+	'cmd/tools/vdoc/doc/doc_test.v',
 	'vlib/arrays/arrays_test.v',
 	'vlib/bitfield/bitfield_test.v',
 	//
@@ -84,7 +85,6 @@ const essential_list = [
 	'vlib/time/time_test.v',
 	'vlib/toml/tests/toml_test.v',
 	'vlib/v/compiler_errors_test.v',
-	'vlib/v/doc/doc_test.v',
 	'vlib/v/eval/interpret_test.v',
 	'vlib/v/fmt/fmt_keep_test.v',
 	'vlib/v/fmt/fmt_test.v',
@@ -114,7 +114,6 @@ const skip_test_files = [
 const skip_fsanitize_too_slow = [
 	'do_not_remove',
 	'vlib/v/compiler_errors_test.v',
-	'vlib/v/doc/doc_test.v',
 	'vlib/v/fmt/fmt_test.v',
 	'vlib/v/fmt/fmt_keep_test.v',
 	'vlib/v/fmt/fmt_vlib_test.v',
@@ -131,6 +130,7 @@ const skip_fsanitize_too_slow = [
 	'cmd/tools/vpm/install_version_input_test.v',
 	'cmd/tools/vpm/install_version_test.v',
 	'cmd/tools/vpm/update_test.v',
+	'cmd/tools/vdoc/doc/doc_test.v',
 ]
 const skip_with_fsanitize_memory = [
 	'do_not_remove',

Original file line number	Diff line number	Diff line change
`@@ -43,5 +43,5 @@ fn test_get_parent_mod_normal_cases() {`
`43`	`43`	`assert get_parent_mod(os.join_path(@VMODROOT, 'vlib', 'os', 'os.v'))? == 'os'`
`44`	`44`	`assert get_parent_mod(os.join_path(@VMODROOT, 'cmd'))? == ''`
`45`	`45`	`assert get_parent_mod(os.join_path(@VMODROOT, 'cmd', 'tools', 'modules', 'testing',`
`46`		`- 'common.v'))? == 'testing'`
	`46`	`+ 'common.v'))? == 'tools.modules.testing'`
`47`	`47`	`}`