rusefi
/
rusefi_documentation
mirror of https://github.com/rusefi/rusefi_documentation.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Try to make docs more clear

This commit is contained in:
David Holdeman 2022-04-11 13:20:55 -05:00 committed by GitHub
parent 4ca50483d3
commit a5fb7823ce
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Dev/Dev-Tips.md
View File

@ -12,12 +12,12 @@ console/binary/tunerstudio_outputs.h
See the [documentation main page](https://rusefi.com/docs/html/#config) for more information and tips on how to use these files.
Q: Do new outputs need to be added at the end and their space taken out of mainUnusedEnd[]?
A: Look at the diff. if the diff is not crazy you are doing it right. If the diff touches too much stuff you are doing it wrong.
Q: Do new fields need to be added at the end and their space taken out of mainUnusedEnd[]?
A: Look at the diff after generating config files (i.e. using `firmware/gen_config.sh`). If the diff is not crazy you are doing it right. If the diff touches too much stuff you are doing it wrong.
In practice I have found this to mean that they should be added to the end.
Usually the tradition is not to move other existing fields for no reason. Starting an array at an odd offset is also unusual.
Let's work around existing fields without shifting them please.
There may be unused "padding" variables spread throughout that can be replaced with your new variables, particularly of the 'bit' type, as we do bit packing for better communication efficiency.
There may be unused padding variables spread throughout that can be replaced with your new variables, particularly of the 'bit' type, as we do bit packing for better communication efficiency. You will likely be able to find a few uint8_t or uint16_t padding fields to replace with your new variables as well. The tradition is to name them "unusedSomething", so you can find them by searching for "unused" in rusefi_config.txt.
Check config/boards/kinetis/config/controllers/algo/engine_configuration_generated_structures.h after generating to ensure the total size is 20000