This small guide is written as a reminder for self to save time the next time I have to use it.<\/p>\n\n\n\n
As the current version used is ancient and still runs under “PRQA Framework”, this guide might be outdated soon.<\/p>\n\n\n\n
I will list what goes into each entries:<\/p>\n\n\n\n
Once done click create.<\/p>\n\n\n\n
Normally project settings automatically open after creation. The usual steps I take for setting up the project.<\/p>\n\n\n\n
Editing the macro for SOURCE_ROOT to point to the <git_repository_root>. To do this if the project files have been created as mentioned above:<\/p>\n\n\n\n
${PROJECT_ROOT}\\..\\..<\/code><\/pre>\n\n\n\nSync Settings<\/h3>\n\n\n\n
Leave it default. The include folders and defines will be sorted out in a separate more efficient way.<\/p>\n\n\n\n
Baseline<\/h3>\n\n\n\n
For creating new project it is best left default. I might explain how to use it later. <\/p>\n\n\n\n
Analysis<\/h3>\n\n\n\n
There are a couple of steps to do here.<\/p>\n\n\n\n
If a custom rule file has been used, it is very likely the messages database needs to change as well. Re-browse the correct message file in “User Messages File”.<\/p>\n\n\n\n
Component settings (in this case qac and namecheck):<\/p>\n\n\n\n
For QAC edit the following entries:
-via as text:<\/p>\n\n\n\n
${PROJECT_ROOT}\/settings.via<\/code><\/pre>\n\n\n\nThis is where all the include- and preprocessor definition flags will be added later.<\/p>\n\n\n\n
For Namechek edit the following entries:<\/p>\n\n\n\n
-namerulefile: Browse the .ncf file that contains the regex rules.<\/p>\n\n\n\n
Rule configuration, Compiler selection, Version Control Configuration<\/h3>\n\n\n\n
These can be left alone.<\/p>\n\n\n\n
Converting project includes and definitions into “settings.via”<\/h2>\n\n\n\n
TIP: Make use of the replace feature of text editors to preserve your sanity.<\/strong><\/p>\n\n\n\nNavigate to QAC project root. Create a new text file “settings.via”.<\/p>\n\n\n\n
In my latest case I used IAR, this is how a line of include definition was taken from the project settings:<\/p>\n\n\n\n
$PROJ_DIR$\/..\/User\/inc\/<\/code><\/pre>\n\n\n\nIAR projects directories are usually located at:
<git_repository_root>\/<Project Name>\/EWARM\/<\/p>\n\n\n\n
We need to make this entry to point from QAC project root.
As a reminder the root is at:
<git_repository_root>\/QAC\/<qac_project_name>
The resulting entry should look like:<\/p>\n\n\n\n
First converting IAR include to point from <git_root>\n<IAR Project Name>\/EWARM\/..<\/strong>\/User\/Inc\n\nWe can simplify it:\n<IAR Project Name>\/User\/Inc\n\nThen we add the bit to point from QAC project root:\n..\/..\/<IAR Project Name>\/User\/Inc\n\nFinally since this is supposed to look like a compiler flag so we add -I in front. It is a good practice to add quotation marks around the file path:\n-I\"..\/..\/<IAR Project Name>\/User\/Inc\"<\/code><\/pre>\n\n\n\n
Now for the preprocessor define macros:<\/p>\n\n\n\n
IAR version:\nUSE_FULL_LL_DRIVER\nRANDOMFLAG=1\n\nQAC version:\n-D\"USE_FULL_LL_DRIVER\"\n-D\"RANDOMFLAG=1\"<\/code><\/pre>\n\n\n\nSave and the project should be set up.<\/p>\n\n\n\n
Adding Source files<\/h2>\n\n\n\n
In the left “Files” tab, right click QAC and select “Add File(s)”<\/p>\n\n\n\n
Select all folders and files QAC should be analysing.<\/p>\n\n\n\n
<\/p>\n\n\n\n
<\/p>\n\n\n\n
<\/p>\n\n\n\n
<\/p>\n\n\n\n
These are all the settings that’s necessary for a basic QAC project setup.<\/p>\n\n\n\n
<\/p>\n\n\n\n
<\/p>\n\n\n\n
Minor Fix for IAR<\/h2>\n\n\n\n
QAC really hates IAR’s __attribute__(<anything>) macros.
Instead of #pragma packed IAR uses __attribute__(__packed__).<\/p>\n\n\n\n
Luckily this is an easy fix:
In Project Settings\/Analysis\/QAC for -d create a new entry<\/p>\n\n\n\n
__attribute__=_ignore_paren<\/code><\/pre>\n\n\n\nApparently this is QACs way of ignoring __attribute__ entries with their bracket contents.<\/p>\n