From: Ivan Maidanski Date: Tue, 6 Jun 2017 07:30:50 +0000 (+0300) Subject: Update documentation about bugs reporting and new releases notification X-Git-Tag: v7.6.2~147 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=1b632a276b7e8d5576089c41c7a7fe2f3f4d1e9b;p=gc Update documentation about bugs reporting and new releases notification (Cherry-pick commits e3456e4, 61fd9da 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). --- diff --git a/README.md b/README.md index 17696401..bde85eb7 100644 --- 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 diff --git a/configure.ac b/configure.ac index da481a97..b1986c8a 100644 --- a/configure.ac +++ b/configure.ac @@ -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]) diff --git a/doc/gc.man b/doc/gc.man index 45537376..201729f8 100644 --- a/doc/gc.man +++ b/doc/gc.man @@ -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. diff --git a/doc/gcdescr.html b/doc/gcdescr.html index a30e776b..fdead523 100644 --- a/doc/gcdescr.html +++ b/doc/gcdescr.html @@ -610,12 +610,5 @@ For some more details see here, and the technical report entitled "Fast Multiprocessor Memory Allocation and Garbage Collection" -

-

-

-Comments are appreciated. Please send mail to -bdwgc@lists.opendylan.org -(GC mailing list) or -boehm@acm.org diff --git a/doc/overview.html b/doc/overview.html index b8c6f333..f49222f6 100644 --- a/doc/overview.html +++ b/doc/overview.html @@ -398,28 +398,33 @@ Technical Report version). Slides for OOPSLA 98 garbage collection talk.

Related papers. -

Contacts and Mailing List

-We have recently set up two mailing list for collector announcements -and discussions: - -To subscribe to these lists, please visit -lists.opendylan.org/mailman/listinfo/bdwgc-announce -and -lists.opendylan.org/mailman/listinfo/bdwgc, -respectively. +

Contacts and new release announcements

+GitHub and Stack Overflow are the major two places for communication.

-The archives for these lists appear -here and -here, -respectively. +Technical questions (how to, how does it work, etc.) should be posted to +Stack Overflow +with "boehm-gc" tag. +

+To contribute, please rebase your code to the latest +master and submit +a pull request to GitHub. +

+To report a bug, or propose (request) a new feature, create +a GitHub issue. +Please make sure it has not been reported yet by someone else. +

+To receive notifications on every release, please subscribe to +Releases RSS feed. +Notifications on all issues and pull requests are available by +watching the project. +

+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 +bdwgc-announce +and +bdwgc +archive files, respectively. The gc list archive may also be read at gmane.org.

@@ -427,8 +432,4 @@ Some prior discussion of the collector has taken place on the gcc java mailing list, whose archives appear here, and also on gclist@iecc.com. -

-Comments and bug reports may also be sent to -(boehm@acm.org), but the gc -mailing list is usually preferred.