Improve help text about hidden repos #1471
Conversation
|
Sounds good, I'll have a commit that removes the mention of worktrees in a couple of minutes. |
|
I've done that in fcebc44. Because of the way it was done, all three of the commits here are prefixed |
EliahKagan
changed the title
|
I think it's fair to use |
EliahKagan
changed the title
Each one was something I intended at the time given what had come before, but none of these messages are really ideal now -- they basically all have to be read together. On the other hand, they do make clear what the progression was in relation to the changes from #1470. Maybe the best thing to do would be if I were to rebase this to edit the message in the first commit, 7a4d239, to remove |
This slightly expands the wording of the warning suggesting to use `--skip-hidden-repositories`, so that it notes that worktrees and not just separate repositories are at stake.
This adds information to the help text for the `git clean` options `-r`/`--repositories` and `--skip-hidden-repositories` to make it clearer what their relationship is, avoid creating the false impression that repositories are never deleted in the absence of `-r`/`--repositories`, and note that `--skip-hidden-repositories` is sometimes needed to preserve not only separate repositories but the (probably rarer) case of hidden nested worktrees of the current repository.
Since GitoxideLabs#1470 (for GitoxideLabs#1469), the repository's own nested worktrees are no longer removed when using `gix clean`, even if they are nested arbitarily under ignored directories. So no new mention of worktrees (separate from "repositories") in the help and warning message is accurate or required. This removes that, which means really we are keeping the warning message the same as it had been earlier, while still otherwise bringing in new explanatory text in the `gix clean` options help.
|
Thanks again for all the great work! |
Note: This PR
is either mostly or completelywas in substantial part superseded by #1470 as discussed in #1469, and has been narrowed in scope. The following description does not reflect that.Changes to the warning message
In the first commit, this unconditionally augments the warning suggesting to use
--skip-hidden-repositoriesso that it mentions worktrees as well. It shows that slightly longer message even in a repository that has no worktrees. This has the benefit of simplicity, is the requested change in #1469 (comment) if I understand properly, and makes sense as an initial mitigation for #1469.The message is not much longer, and if that level of detail is acceptable, it might even be okay to have it like this longer term, though I suspect it might not be necessary given other forthcoming changes.
I considered parenthesizing "and worktrees" but it looked to like "repositories (and worktrees)" could be misread as "repositories (and their worktrees)" to mean the same thing as "repositories."
I did not make a corresponding change in the other similarly worded warning message suggesting to use
--find-untracked-repositories, because there does not appear to be an analogous situation with untracked directories where a worktree of the current repository would be removed. I did some testing to check this.Changes to the help text
It seemed like the right time to also propose changes to the help text for
gix cleanoptions directly relevant to the deletion of nested repositories, since I was already planning to do that for-r. In the second commit, this does that, at least an an initial wording that might be possible to improve on, and also applies an analogous change--but with more details, since this is help text--to the change in the warning message.I made them separate commits so it's easy to take only one (I imagine it would be the first) if not all these changes are wanted at this time.
Commit messages
Even though this only adjusts messages, from this guideline it seems like the commits should have
fix:prefixes, so I did that. I'm not sure if that's right. This PR does not carry any behavioral change other than the text of messages that are displayed.