From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp2.migadu.com ([2001:41d0:303:e224::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms5.migadu.com with LMTPS id Y6mcOZS7I2bCHAAAe85BDQ:P1 (envelope-from ) for ; Sat, 20 Apr 2024 14:56:53 +0200 Received: from aspmx1.migadu.com ([2001:41d0:303:e224::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp2.migadu.com with LMTPS id Y6mcOZS7I2bCHAAAe85BDQ (envelope-from ) for ; Sat, 20 Apr 2024 14:56:53 +0200 X-Envelope-To: patches@johnnyrichard.com Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=lists.sr.ht header.s=20240113 header.b=I9+pxCqp; dkim=pass header.d=johnnyrichard.com header.s=key1 header.b=xJqDzBxs; spf=pass (aspmx1.migadu.com: domain of lists@sr.ht designates 46.23.81.152 as permitted sender) smtp.mailfrom=lists@sr.ht; dmarc=pass (policy=quarantine) header.from=johnnyrichard.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=johnnyrichard.com; s=key1; t=1713617812; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding:list-id: list-unsubscribe:list-subscribe:list-post:dkim-signature; bh=AR7/FIWczq/HQqvpOZiw+Cs6Es8VE7cXKP4SeYhnaOc=; b=KSAiC368eOwZtVnuORbCoRIWjBMCUJHGCypEqnbtFLEYsOs+r6mBriAu3gPGWnSBwCuqGK V996OR5QnM8+6hLJ9XRN8VGUbnYuzIf0B0lO8ENzu+X31pKx6JW0NC1NWO7aaK+ERtTiD0 myMvtFpX+/qjzBMoSkhy2m2gyyIqJyJZke+5RHDZfJelUDc1EVfScuelDSmXrVi5AFxgAL yop36XRTXDUk5pRfaftOwSYicvqzvAJgzf1YpLVAFj19mYOHDraopVaVXQLGDdZjPsw9eN KNc+KO1kPNfvbr1q6znsPuS52NVasFZMX22IpuOOuYMJklzQiIhbn+4ntQJ6pQ== ARC-Seal: i=1; s=key1; d=johnnyrichard.com; t=1713617812; a=rsa-sha256; cv=none; b=gJN1b/i9UHzH2nRTCtqIyCjcSaXYa/EiV6yTE1oslOxJqhYnFdTAV7A8P9c281Dzoom297 iBU11X0+Stsd5v/bWBmG7XGvB6tUCbxTe25nywJpJmXGRzDGXz6tl/b0ljDrRp3EKoyF1y WpNc2exfqTcqU/O1r2DmpmbEYabi3JfWFtxwCXOJnltlVjzhJGnKM80kVMTARoGR7cHCwq 7MGjtnlimwveW7w966c3BNRe4a2v259qmqBYnmCeSwfQJM5laUmXzlCjFXrQlwlF5oF1uZ YSRTqyLdy8Gkj3sytVua3f/9kqDx8KhKI8QBWsnSFO9ci/R1izNCKEeK1c3S3g== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=lists.sr.ht header.s=20240113 header.b=I9+pxCqp; dkim=pass header.d=johnnyrichard.com header.s=key1 header.b=xJqDzBxs; spf=pass (aspmx1.migadu.com: domain of lists@sr.ht designates 46.23.81.152 as permitted sender) smtp.mailfrom=lists@sr.ht; dmarc=pass (policy=quarantine) header.from=johnnyrichard.com Received: from mail-a.sr.ht (mail-a.sr.ht [46.23.81.152]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id A8EE764784 for ; Sat, 20 Apr 2024 14:56:49 +0200 (CEST) DKIM-Signature: a=rsa-sha256; bh=eYe9IvK6dcvknY1AB1r2aXXKTasgNC30H7+L9AeKc3E=; c=simple/simple; d=lists.sr.ht; h=From:To:Cc:Subject:Date:List-Unsubscribe:List-Subscribe:List-Archive:List-Post:List-ID; q=dns/txt; s=20240113; t=1713617809; v=1; b=I9+pxCqp4QCeE+9Cd0Wp4wSN5RJT8XoE1ocmmM7sc4xJv5mhZ8sauDnQeS2kxHlYGGJybrKr V0gnw2eJ54MhlB5/rh8C1a52CB4N0E6fz2O97uiiVwDXSkbWdWF6OAoozRea68WHk/xLQK4MtmW JhNCCriQPq2QiDeQH9DbKYPjjQXtEVy9KsQRjIPuWtH1/ex7+8a/sSk5jl0qkzx4lHydVrC7BoG e/OmVxIHME5+/hd3NZMGHpRPhnJX9ORuitXZFFxa8rvMQr3ut9c31MfYu1gcogDMEtWI0HR7L9C mLGH+65HRUiD9LOL3PUj8Nd6S4O0MZb4C7ZJuLkQved7Q== Received: from lists.sr.ht (unknown [IPv6:2a03:6000:1813:1337::154]) by mail-a.sr.ht (Postfix) with ESMTPSA id 5B984203A6 for ; Sat, 20 Apr 2024 12:56:49 +0000 (UTC) Received: from out-174.mta0.migadu.com (out-174.mta0.migadu.com [91.218.175.174]) by mail-a.sr.ht (Postfix) with ESMTPS id 849E920392 for <~johnnyrichard/olang-devel@lists.sr.ht>; Sat, 20 Apr 2024 12:56:48 +0000 (UTC) X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=johnnyrichard.com; s=key1; t=1713617807; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding; bh=AR7/FIWczq/HQqvpOZiw+Cs6Es8VE7cXKP4SeYhnaOc=; b=xJqDzBxs7dvCyqZlIQXesF6CtdrSOmsA6v929+L9B/zZFe9evmmBm6Y9r2ASMrvrleiNtw q2nThmOT/PqWTRGWorQL/HXvXSE2xp0hT/jwcPsFKv9a9sZcPx9LCeAXAj8rlXbqc6j4tI k9EdsRyMHHd5j5F8+EQ28coGDd+X08emsney0ZhoOpWMRd0hy5V49nzWPN4rP92+R6gcdu yhCWsb0YaaCHjrG3wSEyqL7jkHpTs/kmRYrSUGMBScbx61OZ/ktl4wEmxBMLL3e576GS77 sJhB5UYnBMlLZ6Q4XEQcIfGvdR3Uo3yrxIW9A5PAe05PSfVEA29LqR50Ed+WJQ== From: Johnny Richard To: ~johnnyrichard/olang-devel@lists.sr.ht Cc: Johnny Richard Subject: [PATCH olang v1] build: rename linter to format to avoid confusion Date: Sat, 20 Apr 2024 15:54:28 +0200 Message-ID: <20240420135453.106559-1-johnny@johnnyrichard.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Sourcehut-Patchset-Status: PROPOSED List-Unsubscribe: List-Subscribe: List-Archive: Archived-At: List-Post: List-ID: ~johnnyrichard/olang-devel <~johnnyrichard/olang-devel.lists.sr.ht> Sender: ~johnnyrichard/olang-devel <~johnnyrichard/olang-devel@lists.sr.ht> X-Migadu-Flow: FLOW_IN X-Migadu-Country: NL X-Migadu-Spam-Score: -9.14 X-Spam-Score: -9.14 X-Migadu-Queue-Id: A8EE764784 X-Migadu-Scanner: mx12.migadu.com X-TUID: 1E1a6DjyJql4 We have been using linter as the target to check our code formatting. Today we are using `clang-format` to verify the formatting. This tool does only formatting, and miss other features that a linter have. Signed-off-by: Johnny Richard --- .build.yml | 4 ++-- Makefile | 16 ++++++++-------- docs/pages/contribute.md | 16 ++++++++-------- tests/integration/Makefile | 8 ++++---- tests/unit/Makefile | 8 ++++---- 5 files changed, 26 insertions(+), 26 deletions(-) diff --git a/.build.yml b/.build.yml index 72f0254..01f4aab 100644 --- a/.build.yml +++ b/.build.yml @@ -11,9 +11,9 @@ environment: sources: - https://git.sr.ht/~johnnyrichard/olang tasks: - - lint: | + - format: | cd olang - make linter + make format - build: | cd olang make diff --git a/Makefile b/Makefile index cdfc8e1..27337d4 100644 --- a/Makefile +++ b/Makefile @@ -16,17 +16,17 @@ $(TARGET): $(BUILD_DIR) $(OBJS) $(BUILD_DIR): @mkdir -p $@ -.PHONY: linter -linter: $(SRCS) $(HEADERS) +.PHONY: format +format: $(SRCS) $(HEADERS) clang-format --dry-run --Werror $? - $(MAKE) -C tests/integration/ linter - $(MAKE) -C tests/unit/ linter + $(MAKE) -C tests/integration/ format + $(MAKE) -C tests/unit/ format -.PHONY: linter-fix -linter-fix: $(SRCS) $(HEADERS) +.PHONY: format-fix +format-fix: $(SRCS) $(HEADERS) clang-format -i $? - $(MAKE) -C tests/integration/ linter-fix - $(MAKE) -C tests/unit/ linter-fix + $(MAKE) -C tests/integration/ format-fix + $(MAKE) -C tests/unit/ format-fix .PHONY: integration-test integration-test: diff --git a/docs/pages/contribute.md b/docs/pages/contribute.md index 884c4b4..a6dfd04 100644 --- a/docs/pages/contribute.md +++ b/docs/pages/contribute.md @@ -25,21 +25,21 @@ Code style Instead of delineating every element of our coding style, we have adopted the use of **clang-format** to enforce the olang code style. -Please refer to the linter section below for guidance on its +Please refer to the **Format** section below for guidance on its application. -### Linter +### Format -Checking for linter issues: +Checking for format issues: ``` {.sh} -make linter +make format ``` Most of the common code style mistakes are fixed by: ``` {.sh} -make linter-fix +make format-fix ``` ### .editorconfig @@ -92,9 +92,9 @@ the email-driven workflow here, but you can check it out at 1. Write single-purpose commits. 2. Write a meaningful commit message. 3. Every commit must be production ready. - - If the tests or the linter fail, you should not create a fix commit. - Instead, you should amend the commit that caused the issue and then - resend the patchset. + - If the tests or the format check fail, you should not create a fix + commit. Instead, you should amend the commit that caused the issue and + then resend the patchset. ### Step 2: Create your patch diff --git a/tests/integration/Makefile b/tests/integration/Makefile index db2b7d9..4625707 100644 --- a/tests/integration/Makefile +++ b/tests/integration/Makefile @@ -16,12 +16,12 @@ all: $(MUNIT) proc_exec.o cli_runner.o $(TESTS) clean: $(RM) *.o *_test -.PHONY: linter -linter: $(SRCS) +.PHONY: format +format: $(SRCS) clang-format --dry-run --Werror $? -.PHONY: linter-fix -linter-fix: $(SRCS) +.PHONY: format-fix +format-fix: $(SRCS) clang-format -i $? cli_test: $(MUNIT) proc_exec.o cli_runner.o cli_test.o diff --git a/tests/unit/Makefile b/tests/unit/Makefile index 498bf98..783225c 100644 --- a/tests/unit/Makefile +++ b/tests/unit/Makefile @@ -18,12 +18,12 @@ clean: $(RM) *.o *_test $(RM) -rfv lib -.PHONY: linter -linter: $(SRCS) +.PHONY: format +format: $(SRCS) clang-format --dry-run --Werror $? -.PHONY: linter-fix -linter-fix: $(SRCS) +.PHONY: format-fix +format-fix: $(SRCS) clang-format -i $? %_test: $(MUNIT) $(SUBJECT_OBJS) %_test.c base-commit: 36b028f712ff2402761ea307467860c346d3c0a0 -- 2.44.0