This patch adds a coding standards doc to DPDK, and is based off the original version Siobhan posted earlier in the tools discussion. It's been cleaned up a bit, and converted to the rst format to match the rest of the docs.
I've pulled in a lot of the feedback that people gave on the original version, but I'm sure the discussion is going to continue on this. When reviewing please remember: This document is designed to put in writing the *existing* code guidelines for DPDK that are implied by the existing code. It is *not* intended that we should have to make any across-the-board code changes as the basis of this document until after it has been merged in - so if you are suggesting something that is not already prevalent in DPDK code, please hold that thought until after we get the existing style locked down! :-) Also note that there are a few areas where the DPDK is itself not consistent*. This is why there is the general overriding rule that code in each file must be consistent to the rest of the file above all else. * by "not consistent", I'm meaning where there is are more than just a few outliers from the original style. Bruce Richardson (1): doc: add coding standards documentation doc/guides/coding_standards/index.rst | 806 ++++++++++++++++++++++++++++++++++ doc/guides/index.rst | 2 + 2 files changed, 808 insertions(+) create mode 100755 doc/guides/coding_standards/index.rst -- 2.1.0
