From 46447f1262986910fe68dbb4a47b743b3656910f Mon Sep 17 00:00:00 2001
From: Delyan Angelov <delian66@gmail.com>
Date: Sat, 15 Feb 2025 23:12:57 +0200
Subject: [PATCH] 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)

---
 cmd/tools/vdoc/{doc => document}/comment.v             | 2 +-
 cmd/tools/vdoc/{doc => document}/doc.v                 | 2 +-
 cmd/tools/vdoc/{doc => document}/doc_private_fn_test.v | 6 ++----
 cmd/tools/vdoc/{doc => document}/doc_test.v            | 2 +-
 cmd/tools/vdoc/{doc => document}/module.v              | 2 +-
 cmd/tools/vdoc/{doc => document}/node.v                | 2 +-
 cmd/tools/vdoc/{doc => document}/utils.v               | 4 ++--
 cmd/tools/vdoc/html.v                                  | 2 +-
 cmd/tools/vdoc/main.v                                  | 2 +-
 cmd/tools/vdoc/markdown.v                              | 2 +-
 cmd/tools/vdoc/run_examples.v                          | 2 +-
 cmd/tools/vdoc/utils.v                                 | 2 +-
 cmd/tools/vdoc/vdoc.v                                  | 2 +-
 cmd/tools/vtest-self.v                                 | 4 ++--
 vlib/v/pref/default.v                                  | 2 +-
 15 files changed, 18 insertions(+), 20 deletions(-)
 rename cmd/tools/vdoc/{doc => document}/comment.v (98%)
 rename cmd/tools/vdoc/{doc => document}/doc.v (99%)
 rename cmd/tools/vdoc/{doc => document}/doc_private_fn_test.v (84%)
 rename cmd/tools/vdoc/{doc => document}/doc_test.v (98%)
 rename cmd/tools/vdoc/{doc => document}/module.v (99%)
 rename cmd/tools/vdoc/{doc => document}/node.v (99%)
 rename cmd/tools/vdoc/{doc => document}/utils.v (99%)

diff --git a/cmd/tools/vdoc/doc/comment.v b/cmd/tools/vdoc/document/comment.v
similarity index 98%
rename from cmd/tools/vdoc/doc/comment.v
rename to cmd/tools/vdoc/document/comment.v
index 99616eac7..37e701c1a 100644
--- a/cmd/tools/vdoc/doc/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/doc/doc.v b/cmd/tools/vdoc/document/doc.v
similarity index 99%
rename from cmd/tools/vdoc/doc/doc.v
rename to cmd/tools/vdoc/document/doc.v
index a06588d31..5bbeddd9f 100644
--- a/cmd/tools/vdoc/doc/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/doc/doc_private_fn_test.v b/cmd/tools/vdoc/document/doc_private_fn_test.v
similarity index 84%
rename from cmd/tools/vdoc/doc/doc_private_fn_test.v
rename to cmd/tools/vdoc/document/doc_private_fn_test.v
index b367c8eb6..be55a4ef5 100644
--- a/cmd/tools/vdoc/doc/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/doc/doc_test.v b/cmd/tools/vdoc/document/doc_test.v
similarity index 98%
rename from cmd/tools/vdoc/doc/doc_test.v
rename to cmd/tools/vdoc/document/doc_test.v
index 2672d0696..1f1d5bdbf 100644
--- a/cmd/tools/vdoc/doc/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/doc/module.v b/cmd/tools/vdoc/document/module.v
similarity index 99%
rename from cmd/tools/vdoc/doc/module.v
rename to cmd/tools/vdoc/document/module.v
index cb41c097d..2aba9fc37 100644
--- a/cmd/tools/vdoc/doc/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/doc/node.v b/cmd/tools/vdoc/document/node.v
similarity index 99%
rename from cmd/tools/vdoc/doc/node.v
rename to cmd/tools/vdoc/document/node.v
index 0dd1eec29..c53f8ab57 100644
--- a/cmd/tools/vdoc/doc/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/doc/utils.v b/cmd/tools/vdoc/document/utils.v
similarity index 99%
rename from cmd/tools/vdoc/doc/utils.v
rename to cmd/tools/vdoc/document/utils.v
index b600765a5..5f2ab22a3 100644
--- a/cmd/tools/vdoc/doc/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
index 1ea7d7ed9..c0ff95cc0 100644
--- 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
index a98c8eb25..3ee1ed62c 100644
--- 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
index 945652690..2cb0bf205 100644
--- 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
index 397851f60..2d58e9e9b 100644
--- 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
index 707f6878c..7f1d8873c 100644
--- 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
index 6c0d929d5..2cbc5151b 100644
--- 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
index 504a1e6bc..1d9974939 100644
--- 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
index 6b2d63534..318bc7be8 100644
--- 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
-- 
2.39.5