Skip to content

Commit 40411f0

Browse files
authored
Update index.md
1 parent efcc8b8 commit 40411f0

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

docs/index.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,34 +3,32 @@ layout: default
33
---
44

55

6-
## What is RUPTA
6+
## What is RUPTA?
77

8-
RUPTA is a pointer analysis framework for Rust, identifiying relationships between pointer variables and the memory locations that they point to in a program. It functions on Rust's Mid-level Intermediate Representation (MIR) and supports k-callsite context-sensitivity.
8+
RUPTA is a pointer analysis framework designed for Rust. It identifies relationships between pointer variables and the memory locations they reference within a Rust program. RUPTA operates on Rust's Mid-level Intermediate Representation (MIR) and currently supports k-callsite context-sensitivity.
99

1010
RUPTA can also be used to [construct precise call graphs](https://github.com/rustanlys/rupta/wiki/Analyze-a-Simple-Rust-Program#dump-the-call-graph) for Rust programs.
1111

12-
We refer to [SVF](https://svf-tools.github.io/SVF) for a pointer analysis framework that works for C and C++, and [Qilin](https://qilinpta.github.io/Qilin) for a pointer analysis framework that works for Java.
12+
We refer to [SVF](https://svf-tools.github.io/SVF) for a pointer analysis framework that works for C/C++, and [Qilin](https://qilinpta.github.io/Qilin) for a pointer analysis framework that works for Java.
1313

1414
## How to setup RUPTA?
1515

16-
Please download the [source code]({{ site.github.source_code_url }}) of RUPTA and refer to this [step-by-step guide](https://github.com/rustanlys/rupta/wiki/Setup-Guide) to setup RUPTA.
17-
16+
Please download the [source code]({{ site.github.source_code_url }}) of RUPTA and consult the [step-by-step guide](https://github.com/rustanlys/rupta/wiki/Setup-Guide) for setting up RUPTA.
1817
## How to use RUPTA?
1918

20-
The main routine RUPTA executable is a stub that invokes the RUST compiler with a call back that invokes RUPTA as part of the rust compilation. It analyzes a Rust program by taking the source code as its input.
21-
RUPTA also smoothly integrates with Cargo, making it possible to compile a Rust project with dependencies and analyze with RUPTA with a single command `cargo pta`.
19+
The main RUPTA executable is a stub that triggers the RUST compiler, incorporating a callback that activates RUPTA during the Rust compilation process. It analyzes a Rust program by processing the source code as its input. Additionally, RUPTA integrates seamlessly with Cargo, enabling the compilation of a Rust project along with its dependencies and allowing analysis through RUPTA using a single command, `cargo pta`.
2220

2321
Please refer to [this user guide](https://github.com/rustanlys/rupta/wiki/User-Guide) to run RUPTA with [a simple example](https://github.com/rustanlys/rupta/wiki/Analyze-a-Simple-Rust-Program) and generate the [analysis outputs](https://github.com/rustanlys/rupta/wiki/User-Guide#output-options) on your local machine.
2422

25-
Please refer to this [documentation]({{ site.github.doc_url }}) to understand the internal working of RUPTA.
23+
Please refer to this [documentation]({{ site.github.doc_url }}) to understand the internal workings of RUPTA.
2624

2725
## License
2826

2927
GPLv3
3028

3129
## Reference
3230

33-
You are welcome to use RUPTA for research and development purposes under the license given. Please acknowledge the use of this tool by citing our CC'24 paper.
31+
You are welcome to use RUPTA for research and development purposes under the provided license. Please acknowledge the use of this tool by citing our CC'24 paper.
3432

3533
Wei Li, Dongjie He, Yujiang Gui, Wenguang Chen, and Jingling Xue. [A Context-Sensitive Pointer Analysis Framework for Rust and Its Application to Call Graph Construction](https://doi.org/10.1145/3640537.3641574), 33rd ACM SIGPLAN International Conference on Compiler Construction (CC'24).
3634

0 commit comments

Comments
 (0)