From 250b3bac78e9a7db56bb2f8b43abc848846254b9 Mon Sep 17 00:00:00 2001 From: Ben Spoor Date: Mon, 9 Feb 2026 22:30:59 +0100 Subject: [PATCH 1/5] Add branch name to install instructions --- doc/installation.rst | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/doc/installation.rst b/doc/installation.rst index 4f7df598..e48152bb 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -1,6 +1,3 @@ - - - Installation ============ @@ -17,7 +14,7 @@ Or install the latest version from the main branch: .. code-block:: bash - pip install git+https://github.com/dfetch-org/dfetch.git#egg=dfetch + pip install git+https://github.com/dfetch-org/dfetch.git@main#egg=dfetch Binary distributions -------------------- From f07f6cde6efb4de0cdbc496267c925e7fd82f6ad Mon Sep 17 00:00:00 2001 From: Ben Spoor Date: Mon, 9 Feb 2026 22:31:18 +0100 Subject: [PATCH 2/5] Add superproject to c3 diagram --- .../uml/c3_dfetch_components_project.puml | 28 ++++++++++++------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/doc/static/uml/c3_dfetch_components_project.puml b/doc/static/uml/c3_dfetch_components_project.puml index 0c99edbc..1e683c56 100644 --- a/doc/static/uml/c3_dfetch_components_project.puml +++ b/doc/static/uml/c3_dfetch_components_project.puml @@ -12,31 +12,39 @@ System_Boundary(DFetch, "Dfetch") { Boundary(DfetchProject, "Project", "python", "Main project that has a manifest.") { Component(compAbstractCheckReporter, "AbstractCheckReporter", "python", "Abstract interface for generating a check report.") - Component(compGit, "Git", "python", "A subproject based on git.") + Component(compGitSub, "GitSubproject", "python", "A subproject based on git.") Component(compMetadata, "Metadata", "python", "A file containing metadata about a project.") - Component(compSvn, "Svn", "python", "A subproject based on svn.") + Component(compSvnSub, "SvnSubproject", "python", "A subproject based on svn.") Component(compSubProject, "SubProject", "python", "An abstract subproject.") + Component(compSuperProject, "SuperProject", "python", "An abstract superproject.") + Component(compGitSuper, "GitSuperProject", "python", "A superproject based on git.") + Component(compSvnSuper, "SvnSuperProject", "python", "A superproject based on svn.") + Component(compNoVcsSuper, "NoVcsSuperProject", "python", "A superproject without VCS.") - Rel_U(compGit, compSubProject, "Implements") - Rel_U(compSvn, compSubProject, "Implements") + Rel_U(compGitSub, compSubProject, "Implements") + Rel_U(compSvnSub, compSubProject, "Implements") Rel(compSubProject, compAbstractCheckReporter, "Uses") Rel_L(compSubProject, compMetadata, "Uses") - } + Rel_U(compGitSuper, compSuperProject, "Implements") + Rel_U(compSvnSuper, compSuperProject, "Implements") + Rel_U(compNoVcsSuper, compSuperProject, "Implements") + } Container(contVcs, "Vcs", "python", "Abstraction of various Version Control Systems.") Container(contReporting, "Reporting", "python", "Output formatters for various reporting formats.") + Rel(contCommands, compSuperProject, "Uses") Rel(contCommands, compSubProject, "Uses") - Rel(contCommands, compGit, "Uses") - Rel(contCommands, compSvn, "Uses") Rel(contReporting, compAbstractCheckReporter, "Implements") Rel_R(contReporting, compMetadata, "Uses") Rel_R(compMetadata, contManifest, "Has") - Rel(compSubProject, contManifest, "Has") + Rel(compSuperProject, contManifest, "Has") Rel(contReporting, contManifest, "Uses") - Rel(compGit, contVcs, "Uses") - Rel(compSvn, contVcs, "Uses") + Rel(compGitSub, contVcs, "Uses") + Rel(compSvnSub, contVcs, "Uses") + Rel(compGitSuper, contVcs, "Uses") + Rel(compSvnSuper, contVcs, "Uses") } Rel(user, contCommands, "Uses") From da6c33d94866bfb727fd878e9a99f2efbe42996f Mon Sep 17 00:00:00 2001 From: Ben Spoor Date: Mon, 9 Feb 2026 22:36:54 +0100 Subject: [PATCH 3/5] Add update-patch and format-patch to command diagrams. --- .../uml/c3_dfetch_components_commands.puml | 32 +++++++++++++------ 1 file changed, 22 insertions(+), 10 deletions(-) diff --git a/doc/static/uml/c3_dfetch_components_commands.puml b/doc/static/uml/c3_dfetch_components_commands.puml index 905cc8fa..0fcb55c4 100644 --- a/doc/static/uml/c3_dfetch_components_commands.puml +++ b/doc/static/uml/c3_dfetch_components_commands.puml @@ -10,25 +10,29 @@ System_Boundary(DFetch, "Dfetch") { Component(compCommon, "Common", "python", "Does stuff") Component(compCommand, "Command", "python", "Does stuff") - Component(compCheck, "Check", "python", "Does stuff") - Component(compDiff, "Diff", "python", "Does stuff") - Component(compEnv, "Environment", "python", "Does stuff") - Component(compFreeze, "Freeze", "python", "Does stuff") - Component(compImport, "Import", "python", "Does stuff") - Component(compInit, "Init", "python", "Does stuff") - Component(compReport, "Report", "python", "Does stuff") - Component(compUpdate, "Update", "python", "Does stuff") - Component(compValidate, "Validate", "python", "Does stuff") + Component(compCheck, "Check", "python", "Checks for updates") + Component(compDiff, "Diff", "python", "Creates patch of local changes") + Component(compEnv, "Environment", "python", "Shows local tools") + Component(compFormatPatch, "FormatPatch", "python", "Format patch for export") + Component(compFreeze, "Freeze", "python", "Pins all projects") + Component(compImport, "Import", "python", "Imports from VCS") + Component(compInit, "Init", "python", "Initializes a manifest") + Component(compReport, "Report", "python", "Reports status") + Component(compUpdate, "Update", "python", "Updates all projects") + Component(compUpdatePatch, "UpdatePatch", "python", "Updates patch") + Component(compValidate, "Validate", "python", "Validates manifest") - Rel_U(compValidate, compCommand, "Extends") Rel_U(compCheck, compCommand, "Extends") Rel_U(compDiff, compCommand, "Extends") Rel_U(compEnv, compCommand, "Extends") + Rel_U(compFormatPatch, compCommand, "Extends") Rel_U(compFreeze, compCommand, "Extends") Rel_U(compImport, compCommand, "Extends") Rel_U(compInit, compCommand, "Extends") Rel_U(compReport, compCommand, "Extends") Rel_U(compUpdate, compCommand, "Extends") + Rel_U(compUpdatePatch, compCommand, "Extends") + Rel_U(compValidate, compCommand, "Extends") Rel_U(compUpdate, compCommon, "Uses") Rel_U(compCheck, compCommon, "Uses") @@ -48,6 +52,10 @@ System_Boundary(DFetch, "Dfetch") { Rel(compEnv, contProject, "Uses") + Rel(compFormatPatch, contManifest, "Uses") + Rel(compFormatPatch, contProject, "Uses") + Rel(compFormatPatch, contVcs, "Uses") + Rel(compFreeze, contManifest, "Uses") Rel(compFreeze, contProject, "Uses") @@ -62,6 +70,10 @@ System_Boundary(DFetch, "Dfetch") { Rel(compUpdate, contManifest, "Uses") Rel(compUpdate, contProject, "Uses") + Rel(compUpdatePatch, contManifest, "Uses") + Rel(compUpdatePatch, contProject, "Uses") + Rel(compUpdatePatch, contVcs, "Uses") + Rel(compValidate, contManifest, "Uses") Rel(contProject, contReporting, "Uses") From 7a3105c99d721e806954e404abd33be3fec86d55 Mon Sep 17 00:00:00 2001 From: Ben Spoor Date: Mon, 9 Feb 2026 22:41:35 +0100 Subject: [PATCH 4/5] Cleanup diagram. --- doc/static/uml/c3_dfetch_components_project.puml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/static/uml/c3_dfetch_components_project.puml b/doc/static/uml/c3_dfetch_components_project.puml index 1e683c56..dbbbb485 100644 --- a/doc/static/uml/c3_dfetch_components_project.puml +++ b/doc/static/uml/c3_dfetch_components_project.puml @@ -38,9 +38,9 @@ System_Boundary(DFetch, "Dfetch") { Rel(contCommands, compSubProject, "Uses") Rel(contReporting, compAbstractCheckReporter, "Implements") Rel_R(contReporting, compMetadata, "Uses") - Rel_R(compMetadata, contManifest, "Has") + Rel_U(compMetadata, contManifest, "Has") Rel(compSuperProject, contManifest, "Has") - Rel(contReporting, contManifest, "Uses") + Rel_U(contReporting, contManifest, "Uses") Rel(compGitSub, contVcs, "Uses") Rel(compSvnSub, contVcs, "Uses") Rel(compGitSuper, contVcs, "Uses") From c03c3207e2cc17076ae697b5608696db8fb2364b Mon Sep 17 00:00:00 2001 From: Ben Spoor <37540691+ben-edna@users.noreply.github.com> Date: Tue, 10 Feb 2026 17:04:56 +0000 Subject: [PATCH 5/5] Remove Does Stuff placeholders --- doc/static/uml/c3_dfetch_components_commands.puml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/static/uml/c3_dfetch_components_commands.puml b/doc/static/uml/c3_dfetch_components_commands.puml index 0fcb55c4..41964ca2 100644 --- a/doc/static/uml/c3_dfetch_components_commands.puml +++ b/doc/static/uml/c3_dfetch_components_commands.puml @@ -7,8 +7,8 @@ Person(user, "Developer") System_Boundary(DFetch, "Dfetch") { Boundary(DFetchCommands, "Commands") { - Component(compCommon, "Common", "python", "Does stuff") - Component(compCommand, "Command", "python", "Does stuff") + Component(compCommon, "Common", "python", "Common actions for commands") + Component(compCommand, "Command", "python", "Base class for commands") Component(compCheck, "Check", "python", "Checks for updates") Component(compDiff, "Diff", "python", "Creates patch of local changes")