Repository navigation
docs(readme): write the rollback path (roadmap row 4's documentable half) - #64
Merged
Merged
Conversation
…alf) Row 4 asked for four things; three were already covered by CI and one was not written down anywhere: how to get out. Added as README section 6 in both languages. Everything here is verified rather than recalled: - apt remove vs purge: the .deb installs clean job already asserts nextless.conf and nextless-get-models disappear on remove, that dpkg reports "deinstall ok config-files" (the /etc/nextless conffiles survive on purpose), and that purge takes /etc/nextless/advanced.json with it. The README states exactly that, no more. - meson install has no uninstall, but it writes build/meson-logs/install-log.txt - 13 absolute paths for this prefix, dry-run listed here before publishing the removal one-liner, with the caveat that a stale log from a reconfigured prefix no longer describes the machine. - The home directories neither route touches, with sizes measured on this box (settings ~30 KB including any API keys, models 1.8 GB, opt-in deep-filter 35 MB), and the autoremove caveat: removing the add-on never removes fcitx5, but a later autoremove can offer to if nothing else depends on it. - The check that makes a stale install visible: fcitx5-diagnose | grep -i nextless. Found the need for it today - this machine had been bumped to 0.3.x and still advertises "Nextless 0.2.0", because the add-on was never reinstalled or reloaded. Nothing in the UI tells you. Row 4 now says what is left: a human dictating one sentence on a clean Ubuntu VM. Docs-only; suite unchanged at 21/21.
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
1 participant
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.
Why
Roadmap row 4's finish line was four things: clean-VM install, a human dictating
on it,
apt removeleaving no debris, and rollback documented. Three of thefour were already covered by CI; the fourth existed nowhere. This writes it, in
both READMEs (new section 6).
Everything in it is verified, not recalled
apt removetakes the add-on.so,nextless-get-modelsandnextless.conf;purgealso drops/etc/nextless.deb installs cleanjob already asserts precisely these paths (test ! -e ...) and thedeinstall ok config-filesstatusmeson installcan be undone frombuild/meson-logs/install-log.txtdeep-filter35 MBdu -shon this boxfcitx5-diagnose | grep -i nextlessas the version checkNextless 0.2.0while the tree and the release are0.3.1, andbuild/adapter/src/nextless.confcorrectly generatesVersion=0.3.1- i.e. the running add-on is simply the October installThat last row is the reason the section exists. A stale install is invisible: the
panel still works, the key still triggers, and the version the add-on advertises
is from whenever someone last ran the install step. The README now tells you to
ask fcitx5 which one is loaded instead of trusting
meson installran.Also in it
sudo dpkg -i <older>.deb) - the premise ofinstall-deb.shis that a new release can be the broken one, so the way back needs a sentence.
apt autoremovecaveat: removing Nextless never removes fcitx5, but on amachine where nothing else depends on fcitx5, a later autoremove can offer to.
written with, and that it deletes files, not directories.
Roadmap row 4 updated to name the one remaining item: a human dictating one
sentence on a clean Ubuntu VM (AUR stays #35). Docs only; suite unchanged at
21/21.