NixOS/nix

Collect "file system object" parts of `libnixutil` together

Open

#9,278 创建于 2023年11月2日

在 GitHub 查看
 (6 评论) (0 反应) (0 负责人)C++ (9,803 star) (1,293 fork)batch import
good first issueidea approved

描述

We now have bunch of involved code for working with file system objects.

Someday it might be good to codify this into a new libnixfile. (Don't worry, that doesn't mean I am planning a "file-only" Nix!) But going down that road would mean lots of little libraries, which could have implications for dynamic linking. For now we can instead group files into subdirectories (see build/ in libstore for this same concept), but keep all such directories linked together in the parent library.

For initial contents I am thinking:

  • src/libutil/archive
  • src/libutil/canon-path
  • src/libutil/fs-sink
  • src/libutil/git.cc will contain more stuff after #8918
  • src/libutil/posix-source-accessor
  • src/libutil/source-accessor
  • src/libutil/file-content-address New, doesn't distinguish between "flat" and "text" because w.r.t file system objects (as opposed to store objects) they are the same.

I think this will continue growing too based on our current plans. libnixfetchers only barely depends on the store layer anyways, so I think some or even all of it could end up here too.

贡献者指南

技术栈
cpp
领域
developer experiencetooling
议题类型
refactor
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
active
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
basic C++ knowledgeunderstanding of Nix codebase structure
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
40
研究方向
The issue proposes grouping file system object related code in libutil into subdirectories. First, explore the current files listed: src/libutil/archive, src/libutil/canon path, src/libutil/fs sink, src/libutil/git.cc, src/libutil/posix source accessor, src/libutil/source accessor, and consider where to place new code like file content address. Review existing subdirectory patterns in libstore (e.g., build/). Then create a plan to move and organize these files, ensuring includes and build system (Makefile or CMake) are updated accordingly. Check for dependencies between these components to ensure no breakage.