ngless-toolkit / ngless-toolkit/ngless

map-split: use relative instead of absolute path for symlinks

Open
#50 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

unclear whether it is a bug
Dominant language
Rust
Stars
152
Forks
23
PR merge metrics
No merged PRs in 30d

Description

As part of the split-map strategy implemented in ngless 0.6 symlinks are created to avoid copying split files. As of this version symlinks use absolute paths.
While this works on a single machine it may break on shared filesystems (different mountpoints) or if the index folder needs to be manually relocated.

Making symlinks relative to the root of the index folder, addresses the issues mentioned above.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the split-map strategy introduced in ngless 0.6 and the code that creates symlinks. Check how the index folder is used as the path root. Done means split files use paths relative to the index folder and continue to work after relocation or across different mountpoints.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
operating-systems
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.