Skip to content

Commit 7ecf4e4

Browse files
daviesrobwhitwham
authored andcommitted
NEWS updates for autumn 2021 release
1 parent ab6065c commit 7ecf4e4

File tree

1 file changed

+86
-3
lines changed

1 file changed

+86
-3
lines changed

NEWS

Lines changed: 86 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,95 @@
11
Noteworthy changes in release a.b
22
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33

4-
* New API function hts_flush()/sam_flush()/bcf_flush() for flushing output
5-
htsFile/samFile/vcfFile streams. (PR #1326, thanks to John Marshall)
4+
Features and Updates
5+
--------------------
66

77
* Added a keep option to bgzip to leave the original file untouched. This
8-
brings bgzip into line with gzip. (PR #1331, thanks to Alex Petty).
8+
brings bgzip into line with gzip. (PR #1331, thanks to Alex Petty)
9+
10+
* "endpos" has been added to the filter language, giving the position
11+
of the rightmost mapped base as measured by the CIGAR string. For
12+
unmapped reads it is the same as "pos". (PR #1307, thanks to John Marshall)
13+
14+
* Interfaces have been added to interpret the new base modification tags
15+
added to the SAMtags document in samtools/hts-specs#418. (PR #1132)
16+
17+
* New API functions hts_flush()/sam_flush()/bcf_flush() for flushing output
18+
htsFile/samFile/vcfFile streams. (PR #1326, thanks to John Marshall)
19+
20+
* The synced_bcf_reader now sorts lines with symbolic alleles by END tag as
21+
well as POS. (PR #1321)
22+
23+
* Added synced_bcf_reader options BCF_SR_REGIONS_OVERLAP and
24+
BCF_SR_TARGETS_OVERLAP for better control of records that start outside
25+
the desired region but overlap it are handled. Fixes samtools/bcftools#1420
26+
and samtools/bcftools#1421 raised by John Marshall. (PR #1327)
27+
28+
* HTSlib will now accept long-cigar CG:B: tags made by htsjdk which don't
29+
quite follow the specification properly (using signed values instead of
30+
unsigned). Thanks to Colin Diesh for reporting an example file. (PR #1317)
31+
32+
* The warning printed when the BGZF reader finds a file with no EOF block
33+
has been changed to be less alarming. Unfortunately some third-party
34+
BGZF encoders don't write EOF blocks at the end of files. Thanks to
35+
Keiran Raine for reporting an example file. (PR #1323)
36+
37+
* The FASTA and FASTQ readers get an option to skip over the first item on
38+
the header line, and use the second as the read name. It allows the original
39+
name to be restored on some of the fastq files served from the European
40+
Nucleotide Archive (ENA). (PR #1325)
41+
42+
* HTSlib is now more strict when parsing the VCF samples line (beginning
43+
#CHROM). It will only accept tabs between the mandatory field names and
44+
sample names must be separated with tabs. (PR #1328)
45+
46+
* HTSlib will now warn if it looks like the header has been corrupted
47+
by diagnostic messages from the program that made it. This can happen when
48+
using `nohup`, which by default mixes stdout and stderr into the same
49+
stream. (PR#1339, thanks to John Marshall)
50+
51+
* File format detection will now recognise signatures for XZ, Zstd and D4
52+
files (note that HTSlib will not read them yet). (PR #1340, thanks to
53+
John Marshall)
54+
55+
Build changes
56+
-------------
57+
58+
These are compiler, configuration and makefile based changes.
59+
60+
* Some redundant tests have been removed from the test harness, speeding it up.
61+
(PR #1308)
62+
63+
* The version.sh script now works better on shallow checkouts. (PR #1324)
64+
65+
* A check-untracked Makefile target has been added to catch untracked files
66+
(mostly) left by the test harness. (PR #1324)
67+
68+
Bug fixes
69+
---------
70+
71+
* Fixed a case where flushing the thread pool could very occasionally cause
72+
a deadlock. (PR #1309)
73+
74+
* Fixed a bug where some CRAM files could fail to decode if the required_fields
75+
option was in use. Thanks to Matt Sexton for reporting the issue.
76+
(PR #1314, fixes samtools/samtools#1475)
77+
78+
* Fixed a regression where the S3 plugin could not read public files unless
79+
you supplied some Amazon credentials. Thanks to Chris Saunders for reporting.
80+
(PR #1332, fixes samtools/samtools#1491)
81+
82+
* Fixed a possible CRAM thread deadlock discovered by @ryancaicse.
83+
(PR #1330, fixes #1329)
84+
85+
* Some set-but-unused variables have been removed. (PR #1334)
86+
87+
* Fixed a bug which prevented "flag.read2" from working in the filter
88+
language unless it was at the end of the expression. Thanks to Vamsi Kodali
89+
for reporting the issue. (PR #1342)
990

91+
* Fixed a memory leak that could happen if CRAM fails to inflate a LZMA
92+
block. (PR #1340, thanks to John Marshall)
1093

1194
Noteworthy changes in release 1.13 (7th July 2021)
1295
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)