Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move & isolate example user dir #713

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from

Conversation

sksat
Copy link
Collaborator

@sksat sksat commented Nov 15, 2024

Related issues

Description

Currently, s2e-core has two responsibilities: first: library as the core functionality of S2E; second: sample implementation of S2E user.

However, these are both located in the same directory (root), so it is very difficult to tell where the sample implementation begins. This is a significant barrier for beginners.
Also, when we want to create a new S2E user, the current sample implementation cannot be copied in its entirety and used like a template.

In this PR, create a new directory, example/, and isolate the sample implementation into it.

Test results

build & run

# ExtLibraries setup required
$ cd example
$ cmake -B build
$ cmake --build build -j
$ ./build/S2E

Impact

No API changes.

Although, the procedure to run example (directory for example) is different.
Therefore, the documentation need to be update.

Supplementary information

For the original purpose, we would also like to move settings, which are data used at runtime.
But, since organizing ExtLibraries would require more changes, this PR is only for the source code.

@sksat sksat added enhancement New feature or request priority::medium priority medium tools labels Nov 15, 2024
@sksat sksat self-assigned this Nov 15, 2024
@sksat sksat requested a review from a team as a code owner November 15, 2024 06:00
@sksat sksat requested review from 200km, ogoogo, Hiro-0110, seki-hiro, suzuki-toshihir0, t-hosonuma and conjikidow and removed request for a team November 15, 2024 06:00
@sksat
Copy link
Collaborator Author

sksat commented Nov 15, 2024

CI も直します(あとで)

@200km
Copy link
Member

200km commented Nov 15, 2024

修正提案ありがたいですが、こちらはちょっと慎重に議論してから進めたいなと思います。

https://github.com/ut-issl/s2e-user-example

こいつの存在もあり、これがコピー元のtemplateになっているので、cannot be copied in its entirety and used like a template.を重視していない文脈などもあります。

@sksat
Copy link
Collaborator Author

sksat commented Nov 15, 2024

テンプレートはそのリポジトリだけでよい、という話であれば、このリポジトリからは事実上の example となっているモノを削除した方がよい、となってしまうのでは。入門者などへの認知負荷軽減のためにも、メンテコスト削減のためにも、どちらかにした方がよいと思います(そして、その場合は s2e-core 内で完結していた方がメンテもしやすいし場所が分散しないので説明もしやすい)。

@200km
Copy link
Member

200km commented Nov 15, 2024

こちら、次回のミーティングで調整させてもらえると嬉しいです。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request priority::medium priority medium tools
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

2 participants