Skip to content

Commit 70f9222

Browse files
committed
chore(debugging): expand the file debugging notes a bit
Signed-off-by: Jakob Borg <[email protected]>
1 parent e604546 commit 70f9222

File tree

1 file changed

+25
-9
lines changed

1 file changed

+25
-9
lines changed

dev/debugging.rst

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,36 @@ look closer at what Syncthing knows about the file. You'll need to do these
2323
steps on *both* the receiving side and sending side. We will need to use the
2424
Syncthing CLI for this.
2525

26-
1. An extract of database metadata for the file, taked by the command
27-
``syncthing debug database-file $folderID $fileName``, where
28-
``$folderID`` represents the folder ID (e.g. ``abcd-1234``) and
29-
``fileName`` is the name of the file, including any directories, relative
30-
to the folder root. (Syncthing v2 only; but we're probably not debugging
31-
this on v1 any more.)
26+
First, an extract of database metadata for the file, taked by the command::
3227

33-
2. Details of the file information for the file, taked by the command
34-
``syncthing cli debug file $folderID $fileName`` (same folder ID and file
35-
name as above).
28+
syncthing debug database-file $folderID $fileName
29+
30+
The ``$folderID`` placeholder represents the folder ID (e.g. ``abcd-1234``)
31+
and ``fileName`` is the name of the file, including any directories,
32+
relative to the folder root. Make sure to use quotes around the file name if
33+
it includes spaces.
34+
35+
Second, details of the file information for the file in question, taked by
36+
the command::
37+
38+
syncthing cli debug file $folderID $fileName
39+
40+
Use the same folder ID and file name as above.
3641

3742
Post the output from both of these, verbatim, indicating which is the
3843
receiving side and which is the sending side.
3944

45+
The folder counts seem incorrect
46+
--------------------------------
47+
48+
If the number of files in sync, out of sync, in total, etc. seem to be
49+
incorrect, we can inspect the raw counts in the database. Run the following
50+
command on *both the sending and receiving sides* and post the output::
51+
52+
syncthing debug database-counts $folderID
53+
54+
The ``$folderID`` placeholder represents the folder ID (e.g. ``abcd-1234``).
55+
4056
Debug logs
4157
----------
4258

0 commit comments

Comments
 (0)