From 40dffb2668fca5c907b07b67dc9ad177ee94efae Mon Sep 17 00:00:00 2001 From: Rot127 <45763064+Rot127@users.noreply.github.com> Date: Mon, 23 Sep 2024 03:26:56 +0000 Subject: [PATCH] Documentation updates (#2476) * Remove Windows msvc project files and move build instructions to single BUILDING.md file. * Move HACK.txt to Contributing and update it. * Add refactoring guide. * Add known bugs * Remove compatibility headers. * Fix smaller issues. * Remove 'possible revert' column. People always can do manual changes. * Move instruction alias description to the top * Add table to general breaking changes. * Update general release guide with the newest information. * Highlight NanoMips and be more precise in writing. * Add note about archs without alias. * Add sentence about what is planned. * Small corrections for Windows build instructions and debug macros. * Fix rebase issues. * Bring back make.sh for the CI --- .github/workflows/CITest.yml | 5 +- BUILDING.md | 89 +++ CMakeLists.txt | 4 - COMPILE_CMAKE.TXT | 131 ---- COMPILE_MAKE.TXT | 4 +- COMPILE_MSVC.TXT | 125 ---- CONTRIBUTING.md | 114 ++++ HACK.TXT | 135 ---- README.md | 14 +- contrib/cs_driver/README | 2 - docs/cs_v6_release_guide.md | 584 ++++++++++-------- include/capstone/capstone.h | 61 -- msvc/README | 22 - msvc/capstone.sln | 337 ---------- msvc/capstone_dll/capstone_dll.vcxproj | 242 -------- msvc/capstone_static/capstone_static.vcxproj | 231 ------- .../capstone_static_winkernel.vcxproj | 175 ------ msvc/cstool/cstool.vcxproj | 180 ------ msvc/test_arm/test_arm.vcxproj | 164 ----- msvc/test_basic/test_basic.vcxproj | 164 ----- msvc/test_bpf/test_bpf.vcxproj | 164 ----- .../test_customized_mnem.vcxproj | 164 ----- msvc/test_detail/test_detail.vcxproj | 164 ----- msvc/test_evm/test_evm.vcxproj | 164 ----- msvc/test_iter/test_iter.vcxproj | 164 ----- msvc/test_m680x/test_m680x.vcxproj | 164 ----- msvc/test_m68k/test_m68k.vcxproj | 164 ----- msvc/test_mips/test_mips.vcxproj | 164 ----- msvc/test_mos65xx/test_mos65xx.vcxproj | 164 ----- msvc/test_ppc/test_ppc.vcxproj | 164 ----- msvc/test_riscv/test_riscv.vcxproj | 164 ----- msvc/test_skipdata/test_skipdata.vcxproj | 164 ----- msvc/test_sparc/test_sparc.vcxproj | 164 ----- msvc/test_systemz/test_systemz.vcxproj | 164 ----- msvc/test_tms320c64x/test_tms320c64x.vcxproj | 164 ----- msvc/test_wasm/test_wasm.vcxproj | 164 ----- msvc/test_winkernel/test_winkernel.vcxproj | 138 ----- msvc/test_x86/test_x86.vcxproj | 164 ----- msvc/test_xcore/test_xcore.vcxproj | 164 ----- suite/auto-sync/README.md | 84 +-- suite/auto-sync/RefactorGuide.md | 84 +++ windowsce/COMPILE.md | 2 +- 42 files changed, 640 insertions(+), 5403 deletions(-) create mode 100644 BUILDING.md delete mode 100644 COMPILE_CMAKE.TXT delete mode 100644 COMPILE_MSVC.TXT create mode 100644 CONTRIBUTING.md delete mode 100644 HACK.TXT delete mode 100644 msvc/README delete mode 100644 msvc/capstone.sln delete mode 100644 msvc/capstone_dll/capstone_dll.vcxproj delete mode 100644 msvc/capstone_static/capstone_static.vcxproj delete mode 100644 msvc/capstone_static_winkernel/capstone_static_winkernel.vcxproj delete mode 100644 msvc/cstool/cstool.vcxproj delete mode 100644 msvc/test_arm/test_arm.vcxproj delete mode 100644 msvc/test_basic/test_basic.vcxproj delete mode 100644 msvc/test_bpf/test_bpf.vcxproj delete mode 100644 msvc/test_customized_mnem/test_customized_mnem.vcxproj delete mode 100644 msvc/test_detail/test_detail.vcxproj delete mode 100644 msvc/test_evm/test_evm.vcxproj delete mode 100644 msvc/test_iter/test_iter.vcxproj delete mode 100644 msvc/test_m680x/test_m680x.vcxproj delete mode 100644 msvc/test_m68k/test_m68k.vcxproj delete mode 100644 msvc/test_mips/test_mips.vcxproj delete mode 100644 msvc/test_mos65xx/test_mos65xx.vcxproj delete mode 100644 msvc/test_ppc/test_ppc.vcxproj delete mode 100644 msvc/test_riscv/test_riscv.vcxproj delete mode 100644 msvc/test_skipdata/test_skipdata.vcxproj delete mode 100644 msvc/test_sparc/test_sparc.vcxproj delete mode 100644 msvc/test_systemz/test_systemz.vcxproj delete mode 100644 msvc/test_tms320c64x/test_tms320c64x.vcxproj delete mode 100644 msvc/test_wasm/test_wasm.vcxproj delete mode 100644 msvc/test_winkernel/test_winkernel.vcxproj delete mode 100644 msvc/test_x86/test_x86.vcxproj delete mode 100644 msvc/test_xcore/test_xcore.vcxproj create mode 100644 suite/auto-sync/RefactorGuide.md diff --git a/.github/workflows/CITest.yml b/.github/workflows/CITest.yml index ff992074f..58213779e 100644 --- a/.github/workflows/CITest.yml +++ b/.github/workflows/CITest.yml @@ -7,9 +7,8 @@ on: - "ChangeLog" - "CREDITS.TXT" - "COMPILE_MAKE.TXT" - - "COMPILE_MSVC.TXT" - - "COMPILE_CMAKE.TXT" - - "HACK.TXT" + - "BUILDING.md" + - "CONTRIBUTING.md" - "LICENSE.TXT" - "LICENSE_LLVM.TXT" - "README.md" diff --git a/BUILDING.md b/BUILDING.md new file mode 100644 index 000000000..a6d662a85 --- /dev/null +++ b/BUILDING.md @@ -0,0 +1,89 @@ +# Building Capstone + +This guide describes how to build Capstone with `CMake`. + +## Build commands + +**Unix** + +```bash +cmake -B build -DCMAKE_BUILD_TYPE=Release # For debug build change "Release" to "Debug" +cmake --build build +cmake --install build --prefix "" +``` + +**Windows** + +```bash +cmake.exe -B build +cmake.exe --build build --config Release # For debug build change "Release" to "Debug" +cmake.exe --install build +``` + +## Tailor Capstone to your needs. + +Enable and disable options in the "configure" step (first `cmake` command from above). +Options are added with `-D