docs(readme): stop teaching the observe that cost #486 - #645
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Three corrections to the page a newcomer reads first, each verified against the source before
being changed (audit in #642).
defexample no longer teaches report a purged package as absent in apt.install #486. It askeddpkg -s "$pkg", which exits 0 for apackage removed without
--purge. It now carriesapt.install's real question, plus theparagraph that makes it a lesson rather than a snippet: the wrong answer was stable, so
re-running agreed with itself and only the machine said otherwise.
--json,-v,--parallel,--limitare in the flag table, with one line saying whichcommand takes what.
--checkstays undocumented on purpose — it is registered with an emptyusage string only to tell an operator the flag is now
--dry-run(ADR-0035).states the limit that is left — root on the target reads the job file and the process
environment in real time — and keeps ADR-0025 §3's
/tmpfallback, so it is not overclaimingeither.
The issue proposed
command -vfor the example. That is a second wrong question: the parameteris a package name, so it would work for
curland never converge forca-certificates.Test plan
The example was extracted from the README verbatim into a project and run against a real
Debian target — nothing validates README snippets today, so it was worth doing:
Step 5 is the point: the old spelling would have said
alreadythere.The flag claim is checked by loop against
cmd/shellf/main.go, not by eye — every flagrunCmd,statusCmdandcleanCmdregister now appears inREADME.md,checkexcepted.grep -c "at-rest secrecy is not yet solved" README.md→ 0.go test ./...,test/lint.shandtest/changelog-rule.shgreen.Not here
README.md:39tells a newcomer to downloadv0.10.0, three releases back. Flagged in #642'saudit, left for its own issue.
Closes #642