mirror of
https://github.com/revng/revng
synced 2026-06-21 14:07:57 +00:00
Remove mentions to revng-c
This commit is contained in:
@@ -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)).
|
||||
|
||||
@@ -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
|
||||
<https://rev.ng/revngc-features.html>`_.
|
||||
|
||||
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.
|
||||
|
||||
@@ -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<revng::detail::FilterSet FilterSetType,
|
||||
class GraphT,
|
||||
class GT = llvm::GraphTraits<GraphT>>
|
||||
|
||||
@@ -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 \
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -75,7 +75,6 @@
|
||||
IncludeBlocks: Regroup,
|
||||
IncludeCategories:
|
||||
[
|
||||
{ Regex: '^"revng-c/', Priority: -1 },
|
||||
{ Regex: '^"revng/', Priority: -2 },
|
||||
{ Regex: '^"clang/', Priority: -3 },
|
||||
{ Regex: '^"mlir/', Priority: -4 },
|
||||
|
||||
Reference in New Issue
Block a user