Skip to content

docs: drop non-existent "make environment" target - #9

Open
dajiaohuang wants to merge 1 commit into
0dayResearchLab:masterfrom
dajiaohuang:docs/remove-nonexistent-make-environment
Open

dajiaohuang wants to merge 1 commit into
0dayResearchLab:masterfrom
dajiaohuang:docs/remove-nonexistent-make-environment

Conversation

@dajiaohuang

Copy link
Copy Markdown

Error

Section 6 of docs/installation/README.md says to pick one of three targets built by the
examples role to load the driver/harness into the guest, and lists:

   - make environment
     Skips the built‑in WinRM scripts. Use this if you prefer to configure the QEMU/WinRM environment manually.

The Makefile that make deploy -- --tags examples,examples-template-windows clones
(kafl.targets/windows_x86_64/Makefile, examples_url in
deploy/intellabs/kafl/roles/examples/defaults/main.yml) defines only init, revoke,
gui, compile, target and no_target. Running make environment in that directory
fails with:

make: *** No rule to make target 'environment'.  Stop.

Change

Remove the make environment option so the guide only lists targets that exist. Manual
setup is still possible with the vagrant up --no-provision step that the guide already
uses in item 2.

Validation

  • Compared the guide against kafl.targets@master (the repository cloned by the examples
    role); the target list above is the complete set of rules in that Makefile.
  • Documentation-only change; no code paths affected.
  • Separately, PR Fix replay tool output buffer sizing and usage instructions #8 fixes the replay-tool instructions at the end of the same guide.

The Windows target Makefile that the examples role clones
(kafl.targets/windows_x86_64/Makefile) only defines the targets init,
revoke, gui, compile, target and no_target.  Following the usage guide's
third option fails with "No rule to make target 'environment'", so only
keep the two targets that exist.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant