From fcb0bca15faa276af27ecf81edbe0fbb0177bb17 Mon Sep 17 00:00:00 2001 From: Cosmin Truta Date: Wed, 22 Jan 2025 23:19:49 +0200 Subject: [PATCH] chore: Update the .editorconfig file; add/update README files Add various missing pieces to their right places: * Update .editorconfig in order to let editorconfig-checker know that aclocal.m4 (which is auto-generated) may contain trailing whitespace. * Add ci/README.md. * Update scripts/README.txt. TODO: Integrate editorconfig-checker into the linting workflow on GitHub. (See .github/workflows/lint.yml) --- .editorconfig | 2 +- ci/README.md | 25 +++++++++++++++++++++++++ scripts/README.txt | 1 + 3 files changed, 27 insertions(+), 1 deletion(-) create mode 100644 ci/README.md diff --git a/.editorconfig b/.editorconfig index 349794988..4181a3796 100644 --- a/.editorconfig +++ b/.editorconfig @@ -41,7 +41,7 @@ indent_style = space max_doc_length = 100 max_line_length = 100 -[{Makefile.in,ltmain.sh}] +[{Makefile.in,aclocal.m4,ltmain.sh}] indent_size = unset indent_style = unset insert_final_newline = unset diff --git a/ci/README.md b/ci/README.md new file mode 100644 index 000000000..f26229ce0 --- /dev/null +++ b/ci/README.md @@ -0,0 +1,25 @@ +Scripts for the Continuous Integration of the PNG Reference Library +=================================================================== + +Copyright Notice +---------------- + +Copyright (c) 2019-2024 Cosmin Truta. + +Use, modification and distribution are subject to the MIT License. +Please see the accompanying file `LICENSE_MIT.txt` or visit +https://opensource.org/license/mit + +File List +--------- + + LICENSE_MIT.txt ==> The License file + README.md ==> This file + ci_lint.sh ==> Lint the source code + ci_shellify.sh ==> Convert select definitions to shell syntax + ci_verify_cmake.sh ==> Verify the build driven by CMakeLists.txt + ci_verify_configure.sh ==> Verify the build driven by configure + ci_verify_makefiles.sh ==> Verify the build driven by scripts/makefile.* + ci_verify_version.sh ==> Verify the consistency of version definitions + lib/ci.lib.sh ==> Shell utilities for the main ci_*.sh scripts + targets/*/ci_env.*.sh ==> Shell environments for cross-platform testing diff --git a/scripts/README.txt b/scripts/README.txt index 3764e79a7..332a016cb 100644 --- a/scripts/README.txt +++ b/scripts/README.txt @@ -8,6 +8,7 @@ Scripts and makefiles for libpng makefile.atari => Atari makefile makefile.bc32 => Borland C makefile, for Win32 makefile.beos => BeOS makefile + makefile.c89 => Generic UNIX makefile for C89 (cc -std=c89) makefile.clang => Generic clang makefile makefile.darwin => Darwin makefile, for macOS (formerly Mac OS X) makefile.dec => DEC Alpha UNIX makefile