arduino/esp8266
1
0
Fork 0
mirror of https://github.com/esp8266/Arduino.git synced 2025-04-19 23:22:16 +03:00
Code

CI - clang-format-15 (#9085)

Browse Source 
Stop CI from pulling LLVM repos and using GNUPG keyservers,
ubuntu-latest already has clang-format-{13,14,15}

Fixes long-standing issue with -style=file:...
This commit is contained in:
Max Prokhorov 2024-02-09 17:39:38 +03:00 committed by GitHub
parent 16e19181b9
commit e6df345584
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
13 changed files with 29 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
.github/workflows/style-check.yml vendored
View File

@ -24,20 +24,8 @@ jobs:
with: with:
python-version: '3.x' python-version: '3.x'
- name: Style check - name: Style check
env:
LLVM_SNAPSHOT_KEY: "6084F3CF814B57C1CF12EFD515CF4D18AF4F7421"
run: | run: |
export GNUPGHOME=$(mktemp -d)
gpg --batch --keyserver keyserver.ubuntu.com --recv-keys "$LLVM_SNAPSHOT_KEY"
gpg --batch --armor --export "$LLVM_SNAPSHOT_KEY" | \
sudo tee /etc/apt/trusted.gpg.d/llvm-snapshot.gpg.asc
gpgconf --kill all
rm -r $GNUPGHOME
echo "deb http://apt.llvm.org/focal/ llvm-toolchain-focal-13 main" | \
sudo tee /etc/apt/sources.list.d/llvm.list
sudo apt update sudo apt update
sudo apt install clang-format-13
pip3 install pyyaml
bash ./tests/ci/style_check.sh bash ./tests/ci/style_check.sh
# Validate orthography # Validate orthography

2
libraries/ESP8266HTTPClient/examples/PostHttpClient/PostHttpClient.ino
View File

@ -15,7 +15,7 @@
bin/PostServer/PostServer bin/PostServer/PostServer
then put your PC's IP address in SERVER_IP below, port 9080 (instead of default 80): then put your PC's IP address in SERVER_IP below, port 9080 (instead of default 80):
*/ */
//#define SERVER_IP "10.0.1.7:9080" // PC address with emulation on host // #define SERVER_IP "10.0.1.7:9080" // PC address with emulation on host
#define SERVER_IP "192.168.1.42" #define SERVER_IP "192.168.1.42"
#ifndef STASSID #ifndef STASSID

6
libraries/ESP8266WebServer/examples/FSBrowser/FSBrowser.ino
View File

@ -25,15 +25,15 @@
// Select the FileSystem by uncommenting one of the lines below // Select the FileSystem by uncommenting one of the lines below
//#define USE_SPIFFS // #define USE_SPIFFS
#define USE_LITTLEFS #define USE_LITTLEFS
//#define USE_SDFS // #define USE_SDFS
// Uncomment the following line to embed a version of the web page in the code // Uncomment the following line to embed a version of the web page in the code
// (program code will be larger, but no file will have to be written to the filesystem). // (program code will be larger, but no file will have to be written to the filesystem).
// Note: the source file "extras/index_htm.h" must have been generated by "extras/reduce_index.sh" // Note: the source file "extras/index_htm.h" must have been generated by "extras/reduce_index.sh"
//#define INCLUDE_FALLBACK_INDEX_HTM // #define INCLUDE_FALLBACK_INDEX_HTM
//////////////////////////////// ////////////////////////////////

4
libraries/ESP8266WebServer/examples/Graph/Graph.ino
View File

@ -24,9 +24,9 @@
// Select the FileSystem by uncommenting one of the lines below // Select the FileSystem by uncommenting one of the lines below
//#define USE_SPIFFS // #define USE_SPIFFS
#define USE_LITTLEFS #define USE_LITTLEFS
//#define USE_SDFS // #define USE_SDFS
//////////////////////////////// ////////////////////////////////

4
libraries/ESP8266WiFi/examples/BearSSL_Server/BearSSL_Server.ino
View File

@ -48,7 +48,7 @@ const char *pass = STAPSK;
// The HTTPS server // The HTTPS server
BearSSL::WiFiServerSecure server(443); BearSSL::WiFiServerSecure server(443);
//#define USE_EC // Enable Elliptic Curve signed cert // #define USE_EC // Enable Elliptic Curve signed cert
#define USING_INSECURE_CERTS_AND_KEYS_AND_CAS 1 #define USING_INSECURE_CERTS_AND_KEYS_AND_CAS 1
#include <ssl-tls-ca-key-cert-example.h> #include <ssl-tls-ca-key-cert-example.h>
@ -58,7 +58,7 @@ BearSSL::WiFiServerSecure server(443);
// Caching SSL sessions shortens the length of the SSL handshake. // Caching SSL sessions shortens the length of the SSL handshake.
// You can see the performance improvement by looking at the // You can see the performance improvement by looking at the
// Network tab of the developer tools of your browser. // Network tab of the developer tools of your browser.
//#define DYNAMIC_CACHE // Whether to dynamically allocate the cache. // #define DYNAMIC_CACHE // Whether to dynamically allocate the cache.
#if defined(USE_CACHE) && defined(DYNAMIC_CACHE) #if defined(USE_CACHE) && defined(DYNAMIC_CACHE)
// Dynamically allocated cache. // Dynamically allocated cache.

2
libraries/ESP8266mDNS/examples/OTA-mDNS-LittleFS/OTA-mDNS-LittleFS.ino
View File

@ -47,7 +47,7 @@ const char *ap_default_psk = APPSK; ///< Default PSK.
/// @} /// @}
/// Uncomment the next line for verbose output over UART. /// Uncomment the next line for verbose output over UART.
//#define SERIAL_VERBOSE // #define SERIAL_VERBOSE
/** /**
@brief Read WiFi connection information from file system. @brief Read WiFi connection information from file system.

4
libraries/LittleFS/examples/SpeedTest/SpeedTest.ino
View File

@ -8,8 +8,8 @@
// WARNING: The filesystem will be formatted at the start of the test! // WARNING: The filesystem will be formatted at the start of the test!
#define TESTFS LittleFS #define TESTFS LittleFS
//#define TESTFS SPIFFS // #define TESTFS SPIFFS
//#define TESTFS SDFS // #define TESTFS SDFS
// How large of a file to test // How large of a file to test
#define TESTSIZEKB 512 #define TESTSIZEKB 512

2
libraries/Netdump/examples/Netdump/Netdump.ino
View File

@ -4,7 +4,7 @@
#include <ESP8266WiFi.h> #include <ESP8266WiFi.h>
#include <ESP8266WebServer.h> #include <ESP8266WebServer.h>
#include <ESP8266mDNS.h> #include <ESP8266mDNS.h>
//#include <FS.h> // #include <FS.h>
#include <LittleFS.h> #include <LittleFS.h>
#include <map> #include <map>

8
libraries/esp8266/examples/LowPowerDemo/LowPowerDemo.ino
View File

@ -42,7 +42,7 @@
#include <PolledTimeout.h> #include <PolledTimeout.h>
#include <include/WiFiState.h> // WiFiState structure details #include <include/WiFiState.h> // WiFiState structure details
//#define DEBUG // prints WiFi connection info to serial, uncomment if you want WiFi messages // #define DEBUG // prints WiFi connection info to serial, uncomment if you want WiFi messages
#ifdef DEBUG #ifdef DEBUG
#define DEBUG_PRINTLN(x) Serial.println(x) #define DEBUG_PRINTLN(x) Serial.println(x)
#define DEBUG_PRINT(x) Serial.print(x) #define DEBUG_PRINT(x) Serial.print(x)
@ -56,8 +56,8 @@
// uncomment one of the two lines below for your LED connection (optional) // uncomment one of the two lines below for your LED connection (optional)
#define LED 5 // D1/GPIO5 external LED for modules with built-in LEDs so it doesn't add amperage #define LED 5 // D1/GPIO5 external LED for modules with built-in LEDs so it doesn't add amperage
//#define LED 2 // D4/GPIO2 LED for ESP-01,07 modules; D4 is LED_BUILTIN on most other modules // #define LED 2 // D4/GPIO2 LED for ESP-01,07 modules; D4 is LED_BUILTIN on most other modules
// you can use LED_BUILTIN, but it adds to the measured amperage by 0.3mA to 6mA. // you can use LED_BUILTIN, but it adds to the measured amperage by 0.3mA to 6mA.
ADC_MODE(ADC_VCC); // allows you to monitor the internal VCC level; it varies with WiFi load ADC_MODE(ADC_VCC); // allows you to monitor the internal VCC level; it varies with WiFi load
// don't connect anything to the analog input pin(s)! // don't connect anything to the analog input pin(s)!
@ -72,7 +72,7 @@ IPAddress dns1(0, 0, 0, 0);
IPAddress dns2(0, 0, 0, 0); IPAddress dns2(0, 0, 0, 0);
uint32_t timeout = 30E3; // 30 second timeout on the WiFi connection uint32_t timeout = 30E3; // 30 second timeout on the WiFi connection
//#define TESTPOINT // used to track the timing of several test cycles (optional) // #define TESTPOINT // used to track the timing of several test cycles (optional)
#ifdef TESTPOINT #ifdef TESTPOINT
#define testPointPin 4 // D2/GPIO4, you can use any pin that supports interrupts #define testPointPin 4 // D2/GPIO4, you can use any pin that supports interrupts
#define testPoint_HIGH digitalWrite(testPointPin, HIGH) #define testPoint_HIGH digitalWrite(testPointPin, HIGH)

4
libraries/esp8266/examples/NTP-TZ-DST/NTP-TZ-DST.ino
View File

@ -31,11 +31,11 @@
// check for your nearest city in TZ.h // check for your nearest city in TZ.h
// espressif headquarter TZ // espressif headquarter TZ
//#define MYTZ TZ_Asia_Shanghai // #define MYTZ TZ_Asia_Shanghai
// example for "Not Only Whole Hours" timezones: // example for "Not Only Whole Hours" timezones:
// Kolkata/Calcutta is shifted by 30mn // Kolkata/Calcutta is shifted by 30mn
//#define MYTZ TZ_Asia_Kolkata // #define MYTZ TZ_Asia_Kolkata
// example of a timezone with a variable Daylight-Saving-Time: // example of a timezone with a variable Daylight-Saving-Time:
// demo: watch automatic time adjustment on Summer/Winter change (DST) // demo: watch automatic time adjustment on Summer/Winter change (DST)

4
libraries/lwIP_enc28j60/src/utility/enc28j60.cpp
View File

@ -398,7 +398,9 @@ bool ENC28J60::reset(void)
/* Wait for OST */ /* Wait for OST */
PRINTF("waiting for ESTAT_CLKRDY\n"); PRINTF("waiting for ESTAT_CLKRDY\n");
while ((readreg(ESTAT) & ESTAT_CLKRDY) == 0) { }; while ((readreg(ESTAT) & ESTAT_CLKRDY) == 0)
{
};
PRINTF("ESTAT_CLKRDY\n"); PRINTF("ESTAT_CLKRDY\n");
setregbank(ERXTX_BANK); setregbank(ERXTX_BANK);

1
tests/clang-format-core.yaml
View File

@ -6,7 +6,6 @@ KeepEmptyLinesAtTheStartOfBlocks: false
SpaceAfterTemplateKeyword: false SpaceAfterTemplateKeyword: false
SpaceBeforeInheritanceColon: false SpaceBeforeInheritanceColon: false
SpacesBeforeTrailingComments: 2 SpacesBeforeTrailingComments: 2
AlignTrailingComments: true
AllowShortBlocksOnASingleLine: Empty AllowShortBlocksOnASingleLine: Empty
AllowShortFunctionsOnASingleLine: Empty AllowShortFunctionsOnASingleLine: Empty
AllowShortIfStatementsOnASingleLine: false AllowShortIfStatementsOnASingleLine: false

21
tests/restyle.sh
View File

@ -7,14 +7,9 @@ root=$(git rev-parse --show-toplevel)
test -d ${root}/cores/esp8266 test -d ${root}/cores/esp8266
test -d ${root}/libraries test -d ${root}/libraries
# allow `env CLANG_FORMAT=clang-format-13`, or some other version # allow `env CLANG_FORMAT=clang-format-N`, or some other version
# default to v13, latest stable version from https://apt.llvm.org # default to v15, latest stable version from ubuntu-latest Github Actions image
CLANG_FORMAT=${CLANG_FORMAT:-clang-format-13} CLANG_FORMAT=${CLANG_FORMAT:-clang-format-15}
# TODO: waiting for llvm-14 to allow --style=file:<path-to-file>
makeClangFormatStyle() {
python3 -c 'import sys,yaml; sys.stdout.write(yaml.dump(yaml.safe_load(open(sys.argv[1], "r")), default_flow_style=True)); sys.stdout.flush();' $1
}
######################################### #########################################
# 'all' variable should be "cores/esp8266 libraries" # 'all' variable should be "cores/esp8266 libraries"
@ -37,14 +32,14 @@ tests
cd $root cd $root
style=$(makeClangFormatStyle ${root}/tests/clang-format-core.yaml) style=${root}/tests/clang-format-core.yaml
for target in $all; do for target in $all; do
if [ -d "$target" ]; then if [ -d "$target" ]; then
find $target \ find $target \
'(' -name "*.cpp" -o -name "*.c" -o -name "*.h" ')' \ '(' -name "*.cpp" -o -name "*.c" -o -name "*.h" ')' \
-exec $CLANG_FORMAT --verbose --style="$style" -i {} \; -exec $CLANG_FORMAT --verbose --style="file:$style" -i {} \;
else else
$CLANG_FORMAT --verbose --style="$style" -i $target $CLANG_FORMAT --verbose --style="file:$style" -i $target
fi fi
done done
@ -55,12 +50,12 @@ done
# exclude=$(git submodule --quiet foreach git rev-parse --show-toplevel | grep libraries) # exclude=$(git submodule --quiet foreach git rev-parse --show-toplevel | grep libraries)
if [ -z $1 ] ; then if [ -z $1 ] ; then
style=$(makeClangFormatStyle ${root}/tests/clang-format-arduino.yaml) style=${root}/tests/clang-format-arduino.yaml
find libraries \ find libraries \
-path libraries/ESP8266SdFat -prune -o \ -path libraries/ESP8266SdFat -prune -o \
-path libraries/Ethernet -prune -o \ -path libraries/Ethernet -prune -o \
-path libraries/SoftwareSerial -prune -o \ -path libraries/SoftwareSerial -prune -o \
-name '*.ino' -exec $CLANG_FORMAT --verbose --style="$style" -i {} \; -name '*.ino' -exec $CLANG_FORMAT --verbose --style="file:$style" -i {} \;
fi fi
######################################### #########################################