Skip to content
Prev Previous commit
Next Next commit
doc: fix lint-md failed
  • Loading branch information
congzhangzh committed Mar 30, 2024
commit a0e6ef0c9dc958d22aa3d23c6d1f30957162b2ad
8 changes: 4 additions & 4 deletions BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -559,11 +559,11 @@ export LDFLAGS="-fuse-ld=mold" # add to ~/.zshrc or other shell config file

On Windows:

Tips: follow <https://github.com/ccache/ccache/wiki/MS-Visual-Studio>, and you should
notice that obj file will be bigger the normal one.
Tips: follow <https://github.com/ccache/ccache/wiki/MS-Visual-Studio>, and you
should notice that obj file will be bigger the normal one.

First, install ccache, assume ccache install to c:\ccache, copy c:\ccache\ccache.exe
to c:\ccache\cl.exe
First, install ccache, assume ccache install to c:\ccache, copy
c:\ccache\ccache.exe to c:\ccache\cl.exe

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change to CL.exe, is less error prone to confuse with 1.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, during the tests, I got some errors because I installed the ccache via chocolatey and I copy the shim file instead of the original file.

I think we should not include the steps to install the ccache, just ask the user to install and ensure they have the CL.exe file.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change to CL.exe, is less error prone to confuse with 1.

I agree:)

@congzhangzh congzhangzh Mar 30, 2024 •

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, during the tests, I got some errors because I installed the ccache via chocolatey and I copy the shim file instead of the original file.

I think we should not include the steps to install the ccache, just ask the user to install and ensure they have the CL.exe file.

Yes, these instructions will make doc mess here, on another side,
As chocolatey is popular these day, I’m a little worried most of the user will do these step wrong.


```powershell
set TrackFileAccess=false
Expand Down