summaryrefslogtreecommitdiffstats
path: root/js/src/zydis/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
commit36d22d82aa202bb199967e9512281e9a53db42c9 (patch)
tree105e8c98ddea1c1e4784a60a5a6410fa416be2de /js/src/zydis/README.md
parentInitial commit. (diff)
downloadfirefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.tar.xz
firefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.zip
Adding upstream version 115.7.0esr.upstream/115.7.0esr
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'js/src/zydis/README.md')
-rw-r--r--js/src/zydis/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/js/src/zydis/README.md b/js/src/zydis/README.md
new file mode 100644
index 0000000000..3336a49cbd
--- /dev/null
+++ b/js/src/zydis/README.md
@@ -0,0 +1,22 @@
+# Zydis disassembler
+
+Zydis x64/x86 disassembler imported from github, see
+https://github.com/zyantific/zydis and https://github.com/zyantific/zycore-c.
+
+Zydis is MIT licensed code, see Zydis/LICENSE and Zycore/LICENSE.
+
+Sources here were taken from the tag/revision of Zydis that is recorded in the
+file imported-revision.txt.
+
+The file hierarchy of Zydis+Zycore has been flattened and processed as described
+in the script update.sh.
+
+## Integrating new versions of Zydis
+
+The procedure for pulling a new version is encoded in the script update.sh,
+which is to be run from the parent directory of zydis, ie, from js/src/. It
+will create a new zydis directory and pull new files from github into it,
+leaving the old zydis directory as zydis_old.
+
+It's not a given that the script will work out of the box for new versions of
+zydis or that the resulting files will build as-is. Buyer beware.