Skip to content

Commit 7414961

Browse files
Quick docs for logging issue
Closes #312
1 parent 147231e commit 7414961

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/vcf2zarr/overview.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,20 @@ if you would like to see other fields supported, or to help out with
128128
implementing more.
129129
:::
130130

131+
## Debugging
132+
133+
When things go wrong with conversion, it's very useful to generate some
134+
debugging information using the ``-v`` or ``-vv`` options. These can
135+
help identify what's going wrong (usually running out of memory).
136+
137+
:::{warning}
138+
To get the full logging output you **must use** -p0, such that no multiprocessing
139+
is used. This means that tracking down problems can be slow, unfortunately.
140+
This is due to a bug in the way logging from child processes is handled;
141+
see [issue 302](https://github.com/sgkit-dev/bio2zarr/issues/302) for details.
142+
:::
143+
144+
131145

132146
## Copying to object stores
133147

0 commit comments

Comments
 (0)