README.md: re-wrote "Known Issues" section

Author: firewave

README.md

@@ -40,18 +40,86 @@ See
 
 The plugin provides the `Show Cppcheck XML Output` action which will show the raw XML output of the latest finished analysis.
 
-## Known Issues
+## Known Issues/Limitations
+
+See https://github.com/johnthagen/clion-cppcheck/issues for a complete list of tracked issues and enhancements requests.
+
+### Analyzing header files
 
 `cppcheck` is not designed to be run on header files (`.h`) directly, as must be done for this
 plugin, and as a result may have false positives.
 
 When run on header files directly, `cppcheck` defaults to C as the language, which will generate
-false positives for C++ projects.  C++ projects should append `--language=c++` to the
-`cppcheck` options.
+false positives for C++ projects. So `--language=c++` is implicitly added as option when analyzing header files.
+
+It will also provide `unusedFunction` and `unusedStructMember` false positives so these findings are being suppressed.
+
+Related issues:<br/>
+https://github.com/johnthagen/clion-cppcheck/issues/22
+https://github.com/johnthagen/clion-cppcheck/issues/52
+
+### Analyzing multiple configurations
+
+By default `cppcheck` tries to determine all the available configurations for a file (i.e. all combination of the used 
+preprocessor defines). As the plugin doesn't get the current list of defines this may lead to findings shown in code 
+which is shown as disabled in the editor. To check just a specific configuration you can either add defines using `-D`
+to the options. Or you can limit the configurations to a single one adding `--max-configs=1`.
+
+By default Limiting the configurations also decreases the time of the analysis.
+
+By default a maximum of 12 configurations is checked. This may lead to some code which might actually be active not to 
+show any findings. This can also be controlled by the `--max-configs=<n>` option.
+
+Related issues:<br/>
+https://github.com/johnthagen/clion-cppcheck/issues/34
+https://github.com/johnthagen/clion-cppcheck/issues/52
+
+### Multiple include paths
+
+No additional includes path are being passed to `cppcheck` for the analysis which might result in false positives or not
+all findings being shown.
+
+You can add additional include path using the `-I <path>` options.
+
+Related issues:<br/>
+https://github.com/johnthagen/clion-cppcheck/issues/52
+https://github.com/johnthagen/clion-cppcheck/issues/55
 
-`Show Cppcheck XML Output` only shows the XML result of the latest analysis. If you need to view the results for a 
+### Batch analysis
+
+The batch analysis passes the files individually to `cppcheck` just like the highlighting inspections. So if you pass a 
+folder to the batch analysis it might not show the same findings as when passing a folder to `cppcheck` itself.
+
+It will also pass all the contents of the folder to the analysis and not just project files. This might lead to
+unexpected findings.
+
+Also some findings in headers files triggered by the analysis of a source files are not being shown.
+
+Related issues:<br/>
+https://github.com/johnthagen/clion-cppcheck/issues/54
+
+### Showing raw output
+
+`Show Cppcheck XML Output` only shows the XML result of the latest analysis. If you need to view the results for a
 specific file make sure it was the last one analyzed.
 
+Related issues:<br/>
+https://github.com/johnthagen/clion-cppcheck/issues/53
+
+### External libraries / System includes
+
+`cppcheck` does not support analyzing of external library or system includes. It provides profiles for several external
+libraries which describe the contents and behavior of the includes which allows it to finding issues with usage of them
+in the code. To add such a profile to your analysis you need to specify it via the `--library=<name>` option. The
+available profile can be found in the `cfg` folder of your `cppcheck` installation. 
+
+### Global options
+
+Currently the configured options are global and not per project.
+
+Related issues:<br/>
+https://github.com/johnthagen/clion-cppcheck/issues/52
+
 ## Development
 
 To run the plugin from source, open this project in IntelliJ and create a new "Plugin" run configuration. Running or

resources/META-INF/plugin.xml

@@ -52,11 +52,7 @@
       <br/>
 
       <b>Known issues:</b><br/>
-        Cppcheck is not designed to be run on header files (.h) directly, as must be done for this
-        plugin, and as a result may have false positives.<br/>
-        When run on header files directly, Cppcheck defaults to C as the language, which will
-        generate false positives for C++ projects. C++ projects should leave --language=c++ appended to the
-        Cppcheck options.<br/>
+        Please refer to <a href="https://github.com/johnthagen/clion-cppcheck#known-issues">Known Issues</a>.<br/>
     ]]></description>
 
   <change-notes><![CDATA[