Skip to content

Reworked documentation#7

Closed
Vineet1101 wants to merge 2 commits intoHapCommSys:mainfrom
Vineet1101:main
Closed

Reworked documentation#7
Vineet1101 wants to merge 2 commits intoHapCommSys:mainfrom
Vineet1101:main

Conversation

@Vineet1101
Copy link
Collaborator

This PR make changes in the documentation to make it more clear and concise by adding bash script so that user can easily follow the steps

…tation

Signed-off-by: Vineet1101 <Vineetgoel692@gmail.com>
@Vineet1101
Copy link
Collaborator Author

@Mingyumaz I have made some changes in the docs as per suggestions in this PR . Please review it

@Dscano Dscano requested a review from Mingyumaz February 17, 2026 06:44
Signed-off-by: Vineet1101 <Vineetgoel692@gmail.com>
@Mingyumaz Mingyumaz closed this Feb 19, 2026
@Mingyumaz
Copy link
Contributor

I’ve already addressed this issue by correcting the improper path configurations.

  1. New utility functions (format-utils.h / format-utils.cc):
GetP4SimDir() — reads $P4SIM_DIR env var (with executable-relative fallback)
GetP4ExamplePath() — returns GetP4SimDir() + "/examples/p4src"

16 example scripts refactored to use portable paths:

p4-basic-controller.cc, p4-basic-example.cc, p4-basic-tunnel.cc, p4-controller-action-profile.cc, p4-firewall.cc, p4-ipv4-animation.cc, p4-l3-router.cc, p4-link-monitoring.cc, p4-psa-ipv4-forwarding.cc, p4-queue-test.cc, p4-source-routing.cc, p4-spine-leaf-topo.cc, p4-topo-fattree.cc, p4-v1model-ipv4-forwarding.cc, routing-test.cc
Deleted: test-flow-table.cc (obsolete)
  1. CMakeLists.txt: Removed flow-table-test target, fixed p4-action-profile → p4-controller-action-profile naming

  2. Documentation (vm-env.md): Removed emojis, professional TOC, documented P4SIM_DIR setup and path helper pattern, added troubleshooting cross-references

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.

2 participants

Comments