skypjack / entt

Gaming meets modern C++ - a fast and reliable entity component system (ECS) and much more
https://github.com/skypjack/entt/wiki
MIT License
10k stars 877 forks source link

entt.wiki has filenames with : in them, which probably causes problems with Git on Windows #1157

Open kraybit opened 1 month ago

kraybit commented 1 month ago

Cloning the entt.wiki project causes problems with Git 2.45.2.windows.1 on Windows.

Here's a shell session showing the issue:

$ git clone https://github.com/skypjack/entt.wiki.git entt_wiki

Cloning into 'entt_wiki'...
remote: Enumerating objects: 1374, done.
remote: Counting objects: 100% (3/3), done.
remote: Compressing objects: 100% (3/3), done.
remote: Total 1374 (delta 0), reused 0 (delta 0), pack-reused 1371
Receiving objects: 100% (1374/1374), 578.79 KiB | 7.52 MiB/s, done.
Resolving deltas: 100% (913/913), done.
error: invalid path 'Crash-Course:-configuration.md'
fatal: unable to checkout working tree
warning: Clone succeeded, but checkout failed.
You can inspect what was checked out with 'git status'
and retry with 'git restore --source=HEAD :/'

$ cd entt_wiki
$ git status

On branch master
Your branch is up to date with 'origin/master'.

Changes to be committed:
  (use "git restore --staged <file>..." to unstage)
        deleted:    Crash-Course:-configuration.md
        deleted:    Crash-Course:-containers.md
        deleted:    Crash-Course:-cooperative-scheduler.md
        deleted:    Crash-Course:-core-functionalities.md
        deleted:    Crash-Course:-entity-component-system.md
        deleted:    Crash-Course:-events,-signals-and-everything-in-between.md
        deleted:    Crash-Course:-graph.md
        deleted:    Crash-Course:-poly.md
        deleted:    Crash-Course:-resource-management.md
        deleted:    Crash-Course:-runtime-reflection-system.md
        deleted:    Crash-Course:-service-locator.md
        deleted:    EnTT-and-Unreal-Engine.md
        deleted:    EnTT-in-Action.md
        deleted:    Frequently-Asked-Questions.md
        deleted:    Home.md
        deleted:    Push-EnTT-across-boundaries.md
        deleted:    Similar-projects.md
        deleted:    _Footer.md

$ _

Issuing git restore --source=HEAD :/ just repeats the problem.

I can't say that I know, but perhaps this problem is caused by colons : in some of the filenames?

I've read on the Internet (StackOverflow #63727594) that this can perhaps be worked around by flipping some magical NTFS-setting in git. I haven't tried it. My hope is this issue report will have a similar but more wide-spread effect : )

Cheers! Kind regards /kraybit

skypjack commented 1 month ago

I didn't even know cloning the wiki was possible 😅 why are you doing it btw? All wiki files are in the main project too.

kraybit commented 1 month ago

Yeahno, the entt.wiki repos isn't "available", as far as I can see, but I found this little button in the lower right corner:

image

Perhaps this could be seen as a Github bug, really?

Either way, the reason I tried to clone it was twofold:

  1. In case I'd like to make a PR.
  2. Just nice to have locally (Think in case of no Internet connection)

But I did not know the wiki was in the main project! As far as I'm concerned, you can close this -- it's a non-issue. Sorry for taking up time.

Cheers! Kind regards /kraybit

skypjack commented 1 month ago

The wiki is in the main project because the same doc is also used for doxygen. So, it's not the wiki, technically speaking. It's also the wiki 🙂 if you get what I mean. Btw I never realized GH wikis can be forked, really. TIL something I didn't expect. 😅 That said, don't worry. I'll be away for a few days in August, so I can't look into it right away. However, feel free to leave the issue open and I'll take a quick look at it when I'm back. If it can be fixed, well, why not then. I'll close the issue if it gets too complicated otherwise. 🤷‍♂️