change: update docs

debugtalk · debugtalk · commit 08e57209a037 · 2023-08-07T00:19:29.000+08:00
diff --git a/README.md b/README.md
@@ -36,10 +36,10 @@ func Init(path string, options ...Option) (plugin IPlugin, err error)
 
 - path: built plugin file path
 - options: specify extra plugin options
-  - WithDebugLogger(debug bool): whether to print debug level logs in plugin process
-  - WithLogFile(logFile string): specify log file path
-  - WithDisableTime(disable bool): whether disable log time
-  - WithPython3(python3 string): specify custom python3 path
+  - `WithDebugLogger(debug bool)`: whether to print debug level logs in plugin process
+  - `WithLogFile(logFile string)`: specify log file path
+  - `WithDisableTime(disable bool)`: whether disable log time
+  - `WithPython3(python3 string)`: specify custom python3 path
 
 2, call plugin API to deal with plugin functions.
 
diff --git a/docs/go-grpc-plugin.md b/docs/go-grpc-plugin.md
@@ -82,4 +82,4 @@ The complete log example can be found in the file [hashicorp_grpc_go.log].
 
 
 [fungo/examples/]: ../fungo/examples/
-[hashicorp_grpc_go.log]: ../fungo/examples/logs/hashicorp_grpc_go.log
+[hashicorp_grpc_go.log]: logs/hashicorp_grpc_go.log
diff --git a/docs/go-rpc-plugin.md b/docs/go-rpc-plugin.md
@@ -21,4 +21,4 @@ The complete log example can be found in the file [hashicorp_rpc_go.log].
 [golang plugin over gRPC]: go-grpc-plugin.md
 [examples/plugin/]: ../examples/plugin/
 [examples/plugin/debugtalk.go]: ../examples/plugin/debugtalk.go
-[hashicorp_rpc_go.log]: ../fungo/examples/logs/hashicorp_rpc_go.log
+[hashicorp_rpc_go.log]: logs/hashicorp_rpc_go.log
diff --git a/docs/logs/hashicorp_grpc_go.log b/docs/logs/hashicorp_grpc_go.log
diff --git a/docs/logs/hashicorp_rpc_go.log b/docs/logs/hashicorp_rpc_go.log
diff --git a/hashicorp_plugin_test.go b/hashicorp_plugin_test.go
@@ -35,7 +35,7 @@ func TestHashicorpGRPCGoPlugin(t *testing.T) {
 
 	plugin, err := Init("fungo/examples/debugtalk.bin",
 		WithDebugLogger(true),
-		WithLogFile("fungo/examples/logs/hashicorp_grpc_go.log"),
+		WithLogFile("docs/logs/hashicorp_grpc_go.log"),
 		WithDisableTime(true))
 	if err != nil {
 		t.Fatal(err)
@@ -52,7 +52,7 @@ func TestHashicorpRPCGoPlugin(t *testing.T) {
 	os.Setenv(fungo.PluginTypeEnvName, "rpc")
 	plugin, err := Init("fungo/examples/debugtalk.bin",
 		WithDebugLogger(true),
-		WithLogFile("fungo/examples/logs/hashicorp_rpc_go.log"),
+		WithLogFile("docs/logs/hashicorp_rpc_go.log"),
 		WithDisableTime(true))
 	if err != nil {
 		t.Fatal(err)

Original file line number	Diff line number	Diff line change
`@@ -82,4 +82,4 @@ The complete log example can be found in the file [hashicorp_grpc_go.log].`
`82`	`82`
`83`	`83`
`84`	`84`	`[fungo/examples/]: ../fungo/examples/`
`85`		`-[hashicorp_grpc_go.log]: ../fungo/examples/logs/hashicorp_grpc_go.log`
	`85`	`+[hashicorp_grpc_go.log]: logs/hashicorp_grpc_go.log`