Skip to content

Commit 10fe37f

Browse files
val-msval-ms
committed
Project home is now now gitlab.com/bzip2
Explain why bzip2 has repositories on sourceware.org and gitlab.com. Change error messages in bzip2 source to request that bugs be reported to project's gitlab issues page. Fixup project homepage in various documents to point to gitlab project. Remove trailing whitespace from a few documents. Update the Release Checklist. Add myself as new maintainer.
1 parent 5d159ca commit 10fe37f

12 files changed

+139
-117
lines changed

‎README.md

+71-57
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,26 @@
11
Bzip2
22
=====
33

4-
This Bzip2/libbz2, a program and library for lossless, block-sorting
5-
data compression.
4+
This is Bzip2/libbz2; a program and library for lossless, block-sorting data
5+
compression.
6+
7+
This document pertains to the Bzip2 feature development effort hosted on
8+
[GitLab.com](https://gitlab.com/bzip2/bzip2).
9+
10+
The documentation here may differ from that on the Bzip2 1.0.x project page
11+
maintained by Mark Wielaard on[sourceware.org](https://sourceware.org/bzip2/).
612

713
Copyright (C) 1996-2010 Julian Seward <[email protected]>
814

9-
Copyright (C) 2019 Federico Mena Quintero <[email protected]>
15+
Copyright (C) 2019-2020 Federico Mena Quintero <[email protected]>
1016

11-
Please read the [WARNING], [DISCLAIMER] and [PATENTS] sections in this
12-
file for important information.
17+
Copyright (C) 2021 [Micah Snyder](https://gitlab.com/micahsnyder).
1318

14-
This program is released under the terms of the license contained
15-
in the file [COPYING].
19+
Please read the [WARNING](#warning), [DISCLAIMER](#disclaimer) and
20+
[PATENTS](#patents) sections in this file for important information.
1621

17-
[WARNING]: #warning
18-
[DISCLAIMER]: #disclaimer
19-
[PATENTS]: #patents
20-
[COPYING]: COPYING
22+
This program is released under the terms of the license contained in the
23+
[COPYING](COPYING) file.
2124

2225
------------------------------------------------------------------
2326

@@ -27,80 +30,91 @@ Complete documentation is available in Postscript form (manual.ps),
2730
PDF (manual.pdf) or HTML (manual.html). A plain-text version of the
2831
manual page is available as bzip2.txt.
2932

33+
## Community Code of Conduct
34+
35+
There is a code of conduct for contributors to Bzip2/libbz2.
36+
Please see the [`code-of-conduct.md`](code-of-conduct.md) file.
37+
3038
## Contributing to Bzip2's development
3139

32-
There is a code of conduct for contributors to Bzip2/libbz2; please
33-
see the file [`code-of-conduct.md`][coc].
40+
The Bzip2 project is hosted on GitLab for feature development work.
41+
It can be found at https://gitlab.com/bzip2/bzip2
3442

35-
Bzip2's source repository is at gitlab.com. You can view the web
36-
interface here:
43+
Changes to be included in the next feature version are committed to the
44+
`master` branch.
3745

38-
https://gitlab.com/bzip2/bzip2
46+
Feature releases are maintained in `release/*` branches.
3947

40-
Maintenance happens in the `master` branch. There is an effort to port
41-
Bzip2 gradually to [Rust] in a `rustify` branch.
48+
Long-term feature and experimental development will occur in feature branches.
49+
*Feature branches are unstable.* Feature branches may be rebased and force-
50+
pushed on occasion to keep them up-to-date and to resolve merge conflicts.
4251

43-
To report bugs, or to view existing reports, please do so in [Bzip2's
44-
repository][gitlab] as well.
52+
The `rustify` branch is a feature branch that represents an effort to
53+
gradually port Bzip2 to [Rust](https://www.rust-lang.org).
4554

46-
[coc]: code-of-conduct.md
47-
[gitlab]: https://gitlab.com/bzip2/bzip2/issues
48-
[Rust]: https://www.rust-lang.org
55+
## Report a Bug
4956

57+
Please report bugs via [GitLab Issues](https://gitlab.com/bzip2/bzip2/issues).
5058

51-
## Compiling Bzip2 and libbz2
59+
Before you create a new issue, please verify that no one else has already
60+
reported the same issue.
5261

53-
Please see the [`COMPILING.md`][COMPILING.md] file for details. This includes
54-
instructions for buliding using Meson, CMake, or nmake.
62+
## Compiling Bzip2 and libbz2
5563

56-
[COMPILING.md]: COMPILING.md
64+
Please see the [`COMPILING.md`](COMPILING.md) file for details.
65+
This includes instructions for buliding using Meson, CMake, or nmake.
5766

5867
## WARNING
5968

60-
This program and library (attempts to) compress data by
61-
performing several non-trivial transformations on it.
62-
Unless you are 100% familiar with *all* the algorithms contained
63-
herein, and with the consequences of modifying them, you should NOT
64-
meddle with the compression or decompression machinery. Incorrect
65-
changes can and very likely *will* lead to disastrous loss of data.
69+
This program and library (attempts to) compress data by performing several
70+
non-trivial transformations on it. Unless you are 100% familiar with *all* the
71+
algorithms contained herein, and with the consequences of modifying them, you
72+
should NOT meddle with the compression or decompression machinery.
73+
Incorrect changes can and very likely *will* lead to disastrous loss of data.
6674

6775
**Please contact the maintainers if you want to modify the algorithms.**
6876

6977
## DISCLAIMER
7078

71-
**I TAKE NO RESPONSIBILITY FOR ANY LOSS OF DATA ARISING FROM THE
72-
USE OF THIS PROGRAM/LIBRARY, HOWSOEVER CAUSED.**
79+
**I TAKE NO RESPONSIBILITY FOR ANY LOSS OF DATA ARISING FROM THE USE OF THIS
80+
PROGRAM/LIBRARY, HOWSOEVER CAUSED.**
7381

74-
Every compression of a file implies an assumption that the
75-
compressed file can be decompressed to reproduce the original.
76-
Great efforts in design, coding and testing have been made to
77-
ensure that this program works correctly. However, the complexity
78-
of the algorithms, and, in particular, the presence of various
79-
special cases in the code which occur with very low but non-zero
80-
probability make it impossible to rule out the possibility of bugs
81-
remaining in the program. DO NOT COMPRESS ANY DATA WITH THIS
82-
PROGRAM UNLESS YOU ARE PREPARED TO ACCEPT THE POSSIBILITY, HOWEVER
83-
SMALL, THAT THE DATA WILL NOT BE RECOVERABLE.
82+
Every compression of a file implies an assumption that the compressed file can
83+
be decompressed to reproduce the original. Great efforts in design, coding and
84+
testing have been made to ensure that this program works correctly.
85+
86+
However, the complexity of the algorithms, and, in particular, the presence of
87+
various special cases in the code which occur with very low but non-zero
88+
probability make it impossible to rule out the possibility of bugs remaining in
89+
the program.
90+
91+
DO NOT COMPRESS ANY DATA WITH THIS PROGRAM UNLESS YOU ARE PREPARED TO ACCEPT
92+
THE POSSIBILITY, HOWEVER SMALL, THAT THE DATA WILL NOT BE RECOVERABLE.
8493

8594
That is not to say this program is inherently unreliable.
86-
Indeed, I very much hope the opposite is true. Bzip2/libbz2
87-
has been carefully constructed and extensively tested.
95+
Indeed, I very much hope the opposite is true.
96+
Bzip2/libbz2 has been carefully constructed and extensively tested.
8897

8998
## PATENTS
9099

91-
To the best of my knowledge, Bzip2/libbz2 does not use any patented
92-
algorithms. However, I do not have the resources to carry out a
93-
patent search. Therefore I cannot give any guarantee of the above
94-
statement.
100+
To the best of my knowledge, Bzip2/libbz2 does not use any patented algorithms.
101+
However, I do not have the resources to carry out a patent search.
102+
Therefore I cannot give any guarantee of the above statement.
95103

96104
## Maintainers
97105

98-
Since June 2021, the maintainer of Bzip2/libbz2 is Micah Snyder.
106+
As of June 2021, [Micah Snyder](https://gitlab.com/micahsnyder) is the
107+
maintainer of Bzip2/libbz2 for feature development work (I.e. versions 1.1+).
108+
109+
The Bzip2 feature development project is hosted on GitLab and can be found at
110+
https://gitlab.com/bzip2/bzip2
111+
112+
Bzip2 version 1.0 is maintained by [Mark Wielaard](https://www.klomp.org/mark/)
113+
at Sourceware and can be found at https://sourceware.org/git/?p=bzip2.git
99114

100115
### Special thanks
101116

102-
Thanks to Julian Seward, the original author of Bzip2/libbz2, for
103-
creating the program and making it a very compelling alternative to
104-
previous compression programs back in the early 2000's. Thanks to
105-
Julian also for letting Federico carry on with the maintainership of
106-
the program.
117+
Thanks to Julian Seward, the original author of Bzip2/libbz2, for creating the
118+
program and making it a very compelling alternative to previous compression
119+
programs back in the early 2000's. Thanks to Julian also for letting Federico,
120+
Mark, and Micah carry on with the maintainership of the program.

‎bzip2.c

+4-4
Original file line numberDiff line numberDiff line change
@@ -724,8 +724,8 @@ void panic ( const Char* s )
724724
fprintf ( stderr,
725725
"\n%s: PANIC -- internal consistency error:\n"
726726
"\t%s\n"
727-
"\tThis is a BUG. Please report it to me at:\n"
728-
"\[email protected]\n",
727+
"\tThis is a BUG. Please report it at:\n"
728+
"\thttps://gitlab.com/bzip2/bzip2/-/issues\n",
729729
progName, s );
730730
showFileNames();
731731
cleanUpAndFail( 3 );
@@ -804,7 +804,7 @@ void mySIGSEGVorSIGBUScatcher ( IntNative n )
804804
" The user's manual, Section 4.3, has more info on (1) and (2).\n"
805805
" \n"
806806
" If you suspect this is a bug in bzip2, or are unsure about (1)\n"
807-
" or (2), feel free to report it to: bzip2[email protected].\n"
807+
" or (2), report it at: https://gitlab.com/bzip2/bzip2/-/issues\n"
808808
" Section 4.3 of the user's manual describes the info a useful\n"
809809
" bug report should have. If the manual is available on your\n"
810810
" system, please try and read it before mailing me. If you don't\n"
@@ -824,7 +824,7 @@ void mySIGSEGVorSIGBUScatcher ( IntNative n )
824824
" The user's manual, Section 4.3, has more info on (2) and (3).\n"
825825
" \n"
826826
" If you suspect this is a bug in bzip2, or are unsure about (2)\n"
827-
" or (3), feel free to report it to: bzip2[email protected].\n"
827+
" or (3), report it at: https://gitlab.com/bzip2/bzip2/-/issues\n"
828828
" Section 4.3 of the user's manual describes the info a useful\n"
829829
" bug report should have. If the manual is available on your\n"
830830
" system, please try and read it before mailing me. If you don't\n"

‎bzip2.doap

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@
1212
as a component of compressed data streams.
1313
</description>
1414

15-
<homepage rdf:resource="https://sourceware.org/bzip2/" />
16-
<download-page rdf:resource="https://sourceware.org/bzip2/downloads.html/" />
17-
<bug-database rdf:resource="https://gitlab.com/federicomenaquintero/bzip2/issues" />
15+
<homepage rdf:resource="https://gitlab.com/bzip2/bzip2" />
16+
<download-page rdf:resource="https://gitlab.com/bzip2/bzip2/-/tags" />
17+
<bug-database rdf:resource="https://gitlab.com/bzip2/bzip2/issues" />
1818
<programming-language>C</programming-language>
1919
<programming-language>Rust</programming-language>
2020

‎bzip2.txt

+1-2
Original file line numberDiff line numberDiff line change
@@ -369,7 +369,7 @@ CAVEATS
369369
AUTHOR
370370
Julian Seward, [email protected]
371371

372-
https://sourceware.org/bzip2/
372+
https://gitlab.com/bzip2/bzip2
373373

374374
The ideas embodied in bzip2 are due to (at least) the fol-
375375
lowing people: Michael Burrows and David Wheeler (for the
@@ -388,4 +388,3 @@ AUTHOR
388388
gzip. Many people sent patches, helped with portability
389389
problems, lent machines, gave advice and were generally
390390
helpful.
391-

‎bzlib.c

+6-5
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,13 @@ void BZ2_bz__AssertH__fail ( int errcode )
4444
fprintf(stderr,
4545
"\n\nbzip2/libbzip2: internal error number %d.\n"
4646
"This is a bug in bzip2/libbzip2, %s.\n"
47-
"Please report it to me at: [email protected]. If this happened\n"
48-
"when you were using some program which uses libbzip2 as a\n"
49-
"component, you should also report this bug to the author(s)\n"
50-
"of that program. Please make an effort to report this bug;\n"
47+
"Please report it at: https://gitlab.com/bzip2/bzip2/-/issues\n"
48+
"If this happened when you were using some program which uses\n"
49+
"libbzip2 as a component, you should also report this bug to\n"
50+
"the author(s) of that program.\n"
51+
"Please make an effort to report this bug;\n"
5152
"timely and accurate bug reports eventually lead to higher\n"
52-
"quality software. Thanks. Julian Seward, 10 December 2007.\n\n",
53+
"quality software. Thanks.\n\n",
5354
errcode,
5455
BZ2_bzlibVersion()
5556
);

‎docs/RELEASING.md

+12-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
1-
Release checklist:
1+
# Release Checklist
22

3-
* [ ] Increment package version at the top of meson.build and CMakeLists.txt
4-
5-
* [ ] Increment library revision in meson.build and CMakeLists.txt
3+
* [ ] Increment package version at the top of [meson.build](../meson.build) and
4+
[CMakeLists.txt](../CMakeLists.txt)
65

7-
* [ ] If interfaces were added, changed, or deleted, adjust per meson.build and CMakeLists.txt
6+
* [ ] Increment library revision in [meson.build](../meson.build) and
7+
[CMakeLists.txt](../CMakeLists.txt)
8+
9+
* [ ] If interfaces were added, changed, or deleted, adjust per
10+
[meson.build](../meson.build) and [CMakeLists.txt](../CMakeLists.txt).
11+
See the GNU libtool versioning rules for library revision numbering advice:
12+
http://www.gnu.org/software/libtool/manual/html_node/Updating-version-info.html
13+
14+
* [ ] On release day, create a new `release/*` branch and create a release tag.

‎docs/entities.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- misc. strings -->
2-
<!ENTITY bz-url "https://sourceware.org/bzip2/">
2+
<!ENTITY bz-url "https://gitlab.com/bzip2/bzip2">
33
<!ENTITY bz-email "[email protected]">
44
<!ENTITY bz-lifespan "1996-2010">
55

0 commit comments

Comments
 (0)