[libre-riscv-dev] style / commit messages

From: Luke Kenneth Casson Leighton <lkcl@lkcl.net>
To: Tobias Platen <tplaten@posteo.de>,
	Tobias Platen <hacks2019@platen-software.de>,
	 Libre-RISCV General Development
	<libre-riscv-dev@lists.libre-riscv.org>
Subject: [libre-riscv-dev] style / commit messages
Date: Fri, 17 Apr 2020 17:38:26 +0100
Message-ID: <CAPweEDwXaPS7ky3WfHncGHokcyFMVzQ3E=sw6eFUFwjE+CH3Rw@mail.gmail.com> (raw)

hi tobias, regarding this commit:

commit f17100d6c435aec47b17acb188272a7e9b3cf67d
Author: Tobias Platen <tplaten@posteo.de>
Date:   Fri Apr 17 16:06:25 2020 +0000

    add with carry instructions

* the addition of the MUL feature needed to be under a separate commit.
 (multiplication doesn't have anything to do with "add with carry instructions")

 you'll have to watch out for this in future.

* whitespace was added at the end: this you particularly have to watch out for
  with vi.  it's why it's specifically in the HDL_workflow.

 please therefore can you correct that one.

* spaces and brackets: please try to keep to PEP8 as much as you can

  the brackets are redundant in this case (unnecessary) and it's definitely a
  style irritation not to have a space between the if and the test.

+        if(cry_out==1):
+            if(result > 0xFFFFFFFF):

 please can you correct those.

* if adding some functionality it's critically important to also add a
corresponding
  unit test, of at least some basic functionality.

  this because if you don't, someone else will have to.  the worst outcome is if
  you add the functionality and someone *assumes* that a unit test has been
  added for it.

i'll assign a bugreport to you to make the necessary corrections.

l.

_______________________________________________
libre-riscv-dev mailing list
libre-riscv-dev@lists.libre-riscv.org
http://lists.libre-riscv.org/mailman/listinfo/libre-riscv-dev