Skip to content

docs: update README and add CHANGELOG#90

Open
leno23 wants to merge 1 commit into
dolph:mainfrom
leno23:docs/readme-changelog-issue-20-v2
Open

docs: update README and add CHANGELOG#90
leno23 wants to merge 1 commit into
dolph:mainfrom
leno23:docs/readme-changelog-issue-20-v2

Conversation

@leno23
Copy link
Copy Markdown

@leno23 leno23 commented May 30, 2026

Fixes #20

Made with Cursor

Document exit codes, rename refusal, and security expectations. Add a
CHANGELOG with an Unreleased section covering recent reliability work.

Fixes dolph#20
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 32ffd3c454

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md

## Security model

`find-replace` is intended for batch find/replace in a working tree you control. It performs atomic rewrites via a temporary file in the same directory and does not overwrite an existing destination during rename. Run it only in trusted directories; symlink hardening is not a current guarantee—see open issues for planned improvements.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Avoid promising overwrite protection for renames

This overstates the rename safety guarantee: RenameFile checks os.Stat(newPath) and then calls os.Rename(f.Path, newPath), so if a destination is created between those calls (or for cases like a broken symlink that os.Stat treats as not existing), POSIX rename can still clobber it. In any directory with concurrent file activity, the README now tells users the tool “does not overwrite an existing destination” even though the implementation only best-effort refuses destinations observed before the rename.

Useful? React with 👍 / 👎.

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.

README and CHANGELOG are out of date with new behavior

1 participant