From bcfa2bc6b57449e87750ef180fcc5b1bc47765d5 Mon Sep 17 00:00:00 2001 From: Marc Schink Date: Mon, 1 Sep 2025 11:04:36 +0200 Subject: [PATCH] README: Use Markdown extension Ensures proper rendering on GitHub [1] / GitLab, clarifies that Markdown syntax is expected from contributors, and enables editor syntax highlighting. [1] https://github.com/openocd-org/openocd Change-Id: Icaff52ed2bf7d6f32b5812b5aff1c081e8b7507a Signed-off-by: Marc Schink Reviewed-on: https://review.openocd.org/c/openocd/+/9388 Tested-by: jenkins Reviewed-by: Antonio Borneo --- Makefile.am | 6 +++--- README.Windows => README.Windows.md | 2 +- README.macOS => README.macOS.md | 2 +- README => README.md | 0 configure.ac | 2 +- doc/openocd.texi | 2 +- tools/scripts/checkpatch.pl | 4 ++-- 7 files changed, 9 insertions(+), 9 deletions(-) rename README.Windows => README.Windows.md (97%) rename README.macOS => README.macOS.md (97%) rename README => README.md (100%) diff --git a/Makefile.am b/Makefile.am index 845543721..79bc599e6 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,6 +1,6 @@ # SPDX-License-Identifier: GPL-2.0-or-later -AUTOMAKE_OPTIONS = gnu 1.14 +AUTOMAKE_OPTIONS = foreign 1.14 .DELETE_ON_ERROR: @@ -63,8 +63,8 @@ EXTRA_DIST += \ BUGS \ HACKING \ NEWTAPS \ - README.Windows \ - README.macOS \ + README.Windows.md \ + README.macOS.md \ $(EXTRA_DIST_NEWS) \ Doxyfile.in \ LICENSES/license-rules.txt \ diff --git a/README.Windows b/README.Windows.md similarity index 97% rename from README.Windows rename to README.Windows.md index 293eed975..b0d4e085f 100644 --- a/README.Windows +++ b/README.Windows.md @@ -5,7 +5,7 @@ You can build OpenOCD for Windows natively with either MinGW-w64/MSYS or Cygwin (plain MinGW might work with --disable-werror but is not recommended as it doesn't provide enough C99 compatibility). Alternatively, one can cross-compile it using MinGW-w64 on a *nix -host. See README for the generic instructions. +host. See README.md for the generic instructions. Also, the MSYS2 project provides both ready-made binaries and an easy way to self-compile from their software repository out of the box. diff --git a/README.macOS b/README.macOS.md similarity index 97% rename from README.macOS rename to README.macOS.md index 91d5e9261..cc1e1c733 100644 --- a/README.macOS +++ b/README.macOS.md @@ -41,7 +41,7 @@ MacPorts' libraries, so run configure like this: LDFLAGS=-L/opt/local/lib CPPFLAGS=-I/opt/local/include ./configure [options] -See README for the generic building instructions. +See README.md for the generic building instructions. If you're using a USB adapter and have a driver kext matched to it, you will need to unload it prior to running OpenOCD. E.g. with Apple diff --git a/README b/README.md similarity index 100% rename from README rename to README.md diff --git a/configure.ac b/configure.ac index d0ab15b62..b77b516d9 100644 --- a/configure.ac +++ b/configure.ac @@ -16,7 +16,7 @@ AS_IF([test "x$MAKEINFO" = "x"], [ ]) AC_SUBST([MAKEINFO]) -AM_INIT_AUTOMAKE([-Wall -Wno-portability dist-bzip2 dist-zip subdir-objects]) +AM_INIT_AUTOMAKE([foreign -Wall -Wno-portability dist-bzip2 dist-zip subdir-objects]) AC_CONFIG_HEADERS([config.h]) diff --git a/doc/openocd.texi b/doc/openocd.texi index df0c87382..325235bb7 100644 --- a/doc/openocd.texi +++ b/doc/openocd.texi @@ -239,7 +239,7 @@ needing a Git client: @uref{http://repo.or.cz/w/openocd.git} -The @file{README} file contains the instructions for building the project +The @file{README.md} file contains the instructions for building the project from the repository or a snapshot. Developers that want to contribute patches to the OpenOCD system are diff --git a/tools/scripts/checkpatch.pl b/tools/scripts/checkpatch.pl index 89f0a2178..9232c83a3 100755 --- a/tools/scripts/checkpatch.pl +++ b/tools/scripts/checkpatch.pl @@ -1417,14 +1417,14 @@ sub top_of_kernel_tree { if (!$OpenOCD) { my @tree_check = ( "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", - "README", "Documentation", "arch", "include", "drivers", + "README.md", "Documentation", "arch", "include", "drivers", "fs", "init", "ipc", "kernel", "lib", "scripts", ); } # !$OpenOCD # OpenOCD specific: Begin my @tree_check = ( "AUTHORS", "BUGS", "COPYING", "HACKING", "Makefile.am", - "README", "contrib", "doc", "src", "tcl", "testing", "tools", + "README.md", "contrib", "doc", "src", "tcl", "testing", "tools", ); # OpenOCD specific: End