chore: clarify database resetting options#1013
Merged
Merged
Conversation
This was removed in Syncthing v2. Simply avoid mentioning it. Signed-off-by: André Colomb <src@andre.colomb.de>
Clarify that "cli debug" commands do not require Syncthing to be stopped, while in fact removing the database completely should not be done while it is running. Point to the corresponding API endpoint /rest/system/reset for more granular DB reset functionality. Signed-off-by: André Colomb <src@andre.colomb.de>
Currently not used as a target anywhere, but might prove useful for a future FAQ. Add the includes top-level directory to the exclusion list for Sphinx. Documents in there are always used via an include:: directive, so processing them as (unreachable) standalone documents leads to duplicate label warnings. Signed-off-by: André Colomb <src@andre.colomb.de>
The cautionary note was removed in v2 together with the whole option. Resurrect the text from the old option doc. Signed-off-by: André Colomb <src@andre.colomb.de>
Member
Author
|
Original PR removing the option docs: https://github.com/syncthing/docs/pull/901/changes#diff-1ebbe3e558eef27002e0596d87f14b08e185889d51b596af4dba2e5046b67dd7 |
Member
Author
|
@calmh could you clarify whether the |
Member
|
It's technically correct, I'm not certain about the relevance. The normal warning about missing files getting marked deleted won't apply since the database is getting reset, but I suppose it could result in a folder marker getting created where one wasn't expected if a disk wasn't mounted etc, so, sure. |
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
3 participants
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.
The
--reset-deltasand--reset-databaseoptions were removed in Syncthing v2. Fix leftover references and in the process, document the currentsyncthing debug ...subcommand group, wherereset-databasenow lives.See individual commit messages for details. The last one I'm not quite sure about. I resurrected the removed text from the
--reset-databaseoption docs, but couldn't verify that the corresponding API endpoint actually does recreate.stfoldermarkers. Maybe this behavior was also removed in v2? I haven't dug deep enough to be sure.