diff --git a/plugins/README b/plugins/README index c16a8fd0..63a6a53c 100644 --- a/plugins/README +++ b/plugins/README @@ -10,11 +10,13 @@ The plugins are written to be compiled against an *installed* yasm. Plugins may be loaded on the yasm command line using the -N command line option, e.g.: yasm -N ./libdbgmod.so + yasm -N Release/dbgmod.dll yasm -N /usr/local/lib/libx86mod (the .so will be automatically appended) If no directory path is specified, yasm will search in standard library locations (e.g. LD_LIBRARY_PATH, the rpath of the yasm executable, etc) to -try to load the plugin. Thus the last example could likely be written: - yasm -N libx86mod +try to load the plugin. Thus the last example (after installing the plugin) +could likely be written: + yasm -N x86mod Plugins may override builtin modules like x86. diff --git a/plugins/dbg/README b/plugins/dbg/README index 3a1f5cb7..d4fdbc58 100644 --- a/plugins/dbg/README +++ b/plugins/dbg/README @@ -7,9 +7,15 @@ To build: cmake .. make -Testing: +Testing (on Windows): + yasm -N Release/dbgmod.dll -f dbg - + db 5 + ^Z + +Testing (on Unix): yasm -N ./libdbgmod.so -f dbg - db 5 ^D -(result lines will have PLUGIN prefixed to the function calls; this -demonstrates the plugin is being used rather than the builtin dbg module) + +Result lines will have PLUGIN prefixed to the function calls; this +demonstrates the plugin is being used rather than the builtin dbg module. diff --git a/plugins/x86/README b/plugins/x86/README index 17346155..dddedd0d 100644 --- a/plugins/x86/README +++ b/plugins/x86/README @@ -1,10 +1,19 @@ This directory demonstrates how to build a yasm builtin module as a plugin. This can be useful for integrating custom changes without rebuilding/reinstalling yasm. -It requires access to the yasm source. -The yasm source directory must be defined to cmake, e.g. +It requires access to the yasm source. It defaults to assuming it is being +built inside of the yasm source tree. + +To build: mkdir objdir cd objdir - cmake -DYASM_SOURCE_DIR=/home/foo/yasm .. + cmake .. make + +Testing (on Windows): + yasm -N Release/x86mod.dll -f x86 ... + +Testing (on Unix): + yasm -N ./libx86mod.so -f x86 ... +