You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: tools/fastgogenerate/README.md
+5-4Lines changed: 5 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,18 +58,19 @@ FastGoGenerate is an experimental tool and is not enabled by default.
58
58
59
59
To enable FastGoGenerate, follow these steps:
60
60
1. Run `make clean` to delete all binaries and caches
61
-
2. Run `FASTGOGENERATE_ENABLED=true make pr` or `FASTGOGENERATE_ENABLED=true make go-generate` to invoke go-generation. This will install the proper binaries by default
62
-
3. The first run will take the same amount of time as without caching, but subsequent runs should be faster
61
+
2. Run `make install-fastgogenerated-tools` to install fastgogenerated tools
62
+
3. Run `make pr` or `make go-generate` to run the code generation with FastGoGenerate
63
+
4. The first run will take the same amount of time as without caching, but subsequent runs should be faster
63
64
64
65
#### How to Disable FastGoGenerate
65
66
66
67
To disable FastGoGenerate, follow these steps:
67
68
1. Run `make clean` to delete all binaries and caches
68
-
2. Run `make pr` or `make go-generate` to install original binaries
69
+
2. Run `make pr` or `make go-generate` to install original binaries and run the code generation with original binaries
69
70
70
71
#### How It Works
71
72
72
-
* When `FASTGOGENERATE_ENABLED=true` is set, the Makefile builds a fastgogenerate binary with a built-in plugin name that replaces the original plugin binary
73
+
* When `make install-fastgogenerated-tools` is run, the Makefile builds a fastgogenerate binary with a built-in plugin name that replaces the original plugin binary
73
74
* The original plugin binary is stored with the same name plus `.bin` suffix
74
75
* The Makefile sets `FASTGOGENERATE_CACHE_PATH` to `$(shell pwd)/$(BUILD)/.fastgogenerate_cache` to ensure that the cache can be easily removed with `make clean`
0 commit comments