List of commits:
Subject Hash Author Date (UTC)
README: Added instructions to include init and close calls in program. 9ceea9c4ae0c169a69fc1a0840402bfc2a2843cc Josiah Mullins 2023-10-05 18:02:22
Fixed bug with allocate memory and added include guards. 01034908e928b996abf6b92804a9f68112617af1 Josiah_Mullins_E6440 2020-02-14 17:53:16
master: initial commit of mem_check ede7de7550d3243f98279b5bd69eba18748105fa Josiah_Mullins_E6440 2020-02-12 17:42:39
Commit 9ceea9c4ae0c169a69fc1a0840402bfc2a2843cc - README: Added instructions to include init and close calls in program.
Author: Josiah Mullins
Author date (UTC): 2023-10-05 18:02
Committer name: Josiah Mullins
Committer date (UTC): 2023-10-05 18:02
Parent(s): 01034908e928b996abf6b92804a9f68112617af1
Signing key:
Tree: 5befd9584ca20c9a52ed31d3f73b9b69aed118a0
File Lines added Lines deleted
README 35 0
File README added (mode: 100644) (index 0000000..689c3bd)
1 1.) Introduction
2 This project is a simple memory leak checker.
3 It is intended for simple (small) C projects
4 where memory leaks may be a concern. It is
5 not intended to replace the more powerful
6 debugging tools out there. Rather, it is
7 intended to be an easy to use simple check.
8
9 2.) Brief overview
10 It works my defining macros that logs memory
11 allocation, reallocation and freeing. If all
12 of the memory allocated is not freed, the
13 scanner will alert you of that.
14
15 3). Simple Howto
16 To start using this project you would add the line
17 "#include <mem_check.h>" into your program and replace
18 the stdlib functions as shown below.
19 data = malloc(size); ---> allocate_memory(data,size);
20 new = realloc(old,size); ---> realloc_memory(new, old, size);
21 free(data); ---> free_memory(data);
22
23 Next, add the line "init_mem_check();"
24 before any memory handling function calls.
25 Lastly, add the line "close_mem_check();"
26 after your last memory handling call.
27
28 If you recompile your program and run it you
29 should see a new file mem_check.log
30
31 If you want to temporarily disable the new macro's and
32 reinstate the stdlib versions, then add the line
33 #define MEM_CHECK 0
34 above the line
35 #include <mem_check.h>
Hints:
Before first commit, do not forget to setup your git environment:
git config --global user.name "your_name_here"
git config --global user.email "your@email_here"

Clone this repository using HTTP(S):
git clone https://rocketgit.com/user/ORpKTKoVQnFhs/Memory_Check

Clone this repository using ssh (do not forget to upload a key first):
git clone ssh://rocketgit@ssh.rocketgit.com/user/ORpKTKoVQnFhs/Memory_Check

Clone this repository using git:
git clone git://git.rocketgit.com/user/ORpKTKoVQnFhs/Memory_Check

You are allowed to anonymously push to this repository.
This means that your pushed commits will automatically be transformed into a merge request:
... clone the repository ...
... make some changes and some commits ...
git push origin main