]> granicus.if.org Git - gc/commitdiff
Update documentation about bugs reporting and new releases notification
authorIvan Maidanski <ivmai@mail.ru>
Tue, 6 Jun 2017 07:30:50 +0000 (10:30 +0300)
committerIvan Maidanski <ivmai@mail.ru>
Sat, 1 Jul 2017 15:39:25 +0000 (18:39 +0300)
(Cherry-pick commits e3456e461fd9da from 'master' branch.)

* README.md (Download): Add link to BDWGC Download page on GitHub.
* README.md (Overview): Change link (for the further information) from
hboehm.info/gc to doc/overview.html.
* README.md (Bugs): Remove information about bugs reporting from this
section.
* README.md (Feedback, Contribution, Questions and Notifications): New
section.
* configure.ac (AC_INIT): Change URI for reporting bugs.
* doc/gc.man (SEE ALSO): Add link to the BDWGC main page on GitHub.
* doc/gcdescr.html: Remove information how to provide feedback.
* doc/overview.html (Contacts and Mailing List): Update information
(recommend use of GitHub and Stack Overflow, provide links to the
archives of the former mailing lists).

README.md
configure.ac
doc/gc.man
doc/gcdescr.html
doc/overview.html

index 17696401e030a7afc51b6c7234695cdab0b846cc..bde85eb7b38a9200f36e1eda1c08702d8240c8ac 100644 (file)
--- a/README.md
+++ b/README.md
@@ -7,6 +7,7 @@ collector for C and C++.
 ## Download
 
 You might find a more recent/stable version on the
+[Download](https://github.com/ivmai/bdwgc/wiki/Download) page, or
 [BDWGC site](http://www.hboehm.info/gc/).
 
 Also, the latest bug fixes and new features are available in the
@@ -68,7 +69,7 @@ collector.  (See doc/README.cords and H.-J. Boehm, R. Atkinson, and M. Plass,
 in Xerox Cedar, or the "rope" package in the SGI STL or the g++ distribution.)
 
 Further collector documentation can be found
-[here](http://www.hboehm.info/gc/).
+in [overview.html](doc/overview.html).
 
 
 ## General Description
@@ -542,9 +543,28 @@ per MB of accessible memory that needs to be scanned and processor.
 Your mileage may vary.)  The incremental/generational collection facility
 may help in some cases.
 
-Please address bug reports [here](mailto:bdwgc@lists.opendylan.org).
-If you are contemplating a major addition, you might also send mail to ask
-whether it's already been done (or whether we tried and discarded it).
+
+## Feedback, Contribution, Questions and Notifications
+
+Please address bug reports and new feature ideas to
+[GitHub issues](https://github.com/ivmai/bdwgc/issues).  Before the
+submission please check that it has not been done yet by someone else.
+
+If you want to contribute, submit
+a [pull request](https://github.com/ivmai/bdwgc/pulls) to GitHub.
+
+If you need help, use
+[Stack Overflow](https://stackoverflow.com/questions/tagged/boehm-gc).
+Older technical discussions are also available in
+[bdwgc mailing list archive](https://github.com/ivmai/bdwgc/files/1038163/bdwgc-mailing-list-archive-2017_04.tar.gz).
+
+To get new release announcements, subscribe to
+[RSS feed](https://github.com/ivmai/bdwgc/releases.atom).
+(To receive the notifications by email, a 3rd-party free service like
+[IFTTT RSS Feed](https://ifttt.com/feed) can be setup.)
+To be notified on all issues, please
+[watch](https://github.com/ivmai/bdwgc/watchers) the project on
+GitHub.
 
 
 ## Copyright & Warranty
index da481a97a51e765ab873ff8508c6d12872631698..b1986c8a2bf99a258ddeb55bf9005c106dad6149 100644 (file)
@@ -12,7 +12,7 @@
 dnl Process this file with autoconf to produce configure.
 
 # Initialization
-AC_INIT(gc,7.6.0,bdwgc@lists.opendylan.org)
+AC_INIT(gc,7.6.0,https://github.com/ivmai/bdwgc/issues)
     ## version must conform to [0-9]+[.][0-9]+[.][0-9]+
 AC_CONFIG_SRCDIR(gcj_mlc.c)
 AC_CONFIG_MACRO_DIR([m4])
index 4553737608a1879cfabaf674c0dedf58a0f73287..201729f832b2f49aa4fa45f3cf60db542a106695 100644 (file)
@@ -91,7 +91,7 @@ Other facilities not discussed here include limited facilities to support increm
 .SH "SEE ALSO"
 The README and gc.h files in the distribution.  More detailed definitions of the functions exported by the collector are given there.  (The above list is not complete.)
 .LP
-The web site at http://www.hboehm.info/gc/ .
+The web site at http://www.hboehm.info/gc/ (or https://github.com/ivmai/bdwgc/).
 .LP
 Boehm, H., and M. Weiser, "Garbage Collection in an Uncooperative Environment",
 "Software Practice & Experience", September 1988, pp. 807-820.
index a30e776b6c912fcd331c05571599f8fcf935740c..fdead523fe29e037aaa7b2b9b4d8cf10eec6a286 100644 (file)
@@ -610,12 +610,5 @@ For some more details see <A HREF="scale.html">here</a>, and the
 technical report entitled
 <A HREF="http://www.hpl.hp.com/techreports/2000/HPL-2000-165.html">
 "Fast Multiprocessor Memory Allocation and Garbage Collection"</a>
-<P>
-<HR>
-<P>
-Comments are appreciated.  Please send mail to
-<A HREF="mailto:bdwgc@lists.opendylan.org"><tt>bdwgc@lists.opendylan.org</tt></a>
-(GC mailing list) or
-<A HREF="mailto:boehm@acm.org"><TT>boehm@acm.org</tt></a>
 </body>
 </html>
index b8c6f3337a11ef02475d0dca223e3dc86b696948..f49222f640c5bd41f6a26072d522b36328517c3a 100644 (file)
@@ -398,28 +398,33 @@ Technical Report version</a>).
 <a href="http://www.hboehm.info/gc/gctalk.ps">Slides for OOPSLA 98 garbage collection talk</a>.
 </p><p>
 <a href="http://www.hboehm.info/gc/papers/">Related papers</a>.
-</p><h1><a name="contacts">Contacts and Mailing List</a></h1>
-<a>We have recently set up two mailing list for collector announcements
-and discussions:
-</a><ul>
-<li><a href="mailto:bdwgc-announce@lists.opendylan.org">bdwgc-announce@lists.opendylan.org</a>
-is used for announcements of new versions.  Postings are restricted.
-We expect this to always remain a very low volume list.
-</li><li><a href="mailto:bdwgc@lists.opendylan.org">bdwgc@lists.opendylan.org</a>
-is used for discussions, bug reports, and the like.  Subscribers may post.
-On-topic posts by nonsubscribers will usually also be accepted, but
-it may take some time to review them.
-</li></ul>
-To subscribe to these lists, please visit
-<a href="https://lists.opendylan.org/mailman/listinfo/bdwgc-announce">lists.opendylan.org/mailman/listinfo/bdwgc-announce</a>
-and
-<a href="https://lists.opendylan.org/mailman/listinfo/bdwgc">lists.opendylan.org/mailman/listinfo/bdwgc</a>,
-respectively.
+</p><h1><a name="contacts">Contacts and new release announcements</a></h1>
+GitHub and Stack Overflow are the major two places for communication.
 <p>
-The archives for these lists appear
-<a href="https://lists.opendylan.org/pipermail/bdwgc-announce/">here</a> and
-<a href="https://lists.opendylan.org/pipermail/bdwgc/">here</a>,
-respectively.
+Technical questions (how to, how does it work, etc.) should be posted to
+<a href="https://stackoverflow.com/questions/tagged/boehm-gc">Stack Overflow</a>
+with "boehm-gc" tag.
+</p><p>
+To contribute, please rebase your code to the latest
+<a href="https://github.com/ivmai/bdwgc/tree/master/">master</a> and submit
+a <a href="https://github.com/ivmai/bdwgc/pulls">pull request</a> to GitHub.
+</p><p>
+To report a bug, or propose (request) a new feature, create
+a <a href="https://github.com/ivmai/bdwgc/issues">GitHub issue</a>.
+Please make sure it has not been reported yet by someone else.
+</p><p>
+To receive notifications on every release, please subscribe to
+<a href="https://github.com/ivmai/bdwgc/releases.atom">Releases RSS feed</a>.
+Notifications on all issues and pull requests are available by
+<a href="https://github.com/ivmai/bdwgc/watchers">watching</a> the project.
+</p><p>
+Mailing lists (bdwgc-announce@lists.opendylan.org, bdwgc@lists.opendylan.org,
+and the former gc-announce@linux.hpl.hp.com and gc@linux.hpl.hp.com) are not
+used at this moment.  Their content is available in
+<a href="https://github.com/ivmai/bdwgc/files/1037650/bdwgc-announce-mailing-list-archive-2014_02.tar.gz">bdwgc-announce</a>
+and
+<a href="https://github.com/ivmai/bdwgc/files/1038163/bdwgc-mailing-list-archive-2017_04.tar.gz">bdwgc</a>
+archive files, respectively.
 The gc list archive may also be read at
 <a href="http://dir.gmane.org/gmane.comp.programming.garbage-collection.boehmgc">gmane.org</a>.
 </p><p>
@@ -427,8 +432,4 @@ Some prior discussion of the collector has taken place on the gcc
 java mailing list, whose archives appear
 <a href="http://gcc.gnu.org/ml/java/">here</a>, and also on
 <a href="http://lists.tunes.org/mailman/listinfo/gclist">gclist@iecc.com</a>.
-</p><p>
-Comments and bug reports may also be sent to
-(<a href="mailto:boehm@acm.org">boehm@acm.org</a>), but the gc
-mailing list is usually preferred.
 </p></body></html>