Changeset View
Changeset View
Standalone View
Standalone View
docs/design.md
Show First 20 Lines • Show All 54 Lines • ▼ Show 20 Lines | - `archive/`: virtual directory allowing to mount any artifact on the fly using | ||||
of pagination, the JSON file will contain a complete version with all pages | of pagination, the JSON file will contain a complete version with all pages | ||||
merged together). Note: the archive directory cannot be listed with ls, but | merged together). Note: the archive directory cannot be listed with ls, but | ||||
entries in it can be accessed (e.g., using cat or cd). | entries in it can be accessed (e.g., using cat or cd). | ||||
- `origin/`: initially empty, this directory is lazily populated with one entry | - `origin/`: initially empty, this directory is lazily populated with one entry | ||||
per accessed origin URL, having encoded URL as names. The URL encoding is done | per accessed origin URL, having encoded URL as names. The URL encoding is done | ||||
using the percent-encoding mechanism described in | using the percent-encoding mechanism described in | ||||
[RFC 3986](https://tools.ietf.org/html/rfc3986.html). | [RFC 3986](https://tools.ietf.org/html/rfc3986.html). | ||||
zack: better/simpler: "on-disk representation of locally cached objects and metadata"
(bonus point… | |||||
- `cache/`: on-disk representation of locally cached objects and metadata. Via | |||||
this directory you can browse cached data and selectively remove them from the | |||||
Done Inline Actionsbetter/simpler and also more correct: "Via this directory you can browse cached data and selectively remove them from the cache, freeing disk space. (See swh fs clean in the CLI to completely empty the cache.)" (with a link to the CLI doc) all is good starting with the second sentence "The directory is populated [etc.]" zack: better/simpler and also more correct: "Via this directory you can browse cached data and… | |||||
cache, freeing disk space. (See `swh fs clean` in the {ref}`CLI | |||||
<swh-fuse-cli>` to completely empty the cache). The directory is populated | |||||
with symlinks to: all artifacts, identified by their SWHIDs and sharded by the | |||||
first two character of their object id, the metadata identified by a | |||||
`SWHID.json` entry, and the `origin/` directory. | |||||
## File system representation | ## File system representation | ||||
SWHID are represented differently on the file-system depending on the associated | SWHID are represented differently on the file-system depending on the associated | ||||
node types in the Software Heritage graph. Details are given below, for each | node types in the Software Heritage graph. Details are given below, for each | ||||
node type. | node type. | ||||
▲ Show 20 Lines • Show All 165 Lines • Show Last 20 Lines |
better/simpler: "on-disk representation of locally cached objects and metadata"
(bonus point: "metadata" explains both origins and .json files)