From 686083bdab679d40abc262dbb1f78d8a6cc650a6 Mon Sep 17 00:00:00 2001 From: Alessandro Di Federico Date: Fri, 25 Oct 2024 10:04:48 +0200 Subject: [PATCH] Remove mentions to revng-c --- README.md | 3 --- docs/Overview.rst | 2 -- include/revng/Support/GraphAlgorithms.h | 4 ++-- share/doc/revng/user-manual/analyses.md | 11 +++-------- share/doc/revng/user-manual/working-environment.md | 14 +++++--------- share/revng/clang-format-style-file.yml | 1 - 6 files changed, 10 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 8a8d4dc33..f4e29f5d4 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,6 @@ rev.ng is an open source binary analysis framework based on LLVM and QEMU. It features a full-fledged decompiler. It's developed by [rev.ng Labs](https://rev.ng/about) in the open. -This repository contains the source code of the rev.ng infrastructure and of the lifter. You can find the source of the decompiler in the [`revng-c` repository](https://github.com/revng/revng-c). -Eventually, these two repositories will be merged. - ## Getting started Head to the [online documentation](https://docs.rev.ng) to get started ([source](share/doc/revng/index.md)). diff --git a/docs/Overview.rst b/docs/Overview.rst index 541011df2..24cfd6cf6 100644 --- a/docs/Overview.rst +++ b/docs/Overview.rst @@ -19,8 +19,6 @@ Once rev.ng has produced the LLVM IR, there are two core things that you can do: In the former case, the goal is to understand what the program does. One of the core goals of the rev.ng project as a whole is, in fact, to build a decompiler, i.e., a tool able to produce C code representing the behavior of the program. -To know more about the rev.ng decompiler, revng-c, check out the `dedicated page -`_. The other use case for rev.ng is to recompile the lifted IR to an executable binary. Typically, we do this for ensuring the accuracy of the lifting process, but there are interesting use cases. diff --git a/include/revng/Support/GraphAlgorithms.h b/include/revng/Support/GraphAlgorithms.h index 2278b7605..03194058d 100644 --- a/include/revng/Support/GraphAlgorithms.h +++ b/include/revng/Support/GraphAlgorithms.h @@ -252,8 +252,8 @@ public: } // namespace revng::detail -// TODO: remove the `BlackList`/`WhiteList` parameter once the last use in -// `revng-c` is dropped, checking that no other uses are still present +// TODO: remove the `BlackList`/`WhiteList` parameter once the last use is +// dropped, checking that no other uses are still present template> diff --git a/share/doc/revng/user-manual/analyses.md b/share/doc/revng/user-manual/analyses.md index c82d013dd..6124bbff8 100644 --- a/share/doc/revng/user-manual/analyses.md +++ b/share/doc/revng/user-manual/analyses.md @@ -38,11 +38,6 @@ $ revng analyze \ revng-initial-auto-analysis \ example \ -o /dev/null -$ revng analyze \ - --resume=working-directory \ - revng-c-initial-auto-analysis \ - example \ - -o /dev/null $ revng artifact \ --resume=working-directory \ decompile-to-single-file \ @@ -55,13 +50,13 @@ generic64_t main(generic64_t argument_0) { ``` The commands above are *stateful*, they build on top of each other storing intermediate results into the directory specified by the `--resume` parameter. -The first command runs the set of initial autoanalyses of `revng`, the open source component of rev.ng, the second the analyses of `revng-c`, in particular Data LayoutAnalysis, and the last one produces the decompiled code. +The first command runs the set of initial autoanalyses of `revng` and the last one produces the decompiled code. -Alternatively, you can run `revng-initial-auto-analysis`, `revng-c-initial-auto-analysis` *and* produce the artifact with a single command: +Alternatively, you can run `revng-initial-auto-analysis` *and* produce the artifact with a single command: ```bash $ revng artifact \ - --analyses=revng-initial-auto-analysis,revng-c-initial-auto-analysis \ + --analyze \ decompile-to-single-file \ example \ | revng ptml \ diff --git a/share/doc/revng/user-manual/working-environment.md b/share/doc/revng/user-manual/working-environment.md index 96763c9fa..5543e6c19 100644 --- a/share/doc/revng/user-manual/working-environment.md +++ b/share/doc/revng/user-manual/working-environment.md @@ -79,13 +79,10 @@ At this point, from the `orchestra` repository, we can sync all the information $ orc update ``` -Currently, rev.ng is split in two repositories `revng`, containing infrastructure and the lifter, and `revng-c` containing the backend of the decompiler, the part actually emitting the C code. -These two repos will eventually get merged. - -To install `revng`, `revng-c` and its dependencies from the binary archives run the following command: +To install `revng` and its dependencies from the binary archives run the following command: ```{bash notest} -$ orc install revng revng-c +$ orc install revng ``` Now you can enter the environment where you can use `revng`: @@ -114,13 +111,12 @@ In order to build from source, add the following to `.orchestra/config/user_opti +#@overlay/replace +build_from_source: + - revng -+ - revng-c ``` -We can now install and test `revng` and `revng-c`: +We can now install and test `revng`: ```{bash notest} -$ orc install --test revng revng-c +$ orc install --test revng ``` -This will clone the sources into `sources/revng` and `sources/revng-c`, build them, install them (in `root/`) and run the test suites. +This will clone the sources into `sources/revng`, build them, install them (in `root/`) and run the test suites. diff --git a/share/revng/clang-format-style-file.yml b/share/revng/clang-format-style-file.yml index 314830615..6ba78f690 100644 --- a/share/revng/clang-format-style-file.yml +++ b/share/revng/clang-format-style-file.yml @@ -75,7 +75,6 @@ IncludeBlocks: Regroup, IncludeCategories: [ - { Regex: '^"revng-c/', Priority: -1 }, { Regex: '^"revng/', Priority: -2 }, { Regex: '^"clang/', Priority: -3 }, { Regex: '^"mlir/', Priority: -4 },