summaryrefslogtreecommitdiff
path: root/CODING_STYLE.rst
AgeCommit message (Collapse)Author
2020-09-10CODING_STYLE.rst: flesh out our naming conventions.Alex Bennée
Mention a few of the more common naming conventions we follow in the code base including common variable names and function prefix and suffix examples. Signed-off-by: Alex Bennée <alex.bennee@linaro.org> Reviewed-by: Thomas Huth <thuth@redhat.com> Message-Id: <20200909112742.25730-2-alex.bennee@linaro.org>
2019-09-05docs: split the CODING_STYLE doc into distinct groupsDaniel P. Berrangé
Reviewed-by: Peter Maydell <peter.maydell@linaro.org> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-09-05docs: document use of automatic cleanup functions in glibDaniel P. Berrangé
Document the use of g_autofree and g_autoptr in glib for automatic freeing of memory. Reviewed-by: Alex Bennée <alex.bennee@linaro.org> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-09-05docs: merge HACKING.rst contents into CODING_STYLE.rstDaniel P. Berrangé
The split of information between the two docs is rather arbitary and unclear. It is simpler for contributors if all the information is in one file. Reviewed-by: Alex Bennée <alex.bennee@linaro.org> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-09-05docs: convert README, CODING_STYLE and HACKING to RST syntaxDaniel P. Berrangé
Reviewed-by: Alex Bennée <alex.bennee@linaro.org> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>