Skip to content

Trim the README and move detail into docs #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hmirin wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Trim the README and move detail into docs #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6d40722
Trim the README and move detail into docs
hmirin Oct 14, 2026
5cbdb14
Show the three pillars as one figure and fold Performance into them
hmirin Oct 14, 2026
682550e
Drop the remote-growth claim for gcrypt and explain the full upload
hmirin Oct 14, 2026
c56e66e
Explain why gcrypt re-uploads the whole history
hmirin Oct 14, 2026
ac95864
Make Fast a benchmark panel in the pillars figure
hmirin Oct 14, 2026
739eb9d
Use gray for competitors in the Fast charts so green alone means git-…
hmirin Oct 14, 2026
3ae9aa4
Drop the remote-size row from the benchmark summary
hmirin Oct 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
293 changes: 68 additions & 225 deletions README.md
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion SECURITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Please report vulnerabilities privately to

`git-remote-e2ee` is an early prototype and has not been independently
audited. Its intended guarantees and known limits are listed in the
[README](README.md#security-model) and specified in [docs/design.md](docs/design.md) and
[security model](docs/security-model.md) and specified in [docs/design.md](docs/design.md) and
[docs/spec.md](docs/spec.md). Reports are especially welcome about:

- plaintext, refs, paths, or other inner metadata reaching storage;
Expand Down
130 changes: 130 additions & 0 deletions docs/art/pillars.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 4 additions & 5 deletions docs/benchmarks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ lightly loaded. The runner's `summary.md`:
| Data sent per tiny push | 4.5 KB | 921 MB | 8.9 KB |
| Peak memory, initial push | 1.27 GiB | 0.98 GiB | 1.27 GiB |
| Peak memory, tiny push | 37 MiB | 887 MiB | 9 MiB |
| Remote size after 5 tiny pushes | 891 MiB | 5,272 MiB | 878 MiB |
| Total client disk after fresh fetch (.git + auxiliary cache/state) | 891 MiB | 1,780 MiB | 1,779 MiB |

### Second macOS machine (2026-10-08)
Expand All @@ -61,7 +60,6 @@ run (load average about 7-16 on 10 cores). The ordering is identical:
| Data sent per tiny push | 4.8 KB | 921 MB | 9.5 KB |
| Peak memory, initial push | 1.27 GiB | 0.96 GiB | 1.27 GiB |
| Peak memory, tiny push | 37 MiB | 887 MiB | 9 MiB |
| Remote size after 5 tiny pushes | 891 MiB | 5,272 MiB | 878 MiB |
| Total client disk after fresh fetch (.git + auxiliary cache/state) | 891 MiB | 1,780 MiB | 1,779 MiB |

The sections below record earlier runs and the investigation that led here.
Expand Down Expand Up @@ -165,8 +163,10 @@ update followed by client object-store growth). RSS is MiB.
| 4 | 0.09 s / 37.3 MiB / 4,763 / 3,359 B | 25.50 s / 887.1 MiB / 921,318,660 / 9,706 B | 1.04 s / 39.0 MiB / 9,522 / 4,501 B |
| 5 | 0.08 s / 37.3 MiB / 4,759 / 3,356 B | 25.41 s / 887.1 MiB / 921,322,283 / 9,927 B | 1.15 s / 39.1 MiB / 9,577 / 4,498 B |

In the 2026-10-03 run, gcrypt added about 921 MiB to the remote on each tiny
push. E2EE's first tiny push took 5.20 s and used 522.3 MiB peak RSS. Later
In the 2026-10-03 run, gcrypt sent about 921 MiB on each tiny push. The
receiver kept every pack because of `receive.unpackLimit=0`; with Git's
defaults a host may discard the duplicate objects, so this is transfer, not
lasting storage growth. E2EE's first tiny push took 5.20 s and used 522.3 MiB peak RSS. Later
pushes took 1.32 to 1.53 s, used about 38 MiB, and added 9.3 to 9.6 KiB.
E2EE's median tiny push and fetch were below 1.5 s and 1.1 s, respectively.

Expand Down Expand Up @@ -266,7 +266,6 @@ later revisions default to `/var/tmp` on Linux.
| Data sent per tiny push | 4.5 KB | 921 MB | 8.9 KB |
| Peak memory, initial push | 1.11 GiB | 0.96 GiB | 1.11 GiB |
| Peak memory, tiny push | 44 MiB | 884 MiB | 48 MiB |
| Remote size after 5 tiny pushes | 891 MiB | 5,272 MiB | 878 MiB |
| Total client disk after fresh fetch (.git + auxiliary cache/state) | 891 MiB | 1,780 MiB | 1,779 MiB |

The ordering matches the macOS run except initial encryption, where gcrypt is
Expand Down
Loading
Loading