-
Notifications
You must be signed in to change notification settings - Fork 242
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
split async samtools and tribble options #529
Conversation
@@ -19,9 +19,18 @@ | |||
/** Should MD5 files be created when writing out SAM and BAM files? Default = false. */ | |||
public static final boolean CREATE_MD5; | |||
|
|||
/** Should asynchronous I/O be used when writing out SAM and BAM files (one thread per file). Default = false. */ | |||
/** Should asynchronous I/O be used when writing out SAM, BAM, FASTQ files (one thread per file). Default = false. */ | |||
@Deprecated |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think this should be deprecated. The semantics of this option are actually unchanged -- differences only arise if you opt-in to use of one of the two new options below.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, you should mention explicitly in the docs for both this option and the others below that this option takes precedence over the other two.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
Review complete -- back to @akiezun |
back to @droazen |
@@ -19,9 +22,26 @@ | |||
/** Should MD5 files be created when writing out SAM and BAM files? Default = false. */ | |||
public static final boolean CREATE_MD5; | |||
|
|||
/** Should asynchronous I/O be used when writing out SAM and BAM files (one thread per file). Default = false. */ | |||
/** Should asynchronous I/O be used where supported in tribble/samtools/etc. (one thread per file). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"in tribble/samtools/etc." -> "throughout all of htsjdk"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
Second-pass review complete -- back to @akiezun. Merge after addressing comments. |
10ec16c
to
32dfc5a
Compare
split async samtools and tribble options
Description
This PR takes over from #528 and splits
USE_ASYNC_IO
into 2 options,USE_ASYNC_IO_FOR_SAMTOOLS
andUSE_ASYNC_IO_FOR_TRIBBLE
because clients like GATK want more fine grained controls and also the performance characteristics of samtools vs tribble are very different (see #528) for examples and timings.@droazen can you review? @yfarjoun FYI