Skip to content

docs: remove legacy prototype and describe the v2 system - #6

Merged
mattmattox merged 4 commits into
mainfrom
claude/docs-hygiene-7ff39c
Oct 24, 2026
Merged

mattmattox merged 4 commits into
mainfrom
claude/docs-hygiene-7ff39c

Conversation

@mattmattox

Copy link
Copy Markdown
Contributor

Deletes the root gob prototype main.go, rewrites CLAUDE.md for the real system, and fixes the README quick start and fsck usage.

Verified on Linux 7.0 (172.25.1.68): go build ./... and go vet ./... pass, and the quick start runs verbatim from a fresh clone. make build builds goclusterfs-fsck only after #5 merges.

Code gaps found (documented, not fixed):

  • -format writes no superblock, so fsck aborts at phase 1 (exit 2).
  • All nodes share one journal region at 5 MB.
  • SFB writes use unaligned buffers and always fall back to full blocks.

docs/OPERATIONS.md, TROUBLESHOOTING.md, and DEPLOYMENT.md still use the wrong fsck and format commands.

🤖 Generated with Claude Code

mattmattox and others added 4 commits October 24, 2026 04:23
The root main.go was the original single-block gob prototype. The real
filesystem lives in cmd/mount, cmd/fsck and internal/. Nothing builds,
tests or imports the root package.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
CLAUDE.md described the deleted prototype. It now covers the real
package map, the on-disk layout from cmd/mount, build and run commands,
and current limitations.

The README quick start used a binary name and flags that do not exist.
It now uses make build output and the real goclusterfs-mount and
goclusterfs-fsck flags. fsck takes the device as a positional argument.
It also notes that fsck rejects volumes made by -format, because
cmd/mount does not write a superblock.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Verified on Linux 7.0: tmpfs images work with O_DIRECT, and SFB
container writes fail with an unaligned-buffer error.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The table exists only on local main and still names the deleted root
binary. Adding it here with the real build command makes the later
merge of local main resolve to this version.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mattmattox
mattmattox merged commit 92f024b into main Oct 24, 2026
3 checks passed
mattmattox added a commit that referenced this pull request Oct 24, 2026
…rnal fixes

Cover PRs #5, #6, #7 and #10, which merged to main.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
mattmattox added a commit that referenced this pull request Oct 24, 2026
…elog, and templates (#9)

* docs: add security policy, contributing guide, code of conduct, changelog, and templates

Adds the community files GitHub expects for a public release:
SECURITY.md (GitHub private vulnerability reporting, main only),
CONTRIBUTING.md, CODE_OF_CONDUCT.md (Contributor Covenant 2.1),
CHANGELOG.md with an Unreleased section, issue templates, and a
pull request template.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* docs: correct build, CI, and changelog claims in community files

Write CONTRIBUTING against main after the CI gates PR: make build also
builds goclusterfs-fsck, and CI adds golangci-lint, govulncheck, a
go mod tidy check, and race/coverage unit tests.

In the changelog, mark SFB, snapshots/clones, and fsck as experimental
with their known issues, say file writes skip the distributed locks,
and narrow the concurrency fix to create/mkdir lock ordering.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* docs(changelog): add upgrade notes for mixed-version clusters

Older binaries zero an inode's generations on free and its extent-tree
generation on rewrite, so all nodes must be upgraded together.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* docs(changelog): add CI gates, prototype removal, stale-inode and journal fixes

Cover PRs #5, #6, #7 and #10, which merged to main.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant