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.

Sign up for GitHub

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

Jump to bottom

Docs : Content Organization and Documentation Updates #4850

Merged
merged 53 commits into from
Aug 19, 2024
Merged

Docs : Content Organization and Documentation Updates #4850

merged 53 commits into from
Aug 19, 2024

Commits on Aug 16, 2024

  1. Create Subsections of related topics 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    ad4701a View commit details
    Browse the repository at this point in the history

  2. Remove Revision History 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    246d426 View commit details
    Browse the repository at this point in the history

  3. Exclude Subsections from generated Documentation 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    bb84951 View commit details
    Browse the repository at this point in the history

  4. Remove: deprecated Section from generated docs 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    31b34c9 View commit details
    Browse the repository at this point in the history

  5. Disable Todo list 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    f55cf34 View commit details
    Browse the repository at this point in the history

  6. Docs : Hide Namespace and Classes section from output 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    d66ae43 View commit details
    Browse the repository at this point in the history

  7. Merge P4C Overview with P4C root README 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    9fb093c View commit details
    Browse the repository at this point in the history

  8. Minor Fix : missing "`" in directory structure 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    17bc816 View commit details
    Browse the repository at this point in the history

  9. Remove Revision History 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    d5aa7bf View commit details
    Browse the repository at this point in the history

  10. Merge P4C Overview with P4C root README 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    bb2d8ad View commit details
    Browse the repository at this point in the history

  11. Disable Auto Link support for classes/namespaces 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    4b21949 View commit details
    Browse the repository at this point in the history

  12. Merge "Common P4C Utility Functions" as a subsection of "P4C" Page 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    8b14ff1 View commit details
    Browse the repository at this point in the history

  13. Convert file descriptions to Markdown table format in BMv2 "pna_nic" … 

    …Backend

Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    e769a3e View commit details
    Browse the repository at this point in the history

  14. Remove Revision History 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    73b5132 View commit details
    Browse the repository at this point in the history

  15. Merge P4C Overview with P4C root README 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    c8d4d2d View commit details
    Browse the repository at this point in the history

  16. Remove Revision History 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    0a00a7d View commit details
    Browse the repository at this point in the history

  17. Merge P4C Overview with P4C root README 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    5b698e1 View commit details
    Browse the repository at this point in the history

  18. Content for P4test Backend 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    f9b49fb View commit details
    Browse the repository at this point in the history

  19. Refactor : Organize portable_common directory file descriptions 

    Organize `portable_common` directory file descriptions into a table format
Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    189e7b1 View commit details
    Browse the repository at this point in the history

  20. Hide Doxygen Commands from GitHub Markdown render 

    Using the New Doxygen comment style in v1.12.0 i.e.
`<!-- ... -->`
For details - p4lang#4861

Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    f30ab61 View commit details
    Browse the repository at this point in the history

  21. Create Subsections of related topics 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    6bc4f98 View commit details
    Browse the repository at this point in the history

  22. Docs : Hide Namespace and Classes section from output 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    f429076 View commit details
    Browse the repository at this point in the history

  23. Merge P4C Overview with P4C root README 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    e4669ce View commit details
    Browse the repository at this point in the history

  24. Remove Revision History 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    8beba5e View commit details
    Browse the repository at this point in the history

  25. Merge P4C Overview with P4C root README 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    207643f View commit details
    Browse the repository at this point in the history

  26. Content for P4test Backend 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    f03ca1e View commit details
    Browse the repository at this point in the history

  27. Fix : removed extra Command 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    f56c689 View commit details
    Browse the repository at this point in the history

  28. Organize IR Classes descriptions into a table format 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    f2084d4 View commit details
    Browse the repository at this point in the history

  29. chore: Add TOC to content-rich pages 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    163f9d6 View commit details
    Browse the repository at this point in the history

  30. Remove TOC from Changelogs 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    495708d View commit details
    Browse the repository at this point in the history

  31. Exclude GitHub markdown TOC from Doxygen output 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    1c5b262 View commit details
    Browse the repository at this point in the history

  32. Highlight sample backends in P4C with a dedicated heading 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    75c3712 View commit details
    Browse the repository at this point in the history

  33. Merged: BMv2 "pna_nic" Backend into Behavioral Model Backend 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    00640c8 View commit details
    Browse the repository at this point in the history

  34. Merge P4C IR Classes into IR Page 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    3f9a736 View commit details
    Browse the repository at this point in the history

  35. Change the top of tree view from "P4C" -> "P4 Compiler Documentation … 

    …(P4C)"

Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    47b6fcc View commit details
    Browse the repository at this point in the history

  36. Change root page heading "P4C" -> "Getting Started" 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    f02b39c View commit details
    Browse the repository at this point in the history

  37. Move changelogs to the end of Side bar 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    8fe8973 View commit details
    Browse the repository at this point in the history

  38. Improve Getting started page heading 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    d0a320c View commit details
    Browse the repository at this point in the history

  39. Merge "portable_common" section under "bmv2" 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    4c8845d View commit details
    Browse the repository at this point in the history

  40. Minor formatting Fixes 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    3fe345a View commit details
    Browse the repository at this point in the history

  41. Minor command fix 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    630671f View commit details
    Browse the repository at this point in the history

  42. Fix: Broken Table structure in Doxygen output 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    1a09833 View commit details
    Browse the repository at this point in the history

  43. Refactor : Page headings 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    37f3574 View commit details
    Browse the repository at this point in the history

  44. Refactor : Ordering of backends 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    0f50ab8 View commit details
    Browse the repository at this point in the history

  45. Enable Nice URL for generated docs 

    Current default doxygen URL config Output-
https://p4lang.github.io/p4c/md__2home_2runner_2work_2p4c_2p4c_2backends_2dpdk_2_r_e_a_d_m_e.html

Updated -
https://p4lang.github.io/p4c/dpdk_backend.html

Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    1f9cf35 View commit details
    Browse the repository at this point in the history

Commits on Aug 17, 2024

  1. Doc: Add inclusion notes to Documented Markdown files 

    - Added comments to indicate whether each README is included as a standalone page, a subsection, or not included in the P4 compiler documentation.
- Provided specific links to relevant sections or pages within the documentation.

Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 17, 2024
    Configuration menu
    Copy the full SHA
    baf408b View commit details
    Browse the repository at this point in the history

  2. Docs: Add remaining documentation inclusion notes 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 17, 2024
    Configuration menu
    Copy the full SHA
    060fd69 View commit details
    Browse the repository at this point in the history

  3. Add GitHub profile links for Core developers of p4tools 

    Compatible with GitHub and Doxygen

Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 17, 2024
    Configuration menu
    Copy the full SHA
    70e2064 View commit details
    Browse the repository at this point in the history

  4. Fix: formatting of inclusion note 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 17, 2024
    Configuration menu
    Copy the full SHA
    28902d7 View commit details
    Browse the repository at this point in the history

Commits on Aug 18, 2024

  1. Docs: Side bar grouping of backends 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 18, 2024
    Configuration menu
    Copy the full SHA
    c7cd051 View commit details
    Browse the repository at this point in the history

  2. Add Introduction for Frontend and Midend 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 18, 2024
    Configuration menu
    Copy the full SHA
    f0fcbaf View commit details
    Browse the repository at this point in the history

Commits on Aug 19, 2024

  1. Update lib/README.md 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>

Co-authored-by: Fabian Ruffy <5960321+fruffy@users.noreply.github.com>
Signed-off-by: Adarsh Rawat <adarshbunny293@gmail.com>
    @AdarshRawat1 @fruffy
    AdarshRawat1 and fruffy committed Aug 19, 2024
    Configuration menu
    Copy the full SHA
    dd6714b View commit details
    Browse the repository at this point in the history

  2. Revert: Changes that are migrated to PR p4lang#4876 

    Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
    @AdarshRawat1
    AdarshRawat1 committed Aug 19, 2024
    Configuration menu
    Copy the full SHA
    adb7e38 View commit details
    Browse the repository at this point in the history