summaryrefslogtreecommitdiff
path: root/README.md
Commit message (Collapse)AuthorAgeFilesLines
* Fix description of client promise for IGNORE_OFF_PAGE allocated objectsIvan Maidanski2023-03-201-2/+3
| | | | | | | | | | | | | | | | | | | | | | | | | (documentation) The client should keep a pointer within the first heap block for such an allocated object. Previously, it was mentioned in the documentation and comments that such a pointer should be within the first 256 or 512 bytes. * README.md (The C Interface to the Allocator): Fix the description (comment) of GC_malloc_ignore_off_page (the client promises to keep a pointer within the first hblk of the object instead of 256 or 512 bytes, or a page). * docs/gcinterface.md (GC_MALLOC_IGNORE_OFF_PAGE): Likewise. * gc.man (GC_malloc_atomic_ignore_off_page): Likewise. * include/gc/gc.h (GC_malloc_ignore_off_page): Likewise. * include/gc/gc_mark.h (GC_generic_malloc_ignore_off_page): Likewise. * include/private/gc_priv.h (IGNORE_OFF_PAGE): Likewise. * include/private/gc_priv.h [DBG_HDRS_ALL || GC_GCJ_SUPPORT || !GC_NO_FINALIZATION] (GC_generic_malloc_inner_ignore_off_page): Likewise. * malloc.c [DBG_HDRS_ALL || GC_GCJ_SUPPORT || !GC_NO_FINALIZATION] (GC_generic_malloc_inner_ignore_off_page): Likewise. * include/gc/gc_gcj.h (GC_gcj_malloc_ignore_off_page): Refine comment.
* Rename doc folder to docsIvan Maidanski2023-01-261-13/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * CMakeLists.txt [enable_docs] (CMAKE_INSTALL_DOCDIR): Rename doc folder to docs. * Makefile.am [ENABLE_DOCS] (docdocdir, dist_docdocs_DATA, dist_docdocsplatforms_DATA): Likewise. * Makefile.direct (CXXFLAGS): Likewise. * README.md: Likewise. * docs/simple_example.md (Other platforms): Likewise. * Makefile.am [ENABLE_DOCS] (docdocdir): Rename to docdocsdir. * Makefile.am [ENABLE_DOCS] (dist_docdoc_DATA): Rename to dist_docdocs_DATA. * Makefile.am [ENABLE_DOCS] (docdocplatformsdir): Rename to docdocsplatformsdir. * Makefile.am [ENABLE_DOCS] (dist_docdocplatforms_DATA): Rename to dist_docdocsplatforms_DATA. * doc/README.autoconf: Move to docs folder. * doc/README.cmake: Likewise. * doc/README.cords: Likewise. * doc/README.environment: Likewise. * doc/README.macros: Likewise. * doc/debugging.md: Likewise. * doc/faq.md: Likewise. * doc/finalization.md: Likewise. * doc/gcdescr.md: Likewise. * doc/gcinterface.md: Likewise. * doc/leak.md: Likewise. * doc/overview.md: Likewise. * doc/porting.md: Likewise. * doc/scale.md: Likewise. * doc/simple_example.md: Likewise. * doc/tree.md: Likewise. * doc/platforms/README.aix: Move to docs/platforms folder. * doc/platforms/README.amiga: Likewise. * doc/platforms/README.arm_cross: Likewise. * doc/platforms/README.darwin: Likewise. * doc/platforms/README.dgux386: Likewise. * doc/platforms/README.emscripten: Likewise. * doc/platforms/README.ews4800: Likewise. * doc/platforms/README.hp: Likewise. * doc/platforms/README.linux: Likewise. * doc/platforms/README.mac: Likewise. * doc/platforms/README.os2: Likewise. * doc/platforms/README.sgi: Likewise. * doc/platforms/README.solaris2: Likewise. * doc/platforms/README.symbian: Likewise. * doc/platforms/README.uts: Likewise. * doc/platforms/README.win32: Likewise. * doc/platforms/README.win64: Likewise.
* Revert "Add LGTM.com code quality badges to README.md"Ivan Maidanski2023-01-251-2/+0
| | | | | | This reverts commit 630a5980a412ac8c951ffbe725b3f60b825b90ec. The reason: LGTM badges are no longer supported.
* Mention all doc files in overview documentRoger Pack2022-12-111-1/+1
| | | | | | | | | | | | | | | | | | | | | | Issue #517 (bdwgc). Use overview.md as the "default" for all the doc files. * README.md (The C++ Interface to the Allocator): Replace "gcinterface.md" to "here" in link title (to match other links to .md files). * doc/overview.md: Add "Documentation files" section. * doc/overview.md (Further reading): Remove link to gc/faq.html (as it is also given in other section). * doc/overview.md (Information provided on the BDWGC site): Move links to all *.md files to "Documentation files" section. * doc/overview.md (Documentation files): New section; add links to README.autoconf, README.cmake, README.environment, README.macros, finalization.md, porting.md, README.cords. * doc/simple_example.md (Running the executable): Point to README.environment by a link. Co-authored-by: Ivan Maidanski <ivmai@mail.ru>
* Move platform-specific README files to doc/platformsRoger Pack2022-12-071-10/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Issue #515 (bdwgc). Make doc folder less overwhelming by moving platform specific docs to their own folder. * Makefile.am (dist_doc_DATA): Change doc/README.* to doc/platforms/README.* for README.DGUX386, README.Mac, README.OS2, README.aix, README.amiga, README.arm.cross, README.darwin, README.emscripten, README.ews4800, README.hp, README.linux, README.sgi, README.solaris2, README.symbian, README.uts, README.win32, README.win64. * README.md (General Description, Installation and Portability): Update links to README.win32, README.win64 and README.* files. * doc/debugging.md (Bus Errors and Segmentation Violations): Put README.win32 in quotes (to match that in other .md files). * doc/README.DGUX386: Move to doc/platforms folder. * doc/README.Mac: Likewise. * doc/README.OS2: Likewise. * doc/README.aix: Likewise. * doc/README.amiga: Likewise. * doc/README.arm.cross: Likewise. * doc/README.darwin: Likewise. * doc/README.emscripten: Likewise. * doc/README.ews4800: Likewise. * doc/README.hp: Likewise. * doc/README.linux: Likewise. * doc/README.sgi: Likewise. * doc/README.solaris2: Likewise. * doc/README.symbian: Likewise. * doc/README.uts: Likewise. * doc/README.win32: Likewise. * doc/README.win64: Likewise. * doc/simple_example.md (Other platforms): Replace doc/README.xxx to doc/platforms folder.
* Fix cmake usage instructions in README to build and run testsIvan Maidanski2022-11-211-1/+1
| | | | | | | | | | (fix of commit 4dfd06514) Issue #501 (bdwgc). * README.md (Installation and Portability): Pass -Dbuild_tests=ON to cmake. * doc/README.cmake (BUILD PROCESS): Likewise.
* Adjust naming of Win32/64 and x86/64 words in comments and documentationIvan Maidanski2022-09-261-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * ChangeLog: Replace i386 and X86 to x86; replace x86_64 and amd64 to x64; replace "Win32 pthreads" to pthreads-win32; lower case win32s, x86, x64; replace win32 to Win32; replace "MS Windows" to Windows (in documentation and comments). * NT_MAKEFILE: Likewise. * README.md: Likewise. * configure.ac: Likewise. * cord/tests/de_win.c: Likewise. * doc/README.macros: Likewise. * doc/README.solaris2: Likewise. * doc/README.win32: Likewise. * doc/README.win64: Likewise. * doc/debugging.md: Likewise. * doc/leak.md: Likewise. * doc/overview.md: Likewise. * doc/porting.md: Likewise. * extra/msvc_dbg.c: Likewise. * finalize.c: Likewise. * include/gc/cord.h: Likewise. * include/gc/gc.h: Likewise. * include/private/gc_priv.h: Likewise. * include/private/gcconfig.h: Likewise. * include/private/pthread_stop_world.h: Likewise. * mach_dep.c: Likewise. * mark.c: Likewise. * mark_rts.c: Likewise. * misc.c: Likewise. * os_dep.c: Likewise. * tools/threadlibs.c: Likewise. * win32_threads.c: Likewise. * cord/tests/de.c (WIN32): Remove misleading comment. * misc.c (GC_enable_incremental): Change comment about win32s to TODO item.
* Update Travis CI badge URL in READMEIvan Maidanski2022-08-031-1/+1
|
* Add OpenSSF Best Practices badge to READMEIvan Maidanski2022-08-031-0/+1
|
* Add FOSSA badge to READMEIvan Maidanski2022-05-191-1/+1
|
* Replace SSH cloning with HTTPS one in READMEMaximilian Downey Twiss2022-05-041-2/+2
| | | | | | | | | | Issue #444 (bdwgc). The unauthenticated git protocol on port 9418 is no longer supported by Github. * README.md (Installation and Portability): Clone repositories using https protocol instead of ssh (git) one.
* Name all tests consistentlyIvan Maidanski2022-02-071-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | (refactoring) In brief, the tests naming as follows: all test executable files end with "test" (not "_test"); all test source files do not have "test" suffix (except for gctest); test.c is named now as gctest.c. * CMakeLists.txt: Rename leak_test.c to leak.c; rename huge_test.c to huge.c; rename leak_test.c to leak.c; rename realloc_test.c to realloc.c; rename smash_test.c to smash.c; rename staticrootslib.c to staticroots_lib.c; rename trace_test.c to trace.c; rename thread_leak_test.c to threadleak.c; rename threadkey_test to threadkey_test; rename threadkey_test.c to threadkey.c; rename subthreadcreate_test to subthreadcreatetest; rename subthread_create.c to subthreadcreate.c; rename initsecondarythread_test to initfromthreadtest; rename initsecondarythread.c to initfromthread.c; rename disclaim_test to disclaimtest; rename disclaim_test.c to disclaim.c; rename disclaim_weakmap_test to weakmaptest; rename disclaim_weakmap_test.c to weakmap.c. * tests/tests.am: Likewise. * CMakeLists.txt: Rename test.c to gctest.c; rename test_cpp to cpptest; rename test_cpp.cc to cpp.cc. * Makefile.direct: Likewise. * NT_MAKEFILE: Likewise. * README.md (Installation and Portability): Likewise. * WCC_MAKEFILE: Likewise. * digimars.mak: Likewise. * doc/README.Mac: Likewise. * tests/tests.am: Likewise. * CMakeLists.txt: rename test_atomic_ops.c to atomicops.c; rename test_atomic_ops to atomicopstest. * configure.ac [$with_libatomic_ops=check]: Likewise. * ChangeLog (8.3.0): Rename threadkey_test to threadkeytest; rename test_atomic_ops to atomicopstest; rename test_cpp to cpptest. * Makefile.direct: Rename test.o to gctest.o. * NT_MAKEFILE: Rename test_cpp.exe to cpptest.exe; rename test.obj to gctest.obj. * WCC_MAKEFILE: Likewise. * digimars.mak: Likewise. * doc/README.win64: Likewise. * configure.ac: Rename test_cpp to cpptest in comment. * doc/leak.md: Rename leak_test.c to leak.c. * tests/test_atomic_ops.c: Rename to atomicops.c; remove test name in "skipped" message. * tests/test_cpp.cc: Rename to cpp.cc; rename test_cpp to cpptest. * tests/disclaim_test.c: Rename to disclaim.c. * tests/test.c: Rename to gctest.c. * tests/huge_test.c: Rename to huge.c. * tests/initsecondarythread.c: Rename to initfromthread.c. * tests/leak_test.c: Rename to leak.c. * tests/realloc_test.c: Rename to realloc.c. * tests/smash_test.c: Rename to smash.c. * tests/staticrootstest.c: Rename to staticroots.c. * tests/staticrootslib.c: Rename to staticroots_lib.c. * tests/subthread_create.c: Rename to subthreadcreate.c; remove test name in printed messages. * tests/threadkey_test.c: Rename to threadkey.c; remove test name in "skipped" message. * tests/thread_leak_test.c: Rename to threadleak.c. * tests/trace_test.c: Rename to trace.c. * tests/disclaim_weakmap_test.c: Rename to weakmap.c; rename disclaim_test.c to disclaim.c in comment.
* Remove ancient PCR-MakefileIvan Maidanski2021-11-291-2/+2
| | | | | | | | | | | | * Makefile.am (EXTRA_DIST): Remove PCR-Makefile item; reorder items. * Makefile.direct (srcdir): Update comment. * Makefile.direct (pcr): Remove rule. * PCR-Makefile: Remove. * README.md (Installation and Portability): Do not mention PCR has a specific makefile. * doc/README.macros (PCR): Mention PCR-specific defines from PCR-Makefile. * tests/test.c (NTHREADS): Do not mention PCR.
* Remove ancient SMakefile.amigaIvan Maidanski2021-11-291-2/+2
| | | | | | | | | | * Makefile.am (EXTRA_DIST): Remove SMakefile.amiga item. * README.md (Installation and Portability): Do not mention Amiga has a specific makefile. * SMakefile.amiga: Remove. * doc/README.amiga: Mention Makefile.direct instead of Makefile. * doc/README.amiga (WHATS NEW): Copy Amiga-specific options and defines from SMakefile.amiga file.
* Remove Symbian makefileIvan Maidanski2021-11-291-3/+2
| | | | | | | | | | | * build/s60v3/bld.inf: Remove. * build/s60v3/libgc.mmp: Likewise. * doc/README.symbian: Copy content of bld.inf and libgc.mmp (as a sample build configuration); add global_end.cpp, global_start.cpp, init_global_static_roots.cpp as source files. * Makefile.am (EXTRA_DIST): Remove bld.inf, libgc.mmp items. * README.md (Installation and Portability): Do not mention Symbian-specific makefile.
* Quote all mentioned header files in README.md and debugging.mdIvan Maidanski2021-11-251-3/+3
| | | | | | | * README.md (The C Interface to the Allocator, The C++ Interface to the Allocator): Wrap all (remaining) mentioned .h files in apostrophes. * doc/debugging.md (Unexpectedly Large Heap): Likewise.
* State explicitly that license is MIT-styleIvan Maidanski2021-11-241-0/+8
| | | | | | | | * LICENSE: Add to title that it is a MIT-like license; reformat text about GNU-style build procedure. * README.md: Specify license type at the top of the file. * README.md (Copyright & Warranty, Contributors): Add information that the license is a MIT-like one.
* Move non-license info from LICENSE file to READMEIvan Maidanski2021-11-241-38/+57
| | | | | | | | | | | | | | | | | | * LICENSE: Remove INSTALLATION, TYPICAL USE, WARNINGS sections (i.e., remove all non-license information). * README.md (Overview): Add link to README.cords; some other minor changes; reformat text. * README.md (General Description): Add link to README.win32 and README.win64; reformat text. * README.md (Installation and Portability): Mention CMake before providing exact build commands; add reference to README.cmake and README.macros; mention how to build the collector on Windows; mention that threads are on be default; mention how to build cord library with Makefile.direct mention that Symbian has a separate makefile. * README.md (The C++ Interface to the Allocator): Copy information about building the C++ GC libraries from LICENSE; add link to gcinterface.md. * doc/README.cords: Copy information about cord library building from LICENSE file.
* Rename README.QUICK to LICENSE and install it by defaultIvan Maidanski2021-11-231-2/+1
| | | | | | | | | | | | | | README.QUICK contains the package copyright and licensing terms, it is more natural to name the file as LICENSE. * CMakeLists.txt [enable_docs] (install): Add LICENSE for $CMAKE_INSTALL_DOCDIR; remove note that README.QUICK is not installed. * README.QUICK: Rename to LICENSE. * Makefile.am (EXTRA_DIST): Do not add README.QUICK. * README.md (Copyright & Warranty, Contributors): Rename README.QUICK to LICENSE. * doc/README.DGUX386: Refer to README.md instead of README.QUICK. * doc/doc.am [ENABLE_DOCS] (dist_doc_DATA): Add LICENSE.
* Reference AUTHORS file in README.mdIvan Maidanski2021-11-231-1/+3
| | | | | * README.md (Copyright & Warranty): Add a reference to a file listing all the bdwgc contributors (AUTHORS).
* Move copyrights and other licensing info from README.md to README.QUICKIvan Maidanski2021-11-231-48/+2
| | | | | | | | * README.QUICK: Add missing copyrights from README.md; copy missing licensing details from README.md (about several files with slightly different license). * README.md (Copyright & Warranty): Replace all copyrights and the licensing details with a reference to README.QUICK file.
* Reformat README.md to avoid too long lines where possibleIvan Maidanski2021-11-231-11/+11
| | | | | * README.md (Installation and Portability): Reformat a paragraph about the build process based on Makefile.direct.
* Remove msvc_dbg.h fileIvan Maidanski2021-11-231-1/+1
| | | | | | | | | | | | | | | | | | (refactoring) * NT_MAKEFILE (tests\test.obj): Remove msvc_dbg.h from dependencies. * README.md (Copyright & Warranty): Do not mention msvc_dbg.h. * extra/msvc_dbg.c [!_M_ARM && !_M_ARM64 && !_M_X64 && _MSC_VER]: Do not include msvc_dbg.h; include stdlib.h. * extra/msvc_dbg.c [!_M_ARM && !_M_ARM64 && !_M_X64 && _MSC_VER] (backtrace, backtrace_symbols): Declare (as extern C). * os_dep.c [GC_HAVE_BUILTIN_BACKTRACE && _MSC_VER] (backtrace, backtrace_symbols): Likewise. * extra/msvc_dbg.c [!_M_ARM && !_M_ARM64 && !_M_X64 && _MSC_VER] (backtrace_symbols): Match argument types in the definition to those in the declaration. * include/include.am (EXTRA_DIST): Do not add msvc_dbg.h. * include/private/msvc_dbg.h: Remove.
* Synchronize copyright years between README filesIvan Maidanski2021-11-221-5/+5
| | | | | | | | | | | | | | | * README.QUICK: Copy copyright years from README.md. * README.md (Copyright & Warranty): Adjust copyrights (synchronize with that of the source files). * alloc.c: Adjust copyrights in the file head comment and GC_copyright (synchronize with that of updated README.QUICK). * include/gc.h: Likewise. * alloc.c (GC_copyright): Reformat. * dbg_mlc.c: Add trailing dot to a copyright in the file head comment. * finalize.c: Likewise. * include/gc.h: Likewise. * tests/initsecondarythread.c: Reformat copyright in the file head comment (change C to lower case).
* Add 'lib' prefix to build artifact names in Makefile.directIvan Maidanski2021-11-141-2/+2
| | | | | | | | | | | | | | | This is to match libraries naming convention of CMake and configure scripts. * Makefile.direct: Update comment (add "lib" prefix to gc.a, gccpp.a, gctba.a, cord.a). * Makefile.direct (bsd-libgc.a, bsd-libgccpp.a, bsd-libgctba.a, bsd-libleak.a, base_lib, gc.a, cords, libcord.a, test_cpp, gctba.a, cord.a, c++, gccpp.a, gctba.a, cordtest, de, gctest): Add "lib" prefix to gc.a, gccpp.a, gctba.a, cord.a. * README.QUICK (INSTALLATION, TYPICAL USE): Likewise. * README.md (Installation and Portability): Likewise. * doc/gcinterface.md (C/C++ Interface): Likewise.
* Add repology.org badge to READMEIvan Maidanski2021-11-091-0/+1
|
* Add a link to known uses of bdwgc to READMEIvan Maidanski2021-10-181-0/+3
| | | | | | * README.md (Overview): Add a link to Known-clients page on GitHub. * doc/overview.md (Information provided on the BDWGC site): Remove comment that the list on the Known-clients page is outdated.
* Mention CMake-based build in README.md and README.QUICKIvan Maidanski2021-10-181-0/+13
| | | | | | | * README.QUICK (INSTALLATION): Mention Cygwin; describe CMake-based build shortly; reference README.cmake. * README.md (Installation and Portability): Describe CMake-based build shortly and build by direct gcc invocation.
* Fix capital case of setjmp_test and gctest in README and commentsIvan Maidanski2021-10-181-3/+3
| | | | | | | | | | | | | * Makefile.direct (HOSTCFLAGS): Start setjmp_test word with lower case in comment. * README.md (Installation and Portability): Likewise. * mach_dep.c (GC_with_callee_saves_pushed): Likewise. * tools/setjmp_t.c (main): Likewise. * Makefile.direct (setjmp_test): Start gctest word with lower case in comment. * OS2_MAKEFILE (CFLAGS): Likewise. * README.md (Installation and Portability): Likewise. * SMakefile.amiga (finalize.o): Likewise.
* Bump libgc version (for the development of 8.4 release)Ivan Maidanski2021-09-291-1/+14
| | | | | | | | | | * README.md: Restore build status badges (Travis, AppVeyor, Codecov, Coveralls, Coverity, LGTM, Hits-of-Code, Lines of code, GitHub code size, Github All Releases). * CMakeLists.txt (PACKAGE_VERSION): Bump package version to 8.3.0. * README.md: Likewise. * configure.ac (AC_INIT): Likewise. * include/gc_version.h (GC_TMP_VERSION_MINOR): Likewise.
* [8.2.0]v8.2.0Ivan Maidanski2021-09-291-14/+1
| | | | | | | | | | | | | | | | | | | Bump gc version to 8.2.0 (experimental release) * ChangeLog (8.2.0): Set release date. * CMakeLists.txt (PACKAGE_VERSION): Bump minor version and set micro to 0 (change package version to 8.2.0). * README.md: Likewise. * configure.ac (AC_INIT): Likewise. * include/gc_version.h (GC_TMP_VERSION_MINOR, GC_TMP_VERSION_MICRO): Likewise. * CMakeLists.txt (LIBGCCPP_VER_INFO): Increment current and age (change version info of libgccpp.so to 6:0:5). * Makefile.am (LIBGCCPP_VER_INFO): Likewise. * README.md: Remove build status badges (Travis, AppVeyor, Codecov, Coveralls, Coverity, LGTM). * doc/README.cmake (HOW TO IMPORT BDWGC): Update BDWgc version in the sample.
* Update copyright information in alloc.c and other modified files (2021)Ivan Maidanski2021-09-091-1/+1
| | | | | | | | | | | | | | | | | | | | | * README.QUICK (Copyright): Update year (2019 to 2020). * README.md (Copyright): Likewise. * alloc.c (Copyright, GC_copyright): Likewise. * configure.ac (Copyright): Likewise. * include/private/gc_priv.h (Copyright): Likewise. * mark.c (Copyright): Likewise. * misc.c (Copyright): Likewise. * os_dep.c (Copyright): Likewise. * pthread_support.c (Copyright): Likewise. * win32_threads.c (Copyright): Likewise. * CMakeLists.txt: Update (add Ivan Maidanski). * dyn_load.c (Copyright): Likewise. * include/private/gc_alloc_ptrs.h (Copyright): Likewise. * include/private/gcconfig.h (Copyright): Likewise. * mallocx.c (Copyright): Likewise. * mark_rts.c (Copyright): Likewise. * reclaim.c (Copyright): Likewise. * tests/test.c (Copyright): Likewise.
* Fix link URL of shields.io badges in READMEIvan Maidanski2021-08-131-3/+3
| | | | | Place URL to shields.io/category instead of empty one (which led to missing Github page).
* Update CI badge in README after migration to travis-ci.comIvan Maidanski2021-06-201-1/+1
|
* Add hitsofcode.com, shields.io badges to READMEIvan Maidanski2021-06-101-0/+5
| | | | | | | | The following badges are added to README.md (in the 2nd row): * Hits-of-Code (for master branch) * Lines of code (for master branch) * GitHub code size in bytes * Github All Releases (downloads counter)
* Update copyright information in alloc.c and other modified files (2020)Ivan Maidanski2020-08-011-1/+1
| | | | | | | | | | | | | | | | | * README.QUICK (Copyright): Update year (2019 to 2020). * README.md (Copyright): Likewise. * alloc.c (Copyright, GC_copyright): Likewise. * gc_badalc.cc (Copyright): Likewise. * include/gc.h (Copyright): Likewise. * finalize.c (Copyright): Update (add Ivan Maidanski). * include/gc_config_macros.h (Copyright): Likewise. * include/private/gc_priv.h (Copyright): Likewise. * mark.c (Copyright): Likewise. * misc.c (Copyright): Likewise. * os_dep.c (Copyright): Likewise. * pthread_stop_world.c (Copyright): Likewise. * pthread_support.c (Copyright): Likewise. * win32_threads.c (Copyright): Likewise.
* Build cord.lib by Makefile.direct, NT_MAKEFILE, OS2_MAKEFILE, WCC_MAKEFILEIvan Maidanski2019-07-241-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Note: Makefile.direct builds cord.a (not libcord.a or cord.lib). * Makefile.direct: Update header comment about all and cords targets. * Makefile.direct (all): Depend also on cords. * Makefile.direct (cord.a): New target (duplicates cords target). * Makefile.direct (cords): Do not depend on base_lib; create cord.a instead of updating gc.a. * Makefile.direct (cordtest, de): Depend on cords instead of $(CORD_OBJS); pass cord.a (instead of $(CORD_OBJS)) to $(CC). * NT_MAKEFILE (CFLAGS_MT): Move variable definition (which uses cvarsmt) to be after CORDFLAG one. * NT_MAKEFILE (CORDFLAG, COBJS): New variable. * WCC_MAKEFILE (CORDFLAG, COBJS): Likewise. * NT_MAKEFILE [!ENABLE_STATIC] (cvarsmt): Set variable value to empty; add comment. * NT_MAKEFILE (all): Depend also on cord.lib. * OS2_MAKEFILE (all): Likewise. * WCC_MAKEFILE (all): Likewise. * NT_MAKEFILE (check): Depend also on cordtest.exe; run also cordtest. * WCC_MAKEFILE (check): Likewise. * NT_MAKEFILE (.c.obj): Remove -DCORD_NOT_DLL; add $(CORDFLAG). * NT_MAKEFILE (cord.lib, cordtest.exe): New target. * OS2_MAKEFILE (cord.lib, cordtest.exe, clean): Likewise. * WCC_MAKEFILE (cord.lib, cordtest.exe, cordbscs.obj, cordxtra.obj, cordprnt.obj, cordtest.obj): Likewise. * WCC_MAKEFILE [!ENABLE_STATIC] (cord.dll): Likewise. * NT_MAKEFILE (de.exe): Depend on cord.lib instead of cordbscs.obj and cordxtra.obj. * NT_MAKEFILE (clean): Delete cordtst*.tmp files; delete *.lib, *.dll, and *.exp files instead of gc*.lib, gc*.dll, gc*.exp, cord\*.exe, cord\*.exp, cord\*.lib, cord\*.pdb. * README.md (Installation and Portability): Update information about "make cords".
* Do not build tests by default (Makefile.direct and other Makefiles)Ivan Maidanski2019-07-161-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is to match the behavior of configure-based Makefile and the CMake script. Tests are built and executed now by `make check`. * BCC_MAKEFILE (all): Depend on gc.lib only (instead of gctest, de and test_cpp). * OS2_MAKEFILE (all): Likewise. * BCC_MAKEFILE (check): New target to build and run the tests (de is not executed). * NT_MAKEFILE (check): Likewise. * Makefile.direct (all): Remove dependency on gctest. * NT_MAKEFILE (all): Remove dependency on gctest, de and test_cpp; add dependency on gc.lib. * OS2_MAKEFILE (check): New target to build and run gctest and cordtest. * README.QUICK (INSTALLATION): Change "make test" to "make check". * README.md (Installation and Portability): Likewise. * doc/README.arm.cross: Likewise. * SMakefile.amiga (all): Depend on gc.lib and cord.lib only (instead of gctest, setjmp_t, cordtest). * SMakefile.amiga (test): Rename to "check". * WCC_MAKEFILE (all): Remove dependency on gctest and test_cpp. * digimars.mak (targets): Likewise. * WCC_MAKEFILE (check): New symbolic target to build and run gctest and test_cpp. * digimars.mak (check): Likewise. * digimars.mak (gc.lib): New target (depend on gc.dll target). * doc/README.win32 (Watcom compiler): Remove information that wmake compiles the tests by default. * doc/README.win64: Update information about tests building.
* Replace 'stack base' with 'stack bottom' in the documentationIvan Maidanski2019-04-261-4/+4
| | | | | | | | | | | | | | | | | | | | | | | | * README.md (The C Interface to the Allocator): Outline that stack base means its bottom; remove a note that client should set GC_stackbottom on HP PA machines manually. * doc/README.macros (USE_GET_STACKBASE_FOR_MAIN): Rename "stack base" to "stack bottom". * doc/porting.md (Adding Platforms to gcconfig.h): Likewise. * doc/porting.md (Adding Platforms to gcconfig.h): Rename "cool end of the stack" to "cold end of the stack"; refine documentation about STACKBOTTOM. * include/private/gcconfig.h (STACKBOTTOM): Rename "cool end" to "cold end" in comment. * include/gc.h (GC_stackbottom): Likewise. * include/private/gcconfig.h (LINUX_STACKBOTTOM): Rename "stack base" to "stack bottom" in comment. * include/gc.h (GC_stack_base, GC_call_with_stack_base): Likewise. * include/gc.h [GC_THREADS] (GC_register_my_thread): Likewise. * misc.c [!THREADS] (GC_call_with_gc_active): Likewise. * os_dep.c [LINUX_STACKBOTTOM] (GC_linux_main_stack_base): Likewise. * os_dep.c (GC_get_stack_base): Likewise. * pthread_support.c (GC_call_with_gc_active): Likewise. * win32_threads.c (GC_call_with_gc_active): Likewise.
* Fix the stack bottom variable name in READMEIvan Maidanski2019-04-261-1/+1
| | | | | * README.md (The C Interface to the Allocator): Fix a typo ("GC_stackbottom").
* Update the documentation to match the current GC implementationIvan Maidanski2019-03-261-50/+38
| | | | | | | | | | | | | | | | | | | | | | * README.md: Update the documentation to match the current implementation of the collector. * doc/README.Mac: Likewise. * doc/README.autoconf: Likewise. * doc/README.darwin: Likewise. * doc/README.hp: Likewise. * doc/README.linux: Likewise. * doc/README.macros: Likewise. * doc/README.solaris2: Likewise. * doc/README.win32: Likewise. * doc/debugging.md: Likewise. * doc/finalization.md: Likewise. * doc/gc.man: Likewise. * doc/gcdescr.md: Likewise. * doc/gcinterface.md: Likewise. * doc/leak.md: Likewise. * doc/overview.md: Likewise. * doc/porting.md: Likewise. * doc/scale.md: Likewise.
* Adjust formatting of numbered lists in README.md to match other .md filesIvan Maidanski2019-03-251-93/+82
| | | | | | * README.md (Installation and Portability, The C Interface to the Allocator, Incremental/Generational Collection): Reformat numbered lists.
* Use KB/MB/GB abbreviations uniformly across entire documentationIvan Maidanski2019-03-251-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * README.md (Installation and Portability): Precede MB with a space. * doc/README.amiga (WHATS NEW): Likewise. * doc/debugging.md: Likewise. * README.md (The C Interface to the Allocator): Replace Kbytes to KB. * doc/gc.man: Likewise. * README.Mac: Replace k to KB with a preceding space. * doc/debugging.md: Likewise. * doc/README.amiga: Precede MHz with a space. * doc/debugging.md: Precede KB with a space. * include/gc.h (GC_malloc_ignore_off_page): Replace K to KB with a preceding space in a comment. * tests/test.c (BIG): Likewise. * include/private/gc_priv.h (ALL_INTERIOR_POINTERS, HBLKSIZE, CPP_LOG_HBLKSIZE, LOG_PHT_ENTRIES): Likewise. * include/private/gc_priv.h (LOG_PHT_ENTRIES): Replace M to MB with a preceding space in a comment. * include/private/gc_priv.h (LOG_PHT_ENTRIES): Replace G to GB with a preceding space in a comment. * os_dep.c [GC_USE_MEM_TOP_DOWN && USE_WINALLOC] (GC_mem_top_down): Likewise. * include/gc_priv.h (GC_printf): Replace k to KB with a preceding space in a comment. * include/private/specific.h (quick_thread_id): Likewise. * os_dep.c [MSWINCE] (GC_wince_get_mem): Likewise. * os_dep.c [USE_WINALLOC && !MSWIN_XBOX1 || CYGWIN32] (GC_win32_get_mem): Likewise. * include/private/gcconfig.h [I386 && LINUX] (HEAP_START): Precede GB with a space in a comment.
* Fix various typos mostly in documentation filesIvan Maidanski2019-03-251-5/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * OS2_MAKEFILE: Fix a typo in comment ("it is there"). * README.md: Fix typos ("is not", "gc_inline.h", "bytes from", "processed"). * doc/README.OS2: Fix typos ("how", "linking"). * doc/README.amiga: Fix typos ("GC", "e.g.", "GC_*_typed", "i.e.", "SMakefile.amiga", "communications"). * doc/README.cmake: Fix a typo ("go to"). * doc/README.ews4800: Fix a typo ("a unique"). * doc/README.solaris2: Fix a typo ("toolchain"). * doc/finalization.md: Fix incorrect number of markup '#' symbols to denote H2 header. * doc/overview.md: Likewise. * doc/gcdescr.md: Fix typos ("collects", "then advances", "is not", "treated by"). * doc/gcinterface.md: Fix typos ("Build it", "Allocates", "deallocates", "forces", "Causes", "Replaces", "Registers", "traceable_alloc", "single_client_traceable_alloc"). * doc/leak.md: Fix typos ("there is", "provides"). * doc/overview.md (Further reading): Replace "&amp;" with "and". * doc/porting.md: Add missing ")" symbol; add missing comma; fix typos ("region_start", "region_end", "collector's", "are needed", "GC_save_callers"). * include/private/gc_priv.h: Fix a typo in comment ("gc_inline.h"). * os_dep.c [GWW_VDB] (detect_GetWriteWatch, GC_gww_read_dirty): Fix abbreviation ("Win2K") in a comment. * os_dep.c [MSWIN32] (GC_wnt): Likewise. * os_dep.c [GWW_VDB] (GC_gww_read_dirty): Fix a typo in comment ("behavior").
* Replace "msecs" with "ms" in all comments and messagesIvan Maidanski2019-01-061-1/+1
| | | | | | | | | | | | | | | | | | * README.md (Bugs): Replace "msecs" with "ms". * doc/README.environment (GC_PAUSE_TIME_TARGET): Likewise. * doc/gcdescr.md (Generational Collection and Dirty Bits): Likewise. * alloc.c [!NO_CLOCK] (full_gc_total_time): Replace "msecs" with "ms" in comment. * cord/tests/de.c [WIN32] (beep): Likewise. * pthread_support.c [USE_SPIN_LOCK] (GC_lock): Likewise. * alloc.c [!GC_DISABLE_INCREMENTAL && !NO_CLOCK] (GC_timeout_stop_func): Replace "msecs" with "ms" in the printed string. * alloc.c [!NO_CLOCK] (GC_try_to_collect_inner, GC_stopped_mark, GC_finish_collection): Likewise. * misc.c [!NO_CLOCK] (GC_dump_named): Likewise. * reclaim.c [!NO_CLOCK] (GC_reclaim_all): Likewise. * tests/test.c [!NO_CLOCK] (check_heap_stats): Likewise.
* Add copyright information about disclaim_weakmap_test source to READMEIvan Maidanski2018-10-191-0/+4
| | | | | * README.md (Copyright & Warranty): Add copyright information about disclaim_weakmap_test.c file.
* Add paths to filenames mentioned in the copyright section in READMEIvan Maidanski2018-10-191-3/+3
| | | | * README.md (Copyright & Warranty): Add the path to each mentioned file.
* Bump libgc version (for development of 8.2 release)Ivan Maidanski2018-09-061-1/+9
| | | | | | | | * README.md: Restore build status badges (Travis, AppVeyor, Codecov, Coveralls, Coverity, LGTM). * README.md: Bump version to 8.1.0. * configure.ac: Likewise. * include/gc_version.h (GC_TMP_VERSION_MINOR): Likewise.
* [8.0.0]v8.0.0Ivan Maidanski2018-09-051-9/+1
| | | | | | | | | | | | | | | | | | Bump gc version to 8.0.0 (experimental release) * ChangeLog (8.0.0): Set release date. * Makefile.am (LIBGC_VER_INFO): Increment revision (change version info of libgc.so to 5:1:4). * Makefile.am (LIBGCCPP_VER_INFO): Increment current and age (change version info of libgccpp.so to 5:0:4). * README.md: Bump major version (set minor and micro to 0). * configure.ac (AC_INIT): Likewise. * include/gc_version.h (GC_TMP_VERSION_MAJOR, GC_TMP_VERSION_MINOR, GC_TMP_VERSION_MICRO): Likewise. * README.md: Remove build status badges (Travis, AppVeyor, Codecov, Coveralls, Coverity, LGTM). * cord/cord.am (LIBCORD_VER_INFO): Increment current and age (change version info of libcord.so to 5:0:4).
* Add Codecov.io badge to READMEIvan Maidanski2018-09-041-0/+1
|
View Lorry Controller Status