zephyr/doc/development_process
Peter Bigot f45f72c9a4 doc: development_process: document that CI style checks can fail
The CI style checking solution can produce false positives when it's
given code that it mis-parses, or that follows conventions it doesn't
allow.  Document a couple examples, and explicitly note that
maintainers should override the -1 vote if they're encountered.

For those following along in the commit history:

   static uint8_t __aligned(PAGE_SIZE) page_pool[PAGE_SIZE * POOL_PAGES];

checkpatch sees "uint8_t __aligned(PAGE_SIZE)" and infers a prototype
for a function "__aligned" that takes an unnamed parameter of type
"PAGE_SIZE".  So it adds "PAGE_SIZE" as a known type name.

   IOPCTL_Type *base = config->base;

This is common in driver code where the vendor HAL allows typedefs for
structure types.  checkpatch was designed for an environment with
limited use of typedefs; "struct IPCTL_Type" would have been handled
properly.

Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no>
2020-07-23 14:04:44 +02:00
..
api_lifecycle.png doc: Rework Development Process section 2019-02-21 18:04:02 -05:00
api_lifecycle.rst doc: api_lifecycle: Use DEPRECATED instead of LEGACY in Kconfig 2020-06-09 18:56:00 +02:00
code_flow.rst doc: add missing doc top labels 2019-04-16 18:11:30 -04:00
communication.rst doc: add missing doc top labels 2019-04-16 18:11:30 -04:00
dev_env_and_tools.rst doc: development_process: document that CI style checks can fail 2020-07-23 14:04:44 +02:00
documentation.rst doc: document how we implement traceability 2020-04-13 14:11:01 +02:00
index.rst global: Remove leading/trailing blank lines in files 2019-12-11 19:17:27 +01:00
issues.rst global: Remove leading/trailing blank lines in files 2019-12-11 19:17:27 +01:00
lts.png doc: move development process from the wiki 2019-01-11 09:34:37 -05:00
milestones.jpg doc: fix files mis-named as PNG files 2019-09-02 13:02:08 +02:00
milestones2.jpg doc: fix files mis-named as PNG files 2019-09-02 13:02:08 +02:00
proposals.rst doc: feature tracking: Update with two new categories 2020-05-06 17:25:30 +02:00
pull_request_classes.png doc: Rework Development Process section 2019-02-21 18:04:02 -05:00
release_cycle.png doc: move development process from the wiki 2019-01-11 09:34:37 -05:00
release_flow.png doc: Rework Development Process section 2019-02-21 18:04:02 -05:00
release_process.rst doc: release: Document release quality metrics 2020-06-24 09:47:34 -04:00