3 Commits

Author	SHA1	Message	Date
Laine Stump	866bb99644	docs: point out that locals should be defined at the top of a block of code ... Although we have nothing in make syntax-check to enforce this, and apparently there are places where it isn't the case (according to Dan), we should discourage the practice of defining new variables in the middle of a block of code. https://www.redhat.com/archives/libvir-list/2020-July/msg00433.html Signed-off-by: Laine Stump <laine@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> Reviewed-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Pavel Hrdina <phrdina@redhat.com>	2020-07-10 13:42:42 -04:00
Andrea Bolognani	f42be8a2ef	docs: Use definition list instead of table in coding style ... This format is much easier to tweak and update. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>	2020-05-11 13:55:25 +02:00
Andrea Bolognani	5155f6f4b1	docs: Add coding-style.rst ... This part represents the biggest chunk of the existing hacking.rst, and despite that its utility is very limited because 'make syntax-check' already guarantees most of the rules are followed over time. Until the glorious day we finally codify our coding style completely into a configuration for a tool such as clang-format and thus no longer need a plain English description of it, move this part to a separate page. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>	2020-04-08 09:32:30 +02:00