Skip to content
Snippets Groups Projects
Commit 10623b09 authored by Stefano Zacchiroli's avatar Stefano Zacchiroli
Browse files

doc: uniform naming of SwhFS as "Software Heritage Filesystem"

most notably drop "virtual" from filesystem everywhere for consistency
parent c4dd1c36
No related branches found
No related tags found
No related merge requests found
Software Heritage virtual filesystem (SwhFS)
============================================
Software Heritage Filesystem (SwhFS)
====================================
Virtual filesystem to browse the `Software Heritage
User-space POSIX filesystem to browse the `Software Heritage
<https://www.softwareheritage.org/>`_ `archive
<https://archive.softwareheritage.org/>`_, using the `FUSE
<https://github.com/libfuse/libfuse>`_ framework.
<https://archive.softwareheritage.org/>`_, as if it were locally available.
Built using the `FUSE <https://github.com/libfuse/libfuse>`_ framework.
......@@ -4,7 +4,7 @@
Configuration
=============
The configuration for the Software Heritage virtual file system resides in the
The configuration for the Software Heritage Filesystem resides in the
``swh > fuse`` section of the shared `YAML <https://yaml.org/>`_ configuration
file used by all Software Heritage tools, located by default at
``~/.config/swh/global.yml``.
......
# Software Heritage virtual filesystem (SwhFS) --- Design notes
# Software Heritage Filesystem (SwhFS) --- Design notes
The [Software Heritage](https://www.softwareheritage.org/) {ref}`data model
<data-model>` is
......@@ -6,8 +6,8 @@ a [Direct Acyclic Graph](https://en.wikipedia.org/wiki/Directed_acyclic_graph)
(DAG) with nodes of different types that correspond to source code artifacts
such as directories, commits, etc. Using
this [FUSE](https://en.wikipedia.org/wiki/Filesystem_in_Userspace) module
(*SwhFS* for short) you can locally mount, and then navigate as a (virtual)
file system, parts of the archive identified by {ref}`Software Heritage
(*SwhFS* for short) you can locally mount, and then navigate as a
filesystem, parts of the archive identified by {ref}`Software Heritage
identifiers <persistent-identifiers>` (SWHIDs).
To retrieve information about the source code artifacts, SwhFS interacts over
......
No preview for this file type
......@@ -2,7 +2,7 @@
' !includeurl https://raw.githubusercontent.com/RicardoNiepel/C4-PlantUML/master/C4_Container.puml
!include c4-plantuml/C4_Container.puml
' title Container diagram for the Software Heritage virtual filesystem (SwhFS)
' title Container diagram for the Software Heritage Filesystem (SwhFS)
left to right direction
Person(user, "Developer")
......
No preview for this file type
docs/images/arch-context.png

14.7 KiB | W: | H:

docs/images/arch-context.png

14.2 KiB | W: | H:

docs/images/arch-context.png
docs/images/arch-context.png
docs/images/arch-context.png
docs/images/arch-context.png
  • 2-up
  • Swipe
  • Onion skin
......@@ -2,11 +2,11 @@
' !includeurl https://raw.githubusercontent.com/RicardoNiepel/C4-PlantUML/master/C4_Context.puml
!include c4-plantuml/C4_Context.puml
' title System context diagram for the Software Heritage virtual filesystem (SwhFS)
' title System context diagram for the Software Heritage Filesystem (SwhFS)
left to right direction
Person(user, "User")
System(swhfs, "Software Heritage virtual filesystem\n(SwhFS)")
System(swhfs, "Software Heritage Filesystem\n(SwhFS)")
System_Ext(archive, "Software Heritage archive")
Rel(user, swhfs, "Accesses", "Filesystem")
......
<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentScriptType="application/ecmascript" contentStyleType="text/css" height="108px" preserveAspectRatio="none" style="width:808px;height:108px;" version="1.1" viewBox="0 0 808 108" width="808px" zoomAndPan="magnify"><defs/><g><!--MD5=[8fc3522a43f8c7199df5e09e5bb0188e]
entity user--><rect fill="#08427B" height="52.5938" style="stroke: #073B6F; stroke-width: 1.5;" width="74" x="6" y="27.5"/><text fill="#FFFFFF" font-family="sans-serif" font-size="12" font-style="italic" lengthAdjust="spacingAndGlyphs" textLength="54" x="16" y="48.6387">«person»</text><text fill="#FFFFFF" font-family="sans-serif" font-size="16" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="41" x="22.5" y="66.3203">User</text><!--MD5=[94c53a76601d3b5ed673cabb5209f91e]
entity swhfs--><rect fill="#1168BD" height="87.5156" style="stroke: #3C7FC0; stroke-width: 1.5;" width="188" x="214" y="10"/><text fill="#FFFFFF" font-family="sans-serif" font-size="12" font-style="italic" lengthAdjust="spacingAndGlyphs" textLength="56" x="280" y="31.1387">«system»</text><text fill="#FFFFFF" font-family="sans-serif" font-size="16" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="162" x="224" y="48.8203">Software Heritage</text><text fill="#FFFFFF" font-family="sans-serif" font-size="16" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="152" x="232" y="67.4453">virtual filesystem</text><text fill="#FFFFFF" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="56" x="280" y="84.2139">(SwhFS)</text><!--MD5=[a8305b23d211bc1ccd9424c697ead2f2]
entity swhfs--><rect fill="#1168BD" height="87.5156" style="stroke: #3C7FC0; stroke-width: 1.5;" width="188" x="214" y="10"/><text fill="#FFFFFF" font-family="sans-serif" font-size="12" font-style="italic" lengthAdjust="spacingAndGlyphs" textLength="56" x="280" y="31.1387">«system»</text><text fill="#FFFFFF" font-family="sans-serif" font-size="16" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="162" x="224" y="48.8203">Software Heritage</text><text fill="#FFFFFF" font-family="sans-serif" font-size="16" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="94" x="261" y="67.4453">Filesystem</text><text fill="#FFFFFF" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="56" x="280" y="84.2139">(SwhFS)</text><!--MD5=[a8305b23d211bc1ccd9424c697ead2f2]
entity archive--><rect fill="#999999" height="71.2188" style="stroke: #8A8A8A; stroke-width: 1.5;" width="188" x="609" y="18.5"/><text fill="#FFFFFF" font-family="sans-serif" font-size="12" font-style="italic" lengthAdjust="spacingAndGlyphs" textLength="110" x="648" y="39.6387">«external_system»</text><text fill="#FFFFFF" font-family="sans-serif" font-size="16" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="162" x="619" y="57.3203">Software Heritage</text><text fill="#FFFFFF" font-family="sans-serif" font-size="16" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="64" x="671" y="75.9453">archive</text><!--MD5=[15a996fe1ec2f190ff6b000296f7bd56]
link user to swhfs--><path d="M80.02,54 C113.07,54 163.58,54 208.57,54 " fill="none" id="user-&gt;swhfs" style="stroke: #666666; stroke-width: 1.0;"/><polygon fill="#666666" points="213.75,54,204.75,50,208.75,54,204.75,58,213.75,54" style="stroke: #666666; stroke-width: 1.0;"/><text fill="#666666" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="68" x="113" y="36.0669">Accesses</text><text fill="#666666" font-family="sans-serif" font-size="12" font-style="italic" lengthAdjust="spacingAndGlyphs" textLength="72" x="111" y="50.2715">[Filesystem]</text><!--MD5=[a7e6bac0ac0369cb26df61e6b3ce9979]
link swhfs to archive--><path d="M402.14,54 C462.85,54 541.97,54 603.69,54 " fill="none" id="swhfs-&gt;archive" style="stroke: #666666; stroke-width: 1.0;"/><polygon fill="#666666" points="608.85,54,599.85,50,603.85,54,599.85,58,608.85,54" style="stroke: #666666; stroke-width: 1.0;"/><text fill="#666666" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="128" x="439" y="21.0669">Retrieves objects</text><text fill="#666666" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="145" x="433" y="36.1997">and metadata from</text><text fill="#666666" font-family="sans-serif" font-size="12" font-style="italic" lengthAdjust="spacingAndGlyphs" textLength="64" x="473.5" y="50.4043">[REST API]</text><!--MD5=[ad05733741e6415dc971fd39ac73cd5b]
link swhfs to archive--><path d="M402.14,54 C462.85,54 541.97,54 603.69,54 " fill="none" id="swhfs-&gt;archive" style="stroke: #666666; stroke-width: 1.0;"/><polygon fill="#666666" points="608.85,54,599.85,50,603.85,54,599.85,58,608.85,54" style="stroke: #666666; stroke-width: 1.0;"/><text fill="#666666" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="128" x="439" y="21.0669">Retrieves objects</text><text fill="#666666" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="145" x="433" y="36.1997">and metadata from</text><text fill="#666666" font-family="sans-serif" font-size="12" font-style="italic" lengthAdjust="spacingAndGlyphs" textLength="64" x="473.5" y="50.4043">[REST API]</text><!--MD5=[d8ca0af2306aef15ce4b49ddfc8c5d29]
@startuml arch-context
......@@ -116,7 +116,7 @@ skinparam database<<external_system>> {
left to right direction
rectangle "==User" <<person>> as user
rectangle "==Software Heritage virtual filesystem\n(SwhFS)" <<system>> as swhfs
rectangle "==Software Heritage Filesystem\n(SwhFS)" <<system>> as swhfs
rectangle "==Software Heritage archive" <<external_system>> as archive
user - -> swhfs : "===Accesses\n//<size:12>[Filesystem]</size>//"
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment