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

Docs: Initial sequence of pages in Documentation #4758

Merged
merged 5 commits into from
Jun 27, 2024

Conversation

AdarshRawat1
Copy link
Member

What

Reordered the sequence of topics in generated documentation. View mockup for Changes live here

Removed following outdated pages from documentation, until they are updated.

Why

Updated sequence of files listed by Doxygen output based on discussion in

Extra Reference

Current Sequence

List
P4C
Repository
Revision History
Overview
P4 Compiler Intermediate representation
Behavioral Model Backend
DPDK backend
PSA implementation for eBPF backend
eBPF Backend
Graphs Backend
p4fmt (P4 Formatter)
P4test Backend
P4Tools CMake
P4Tools Common Library Code
P4Tools Common C++ code
P4Tools Contributors
README
P4Testgen Benchmarks
P4Testgen Library
P4Testgen
P4Testgen BMv2 target tests
P4Tools - Testing Tools For P4 Targets
TC backend
uBPF Backend test programs
Introduction to uBPF Backend
uBPF Backend testing
Common P4C utility functions
P4C Intermediate Representation (IR) Classes
Changelog
Deprecated List
Todo List
Topics
Namespaces
Classes

Updated Sequence LIVE

List
P4C
Repository
Revision History
Overview
P4 Compiler Intermediate representation
Common P4C utility functions
P4C Intermediate Representation (IR) Classes
Changelog
Behavioral Model Backend
DPDK backend
eBPF Backend
PSA implementation for eBPF backend
Graphs Backend
p4fmt (P4 Formatter)
P4test Backend
P4Tools - Testing Tools For P4 Targets
P4Tools Contributors
README
P4Testgen
P4Testgen Benchmarks
P4Testgen BMv2 target tests
TC backend
Introduction to uBPF Backend
uBPF Backend test programs
uBPF Backend testing
Deprecated List
Todo List
Topics
Namespaces
Classes

@fruffy fruffy added the documentation Topics related to compiler documentation. label Jun 25, 2024
Copy link
Contributor

@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
Contributor

@fruffy It appears DCO is required in order to click the Merge button on Github. Note: That sounds GOOD to me. Just wanted to let you know, since you mentioned recently that you thought it was optional right now.

@AdarshRawat1 I think the only thing needed to commit this is for you to add DCO. You can can click the "Details" link to the right of the failing check labeled "DCO" for instructions on how.

@fruffy
Copy link
Collaborator

fruffy commented Jun 25, 2024

@fruffy It appears DCO is required in order to click the Merge button on Github. Note: That sounds GOOD to me. Just wanted to let you know, since you mentioned recently that you thought it was optional right now.

I think this is because this is a draft pull request.

@AdarshRawat1
Copy link
Member Author

@AdarshRawat1 I think the only thing needed to commit this is for you to add DCO. You can can click the "Details" link to the right of the failing check labeled "DCO" for instructions on how.

Thanks, Done !!

@jafingerhut
Copy link
Contributor

I was wrong. You also need to change the PR so it is no longer in Draft status.

@AdarshRawat1
Copy link
Member Author

I'm just testing to see if anything breaks or is not being rendered. [The list of classes and namespaces].

@AdarshRawat1 AdarshRawat1 marked this pull request as ready for review June 25, 2024 18:00
@fruffy fruffy enabled auto-merge June 25, 2024 20:00
@fruffy
Copy link
Collaborator

fruffy commented Jun 26, 2024

Seems like this PR has broken CI, I would use rebase merge instead of conventional merging. It works much better on Github.

Reference : Without this the output does not include Topics , Namespaces and Classes.

Signed-off-by: Adarsh <[email protected]>
auto-merge was automatically disabled June 26, 2024 16:37

Head branch was pushed to by a user without write access

@fruffy fruffy added this pull request to the merge queue Jun 27, 2024
Merged via the queue into p4lang:main with commit bea29c9 Jun 27, 2024
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Topics related to compiler documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants