Skip to content

Comments

doc: rewrite and restructure doc/P4sim/README.md#722

Merged
jafingerhut merged 2 commits intop4lang:masterfrom
Mingyumaz:master
Feb 22, 2026
Merged

doc: rewrite and restructure doc/P4sim/README.md#722
jafingerhut merged 2 commits intop4lang:masterfrom
Mingyumaz:master

Conversation

@Mingyumaz
Copy link
Contributor

Summary

This PR rewrites and restructures doc/P4sim/README.md to improve clarity, fix errors, and make it suitable for the p4lang official repository.

Changes

  • Rewrote the introduction and key features list for clarity
  • Added a full step-by-step local installation guide (Ubuntu 24.04, ns-3.39 or earlier) with bash code blocks
  • Added explanation for why ns-3.39 or earlier is required (C++17 vs C++20 constraint with bmv2)
  • Added P4SIM_DIR environment variable setup instructions
  • Added mailto: links for maintainer and contributor emails
  • Restored missing references in Publications

Signed-off-by: Mingyu Ma <mingyu.ma@tu-dresden.de>
Signed-off-by: mingyuma <mingyu.ma@tu-dresden.de>
@github-actions
Copy link

Welcome to the project, @Mingyumaz!

It looks like this is your first contribution. We noticed the DCO (Developer Certificate of Origin) check might fail if your commits aren't signed.

To fix this, please ensure every commit has a Signed-off-by: Name <email> line. You can do this automatically by using the -s flag:
git commit -s -m "Your message"

For existing commits, you can fix them with:
git commit --amend --signoff or git rebase -i HEAD~N --signoff (where N is the number of commits)
The Developer Community DCO guide also provides helpful tips on fixing DCO inconveniences. Setting a commit hook in the git repository will automate adding the DCO signoff.
See https://github.com/p4lang/governance/wiki/P4-DCO-Guidelines for information.

@Dscano Dscano requested review from Dscano and jafingerhut February 22, 2026 20:24
Comment on lines +16 to +17
* Portable Switch Architecture (PSA)
* Portable NIC Architecture (PNA) — not yet fully implemented
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please add links to the specs?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Linking to this page for all P4.org specifications should be good, unless you want to link to a particular version of one of the spec documents: https://p4.org/specifications/

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking of linking to the latest version of each document, but your proposal is actually better.

Copy link
Collaborator

@jafingerhut jafingerhut left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jafingerhut
Copy link
Collaborator

I have tried out these instructions, they worked for me on an x86_64 Ubuntu 24.04 system as written without any problems, so I am approving and will merge these in. It would be nice to have links to the spec documents, but I am fine with those links being added with a later PR.

@jafingerhut jafingerhut merged commit 65ac26d into p4lang:master Feb 22, 2026
2 checks passed
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.

3 participants