tools: move cmd/tools/vdoc/doc to cmd/tools/vdoc/document, so that it can be imported from other programs through -path, without conflicting with the top level doc/ folder in the main repo (#23733)

spytheman · web-flow · commit 46447f126298 · 2025-02-15T23:12:57.000+02:00
diff --git a/cmd/tools/vdoc/document/comment.v b/cmd/tools/vdoc/document/comment.v
@@ -1,4 +1,4 @@
-module doc
+module document
 
 import v.token
 
diff --git a/cmd/tools/vdoc/document/doc.v b/cmd/tools/vdoc/document/doc.v
@@ -1,4 +1,4 @@
-module doc
+module document
 
 import os
 import time
diff --git a/cmd/tools/vdoc/document/doc_private_fn_test.v b/cmd/tools/vdoc/document/doc_private_fn_test.v
@@ -1,4 +1,4 @@
-module doc
+module document
 
 import os
 
@@ -37,9 +37,7 @@ fn test_get_parent_mod_normal_cases() {
 		assert err.msg() == 'No V files found.'
 		'---'
 	}
-	// TODO: WTF?
-	// assert get_parent_mod(os.join_path(@VMODROOT, 'vlib', 'v', 'doc', 'doc.v'))? == 'v.v.doc'
-	assert get_parent_mod(os.join_path(@VMODROOT, 'vlib', 'v', 'doc'))? == 'v'
+	assert get_parent_mod(os.join_path(@VMODROOT, 'vlib', 'v', 'token'))? == 'v'
 	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',
diff --git a/cmd/tools/vdoc/document/doc_test.v b/cmd/tools/vdoc/document/doc_test.v
@@ -1,5 +1,5 @@
 // import v.ast
-import doc
+import document as doc
 
 // fn test_generate_with_pos() {}
 // fn test_generate() {}
diff --git a/cmd/tools/vdoc/document/module.v b/cmd/tools/vdoc/document/module.v
@@ -1,4 +1,4 @@
-module doc
+module document
 
 import os
 import v.ast
diff --git a/cmd/tools/vdoc/document/node.v b/cmd/tools/vdoc/document/node.v
@@ -1,4 +1,4 @@
-module doc
+module document
 
 import os
 
diff --git a/cmd/tools/vdoc/document/utils.v b/cmd/tools/vdoc/document/utils.v
@@ -1,4 +1,4 @@
-module doc
+module document
 
 import strings
 import v.ast
@@ -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 cmd/tools/vdoc/doc/doc_test.v`
+					// Workaround for compiling with `v -cstrict -cc gcc cmd/tools/vdoc/document/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 doc
+import document as 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 doc
+import document as 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 doc
+import document as 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 doc
+import document as doc
 import v.vmod
 import strings
 import os
diff --git a/cmd/tools/vdoc/utils.v b/cmd/tools/vdoc/utils.v
@@ -1,6 +1,6 @@
 module main
 
-import doc
+import document as doc
 
 @[inline]
 fn slug(title string) string {
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 doc
+import document as doc
 import v.vmod
 import v.util
 import json
diff --git a/cmd/tools/vtest-self.v b/cmd/tools/vtest-self.v
@@ -25,7 +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',
+	'cmd/tools/vdoc/document/doc_test.v',
 	'vlib/arrays/arrays_test.v',
 	'vlib/bitfield/bitfield_test.v',
 	//
@@ -130,7 +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',
+	'cmd/tools/vdoc/document/doc_test.v',
 ]
 const skip_with_fsanitize_memory = [
 	'do_not_remove',
diff --git a/vlib/v/pref/default.v b/vlib/v/pref/default.v
@@ -30,7 +30,7 @@ fn (mut p Preferences) expand_lookup_paths() {
 		match path {
 			'@vlib' { expanded_paths << p.vlib }
 			'@vmodules' { expanded_paths << p.vmodules_paths }
-			else { expanded_paths << path }
+			else { expanded_paths << path.replace('@vroot', p.vroot) }
 		}
 	}
 	p.lookup_path = expanded_paths

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-module doc`
	`1`	`+module document`
`2`	`2`
`3`	`3`	`import v.token`
`4`	`4`