Skip to content

Commit

Permalink
Added some documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Syed Nasim committed Jun 14, 2016
1 parent 66d0340 commit 20c0d69
Show file tree
Hide file tree
Showing 8 changed files with 3 additions and 3 deletions.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Empty file added Documentation/LibbAlloc/hooks
Empty file.
File renamed without changes.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ CFLAGS = -O0 -nostdlib -nostdinc -I./include/ -std=gnu99
AR = ar
OBJS=
DESTDIR=
with-liballoc=no
with-liballoc=yes

.PHONY: $(OBJS)

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ For Installation of Libfalcon You should have:
2. NASM. (tested with NASM version 2.09.10)
3. make.

Go to the LibFalcon Project root directory and run `make clean`, just to be sure there are no stale object files. After that run `make all WITH_LIBALLOC=1`. If everything goes well and LibFalcon Compiles correctly, The build system will print "Build Successfull." A file named 'libfalcon.a' should be located on the Project root directory. The library is now almost ready to be linked with your kernel.
Go to the LibFalcon Project root directory and run `make clean`, just to be sure there are no stale object files. After that run `make all`. If everything goes well and LibFalcon Compiles correctly, The build system will print "Build Successfull." A file named 'libfalcon.a' should be located on the Project root directory. The library is now almost ready to be linked with your kernel.

Now you need to provide some functions yourself in your kernel, as LibFalcon relies on them. Without these 'hook functions', you may not be able to link the library with your kernel. (to disable LibAlloc support, simply omit the `WIRH_LIBALLOC=1` part while running `make all`.) The functions are:
Now you need to provide some functions yourself in your kernel, as LibFalcon relies on them. Without these 'hook functions', you may not be able to link the library with your kernel. (to disable LibAlloc support, run `make all with-liballoc=no`.) The functions are:

+ int liballoc_lock()
+ int liballoc_unlock()
Expand Down

0 comments on commit 20c0d69

Please sign in to comment.