users/crashrep: Add note about using custom builds of Syncthing#540
users/crashrep: Add note about using custom builds of Syncthing#540calmh merged 5 commits intosyncthing:mainfrom
Conversation
|
This sounds to me like if you're using any custom build and it crashes we will report your username etc, which is not the case. I'd say something about the fact that the binary includes information about who built it, and that this is essential to interpreting the crash report in context. |
|
I think this should clarify that those things get embedded in the version, and the version gets reported as part of the crash report |
|
I think that I have included all the requested changes in the note. Is it fine now? |
users/crashrep.rst
Outdated
| main.syncthingMain(0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x49651b4, 0x1, 0x0, 0x0, ...) | ||
| /buildagent/work/github.com/syncthing/syncthing/cmd/syncthing/main.go:873 +0x1bc5 | ||
|
|
||
| Note that when using a custom compiled build, the names of the domain, |
There was a problem hiding this comment.
s/when using a custom compiled build,// ?
users/crashrep.rst
Outdated
| included in the log as part of the version string. This information is | ||
| essential for the developers to interpret the crash log in context. If | ||
| you compile Synching locally and want to prevent your build from having | ||
| such data embedded, set the ``COMPUTERNAME``, ``USERDOMAIN``, and |
There was a problem hiding this comment.
I'm not sure where these variables come from but they don't appear to be what we actually look at
https://github.com/syncthing/syncthing/blob/a85bc1c3a64e33f1c42fe6e1dbeb19a953d01431/build.go#L999
There was a problem hiding this comment.
There should be instructions on tweaking the compiled in metadata on the build page, and we should link to that from here rather than duplicating, I think
There was a problem hiding this comment.
We can refer to https://docs.syncthing.net/dev/building.html#version-tagging by
:ref:`versiontagging`
There was a problem hiding this comment.
The variables come from https://forum.syncthing.net/t/15417/7. I must admit though that I have not tested them myself, but rather just believed the word 😯.
I will try to make all the changes shortly, but let me first actually compile and test everything myself just to make sure that there are no further similar flops on my part.
There was a problem hiding this comment.
I have simplified and rewritten the note to match the terminology used in https://docs.syncthing.net/dev/building.html#version-tagging. I have also tested the compilation, and indeed the variables listed by @calmh are the right ones, while the other ones do not do anything.
Add a note explaining the inclusion of information such as the user's computer, domain, and user name in the crash logs. Also, provide a solution on how not to include those when building Syncthing locally. Signed-off-by: Tomasz Wilczyński <twilczynski@naver.com>
tomasz1986
force-pushed
the
tomasz86-crashrep-localbuild
branch
from
3ea015f to
a7e43f0
Compare
4 participants
Add a note explaining the inclusion of information such as the user's
computer, domain, and user name in the crash logs. Also, provide a
solution on how not to include those when building Syncthing locally.
Signed-off-by: Tomasz Wilczyński twilczynski@naver.com