[docs] Add Backend to directory structure

[AdarshRawat1]

• Add Backend to directory
• Add Subdirectories of backends

[vlstill]

Good catch this is incomplete.

• Add Subdirectories of backends

How deep do you wish to go? The backends are very different and presumably it is quite rare for one person to actively work on many backends so having the documentation for each backend separately makes more sense to me.

[AdarshRawat1]

Good catch this is incomplete.

Thank you😁

The backends are very different and presumably it is quite rare for one person to actively work on many backends so having the documentation for each backend separately makes more sense to me.

Sure, I was also thinking that, adding the subdirectories in "Compiler source code organization" would make it too cluttered.

How deep do you wish to go?

I initially thought it would be nice if I could cover all the subdirectories in "Compiler source code organization", but as you correctly pointed out that, it's more practical to have them covered in separate readme.
So, It would be better to list the subdirectories in README of the respective directories.

What are your thoughts on this?
May I include directory structure to each backend's Readme .

[fruffy]

So, It would be better to list the subdirectories in README of the respective directories.

Yes, that is the better approach. It will be difficult to maintain the tree for all possible back ends. The back ends are often maintained by independent teams.

[fruffy]

Thanks, some suggestions on rewording.

[AdarshRawat1]

Yes, that is the better approach. It will be difficult to maintain the tree for all possible back ends. The back ends are often maintained by independent teams.

Noted !!
I think with this approach we will also be able to cover all the files and their tasks in backend.

If this sounds right to you then,
I'll open a draft PR where the teams can suggest appropriate descriptions for files and when we're ready with the structure we'll merge it.

[AdarshRawat1]

Thanks, some suggestions on rewording.

Thanks for your suggestions .
I'll update the PR accordingly 🚀

[AdarshRawat1]

Updated the PR based on suggestions.🚀

[AdarshRawat1]

So, It would be better to list the subdirectories in README of the respective directories.

Yes, that is the better approach. It will be difficult to maintain the tree for all possible back ends. The back ends are often maintained by independent teams.

Please have a look at the "Backend source code organization" Section , does this look appropriate to you.
https://github.com/AdarshRawat1/p4c/blob/Docs-3-Trial-File-structure/backends/bmv2/README.md

[fruffy]

Let's clean up some small things then we are good to go.

[AdarshRawat1]

Implemented Suggestions, renamed front end's description also.
i.e. front-end -> front end . [ To avoid extra PR for minor changes ]

[AdarshRawat1]

So, It would be better to list the subdirectories in README of the respective directories.

Yes, that is the better approach. It will be difficult to maintain the tree for all possible back ends. The back ends are often maintained by independent teams.

Please have a look at the "Backend source code organization" Section , does this look appropriate to you. https://github.com/AdarshRawat1/p4c/blob/Docs-3-Trial-File-structure/backends/bmv2/README.md

Please guide me on how this looks to you. Do we add this or not?

[fruffy]

So, It would be better to list the subdirectories in README of the respective directories.

Yes, that is the better approach. It will be difficult to maintain the tree for all possible back ends. The back ends are often maintained by independent teams.

Please have a look at the "Backend source code organization" Section , does this look appropriate to you. https://github.com/AdarshRawat1/p4c/blob/Docs-3-Trial-File-structure/backends/bmv2/README.md

Please guide me on how this looks to you. Do we add this or not?

I would discuss this in a separate PR. However, we do not need to know about every single compilation unit or header file. The folders are meant to give a broad overview over the content.

[AdarshRawat1]

I would discuss this in a separate PR. However, we do not need to know about every single compilation unit or header file. The folders are meant to give a broad overview over the content.

Noted !
I'll focus on the overview of directory structure rather than going to such depth of every unit's functionality😅.