avast / avast/retdec

High-level documentation of the interaction between tools in the decompilation pipeline

Open
#56 0 comments 0 reactions 1 assignee Claimed by @PeterMatula View on GitHub
C-docs enhancement
Dominant language
C++
Stars
8.6k
Forks
1k
PR merge metrics
No merged PRs in 30d

Description

This issue tracks the addition of high-level documentation, which describes the interaction between the various tools of the decompilation pipeline, what input they take (i.e. which input formats, produced by which tools) and what output they produce.

From my current understanding of the RetDec decompilation pipeline, this could be described with the following graph. For those with better understanding, feel free to update the graph to make it more accurate, and provide additional comments on the interaction between these tools. Once a good high-level documentation has been produced, it may be added as Markdown files to some directory, perhaps `doc`? Or `design`?

DOT file at: https://gist.github.com/mewmew/bf74e6fc0e96ab67576982baacc17937

![RetDec decompilation pipeline](https://i.imgur.com/saanT09.png)

(Note, in the above illustration, blue boxes represent tools, light green circles input and output formats, and darker green circles meta input and output formats. A meta input and output format is a set of formats (e.g. "binary" is ELF or PE or raw, etc).

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.