Skip to content

Commit

Permalink
fix documentations for gotcha
Browse files Browse the repository at this point in the history
  • Loading branch information
hariharan-devarajan committed Sep 21, 2023
1 parent 23d9fca commit 23a1082
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ In C or C++ applications, include ``gotcha.h``. See wrap_puts.c_ for a full
example.
.. code-block:: c
#include <unifyfs.h>
#include <gotcha.h>
--------------------------
Define your Gotcha wrappee
Expand Down
2 changes: 1 addition & 1 deletion docs/build.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ desired, then do ``spack install gotcha@develop``.
----------

-------------------------
Build UnifyFS with CMake
Build GOTCHA with CMake
-------------------------

Download the latest GOTCHA release from the Releases_ page or clone the develop
Expand Down
2 changes: 2 additions & 0 deletions docs/limitations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,7 @@ Intra and Intra-library calls
Gotcha works by rewriting the Global Offset Table (GOT) that links inter-library callsites and variable references to their targets.
Because of this Gotcha cannot wrap intra-library calls (such as a call to a static function in C) or calls in statically-linked binaries.
Binary rewriting technology such as DyninstAPI (https://github.com/dyninst/dyninst) is more appropriate for these use cases.
Additionally, the function pointer wrapping feature with GOTCHA only applies to function pointers created after wrapping functions.
The function pointers created before wrapping would not be wrapped by gotcha.


0 comments on commit 23a1082

Please sign in to comment.