From 2a1c7906550a2c4a0946e77030cecc60e2941b06 Mon Sep 17 00:00:00 2001 From: Dan Helfman Date: Wed, 26 Jun 2024 19:39:32 -0700 Subject: [PATCH] Minor reorganization of borgmatic source code reference. --- docs/_includes/index.css | 9 ++++----- docs/reference/source-code.md | 17 +++++++---------- 2 files changed, 11 insertions(+), 15 deletions(-) diff --git a/docs/_includes/index.css b/docs/_includes/index.css index 9b7dce5..56841ec 100644 --- a/docs/_includes/index.css +++ b/docs/_includes/index.css @@ -167,12 +167,11 @@ li { padding: .25em 0; } li ul { - margin: .5em 0; - padding-left: 1em; + list-style-type: disc; + padding-left: 2em; } -li li { - padding-top: .1em; - padding-bottom: .1em; +li li:last-child { + padding-bottom: 0em; } /* Syntax highlighting and Code blocks */ diff --git a/docs/reference/source-code.md b/docs/reference/source-code.md index 90e4c10..9deadcf 100644 --- a/docs/reference/source-code.md +++ b/docs/reference/source-code.md @@ -10,20 +10,17 @@ eleventyNavigation: If case you're interested in [developing on borgmatic](https://torsion.org/borgmatic/docs/how-to/develop-on-borgmatic/), here's an abridged primer on how its Python source code is organized to help -you get started. At the top level we have: +you get started. Starting at the top level, we have: - * [borgmatic](https://projects.torsion.org/borgmatic-collective/borgmatic/src/branch/main/borgmatic): The main borgmatic source module. Most of the code is here. + * [borgmatic](https://projects.torsion.org/borgmatic-collective/borgmatic/src/branch/main/borgmatic): The main borgmatic source module. Most of the code is here. Within that: + * [actions](https://projects.torsion.org/borgmatic-collective/borgmatic/src/branch/main/borgmatic/actions): borgmatic-specific logic for running each action (create, list, check, etc.). + * [borg](https://projects.torsion.org/borgmatic-collective/borgmatic/src/branch/main/borgmatic/borg): Lower-level code that's responsible for interacting with Borg to run each action. + * [commands](https://projects.torsion.org/borgmatic-collective/borgmatic/src/branch/main/borgmatic/commands): Looking to add a new flag or action? Start here. This contains borgmatic's entry point, argument parsing, and shell completion. + * [config](https://projects.torsion.org/borgmatic-collective/borgmatic/src/branch/main/borgmatic/config): Code responsible for loading, normalizing, and validating borgmatic's configuration. + * [hooks](https://projects.torsion.org/borgmatic-collective/borgmatic/src/branch/main/borgmatic/hooks): Looking to add a new database or monitoring integration? Start here. * [docs](https://projects.torsion.org/borgmatic-collective/borgmatic/src/branch/main/docs): How-to and reference documentation, including the document you're reading now. * [sample](https://projects.torsion.org/borgmatic-collective/borgmatic/src/branch/main/sample): Example configurations for cron and systemd. * [scripts](https://projects.torsion.org/borgmatic-collective/borgmatic/src/branch/main/scripts): Dev-facing scripts for things like building documentation and running end-to-end tests. * [tests](https://projects.torsion.org/borgmatic-collective/borgmatic/src/branch/main/tests): Automated tests organized by: end-to-end, integration, and unit. -Within the `borgmatic` directory you'll find: - - * [actions](https://projects.torsion.org/borgmatic-collective/borgmatic/src/branch/main/borgmatic/actions): Mid-level code for running each borgmatic action (create, list, check, etc.). - * [borg](https://projects.torsion.org/borgmatic-collective/borgmatic/src/branch/main/borgmatic/borg): Lower-level code that actually shells out to Borg for each action. - * [commands](https://projects.torsion.org/borgmatic-collective/borgmatic/src/branch/main/borgmatic/commands): Looking to add a new flag or action? Start here. This contains borgmatic's entry point, argument parsing, and shell completion. - * [config](https://projects.torsion.org/borgmatic-collective/borgmatic/src/branch/main/borgmatic/config): Code responsible for loading, normalizing, and validating borgmatic's configuration. - * [hooks](https://projects.torsion.org/borgmatic-collective/borgmatic/src/branch/main/borgmatic/hooks): Looking to add a new database or monitoring integration? Start here. - So, broadly speaking, the control flow goes: `commands` → `config` followed by `commands` → `actions` → `borg` and `hooks`.