-
-
Notifications
You must be signed in to change notification settings - Fork 384
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: Make it more clear that symlinks need to be enabled on Windows (#…
…6564) Multiple people ran into the issue that symlinks need to be enabled when cloning the repository on Windows. It was already mentioned, but now it is more obvious. Also added a Troubleshooting section.
- Loading branch information
1 parent
54988a1
commit f0fb3f5
Showing
1 changed file
with
41 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -27,20 +27,24 @@ Docker provides an isolated environment, very close to a Virtual Machine. This e | |
Choose your prefered way to clone, either: | ||
|
||
**on Windows:** | ||
|
||
If you are running Docker on Windows, please use the following git clone option: | ||
|
||
```console | ||
git clone [email protected]:openfoodfacts/openfoodfacts-server.git | ||
git clone -c core.symlinks=true [email protected]:openfoodfacts/openfoodfacts-server.git | ||
``` | ||
|
||
or | ||
**on other systems:** | ||
|
||
```console | ||
git clone https://github.com/openfoodfacts/openfoodfacts-server.git | ||
git clone git@github.com:openfoodfacts/openfoodfacts-server.git | ||
``` | ||
|
||
If you are running Docker on Windows, please use the following git clone option: | ||
or | ||
|
||
```console | ||
git clone -c core.symlinks=true git@github.com:openfoodfacts/openfoodfacts-server.git | ||
git clone https://github.com/openfoodfacts/openfoodfacts-server.git | ||
``` | ||
|
||
Go to the cloned directory: | ||
|
@@ -132,3 +136,35 @@ To have all site page on your dev instance, see [Using pages from openfoodfacts- | |
This repository comes with a configuration for Visual Studio Code (VS Code) [development containers (devcontainer)](https://code.visualstudio.com/docs/remote/containers). This enables some Perl support in VS Code without the need to install the correct Perl version and modules on your local machine. | ||
|
||
To use the devcontainer, install [prerequisites](#1-prerequisites), [clone the repository from GitHub](#2-clone-the-repository-from-github), and [(optionally) review Product Opener's environment](#3-optional-review-product-openers-environment). Additionally, install [Visual Studio Code](https://code.visualstudio.com/). VS Code will automatically recommend some extensions, but if you don't want to install all of them, please do install [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) manually. You can then use the extension command **Remote-Containers: Reopen Folder in Container**, which will automatically build the container and start the services. No need to use `make`! | ||
|
||
## Troubleshooting | ||
|
||
### make dev error: [build_lang] Error 2 - Could not load taxonomy: /mnt/podata/taxonomies/traces.result.sto | ||
|
||
When running "make dev": | ||
|
||
```console | ||
<h1>Software error:</h1> | ||
<pre>Could not load taxonomy: /mnt/podata/taxonomies/traces.result.sto at /opt/product-opener/lib/ProductOpener/Tags.pm line 1976. | ||
Compilation failed in require at /opt/product-opener/scripts/build_lang.pl line 31, <DATA> line 2104. | ||
BEGIN failed--compilation aborted at /opt/product-opener/scripts/build_lang.pl line 31, <DATA> line 2104. | ||
</pre> | ||
<p> | ||
For help, please send mail to this site's webmaster, giving this error message | ||
and the time and date of the error. | ||
</p> | ||
[Tue Apr 5 19:36:40 2022] build_lang.pl: Could not load taxonomy: /mnt/podata/taxonomies/traces.result.sto at /opt/product-opener/lib/ProductOpener/Tags.pm line 1976. | ||
[Tue Apr 5 19:36:40 2022] build_lang.pl: Compilation failed in require at /opt/product-opener/scripts/build_lang.pl line 31, <DATA> line 2104. | ||
[Tue Apr 5 19:36:40 2022] build_lang.pl: BEGIN failed--compilation aborted at /opt/product-opener/scripts/build_lang.pl line 31, <DATA> line 2104. | ||
make: *** [build_lang] Error 2 | ||
``` | ||
|
||
Solution: | ||
|
||
traces.result.sto is a symlink to allergens.result.sto | ||
|
||
On Windows systems, the git repository needs to be cloned with symlinks enabled. | ||
|
||
```console | ||
git clone -c core.symlinks=true [email protected]:openfoodfacts/openfoodfacts-server.git | ||
``` |