Merge pull request #2076 from BytesGalore/add_conflict_warning
RIOT/Makefile.include: added indicating of possibe conflicting features on compiledev/timer
Peter Kietzmann
8 years ago
commit
60c9899550
@ -0,0 +1,12 @@
|
||||
APPLICATION = warn_conflict
|
||||
include ../Makefile.tests_common
|
||||
|
||||
# The stm32f4discovery is the only board that provides known conflicting features,
|
||||
# so using this compile test on other boards will not provide the expected warning.
|
||||
BOARD_WHITELIST := stm32f4discovery
|
||||
|
||||
# These features have a chance to use/access the shared `SPI_0` on stm32f4discovery,
|
||||
# which would probably produce an unexpected behaviour in the user application.
|
||||
FEATURES_REQUIRED = periph_dac periph_spi
|
||||
|
||||
include $(RIOTBASE)/Makefile.include
|
||||
@ -0,0 +1,41 @@
|
||||
Test warning on conflicting features
|
||||
==================================================
|
||||
Using conflicting features provided by boards was invisible for the user until the used features resulted in a traceable problem or the user was aware of the conflict in advance from documentation ect.
|
||||
Now, existing and known conflicts can be recorded into `FEATURES_CONFLICT` for each board to inform the user on a conflict situation during compile time.
|
||||
|
||||
This test requires conflicting features in its `Makefile`, i.e. `FEATURES_REQUIRED = periph_dac periph_spi`.
|
||||
It is expected to be presented with a warning on the conflicts with a short description message during compile time for the [stm32f4discovery](https://github.com/RIOT-OS/RIOT/wiki/Board%3A-STM32F4discovery) by now, i.e. :
|
||||
|
||||
```
|
||||
$ make BOARD=stm32f4discovery
|
||||
The following features may conflict: periph_dac periph_spi
|
||||
Rationale: On stm32f4discovery boards there are the same pins for the DAC and/or SPI_0.
|
||||
|
||||
EXPECT undesired behaviour!
|
||||
```
|
||||
The warning presents the conflicting features derived from `FEATURES_CONFLICT` and an optional message derived from `FEATURES_CONFLICT_MSG` provided int the `./RIOT/board/stm32f4discovery/Makefile.features`.
|
||||
|
||||
Whenever an application, such as this test, requires board features that match a _conflict group_, e.g. `FEATURES_REQUIRED = periph_dac periph_spi`, a similar warning to the above will be displayed during compile time.
|
||||
|
||||
|
||||
---------
|
||||
###Usage of _conflict groups_:
|
||||
|
||||
* Conflicting features are described in groups separated by a `:` (doublecolon) for each feature, e.g.:
|
||||
`FEATURES_CONFLICT = periph_spi:periph_dac`, which states that `periph_spi` conflicts with `periph_dac`.
|
||||
As seen above, this is the conflict of `SPI_0` pinout is shared with `DAC` on the [stm32f4discovery](https://github.com/RIOT-OS/RIOT/wiki/Board%3A-STM32F4discovery) board.
|
||||
|
||||
* Distinct groups of conflicts are whitespace separated, e.g.:
|
||||
`featureA:featureB featureC:featureD`, which states that `featureA` conflicts with `featureB`, and `featureC` conflicts with `featureD`.
|
||||
This also means, that e.g. `FEATURES_REQUIRED = featureA featureD` would **not** produce a warning.
|
||||
|
||||
* The groups can have an arbitrary number of conflicting features, e.g.:
|
||||
`featureA:featureB:featureC:featureX:featureY:featureZ`
|
||||
|
||||
* An optional information can be given using the `FEATURES_CONFLICT_MSG`, e.g.:
|
||||
`FEATURES_CONFLICT_MSG = "featureA uses the same pins as featureB"`
|
||||
|
||||
* If the required features match multiple conflict groups, **ALL** conflicting features are provided to the user, e.g.:
|
||||
`FEATURES_CONFLICT = featureA:featureB featureC:featureD` and
|
||||
`FEATURES_REQUIRED = featureA featureB featureC featureD`
|
||||
would result in: `The following features may conflict: featureA featureB featureC featureD`
|
||||
@ -0,0 +1,38 @@
|
||||
/*
|
||||
* Copyright (C) 2014 Martin Landsmann <Martin.Landsmann@HAW-Hamburg.de>
|
||||
*
|
||||
* This library is free software; you can redistribute it and/or
|
||||
* modify it under the terms of the GNU Lesser General Public
|
||||
* License as published by the Free Software Foundation; either
|
||||
* version 2.1 of the License, or (at your option) any later version.
|
||||
*
|
||||
* This library is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
* Lesser General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Lesser General Public
|
||||
* License along with this library; if not, write to the Free Software
|
||||
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup tests
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
* @brief Test whether EXPECT_CONFLICT works.
|
||||
*
|
||||
* @author Martin Landsmann <Martin.Landsmann@HAW-Hamburg.de>
|
||||
*
|
||||
* @}
|
||||
*/
|
||||
|
||||
#include <stdio.h>
|
||||
|
||||
int main(void)
|
||||
{
|
||||
puts("Hello, nothing to do here.\nbye.");
|
||||
|
||||
return 0;
|
||||
}
|
||||
@ -0,0 +1,22 @@
|
||||
#!/usr/bin/env python3
|
||||
import subprocess, os
|
||||
|
||||
cross_gcc = "arm-none-eabi-gcc"
|
||||
|
||||
try:
|
||||
devnull = open(os.devnull)
|
||||
subprocess.Popen([cross_gcc], stdout=devnull, stderr=devnull).communicate()
|
||||
output = subprocess.Popen(["make", "BOARD=stm32f4discovery"], stderr=subprocess.PIPE, stdout=subprocess.PIPE )
|
||||
out,err = output.communicate()
|
||||
|
||||
compare = b'\x1b[1;33mThe following features may conflict:\x1b[0m \x1b[1;32mperiph_dac periph_spi\x1b[0m\n\x1b[1;33mRationale: \x1b[0mOn stm32f4discovery boards there are the same pins for the DAC and/or SPI_0.\n\n\x1b[1;33mEXPECT undesired behaviour!\x1b[0m\n'
|
||||
if err == compare:
|
||||
print("Test SUCCEEDED! Compile time output is as expected!\n")
|
||||
else:
|
||||
print("Test FAILED! Compile time output is NOT as expected!\n")
|
||||
print("Expected:\n" + compare.decode("ascii") )
|
||||
print("Received:\n" + err.decode("ascii") )
|
||||
|
||||
except OSError as e:
|
||||
if e.errno == os.errno.ENOENT:
|
||||
print("ABORTING TEST:"+ cross_gcc +" seems to be missing.\n")
|
||||
Loading…
Reference in New Issue