dosbox-staging/scripts/verify-markdown.sh
kcgen 0492b041c6 Organize ReelMagic as a sub-module under hardware
src/hardware/reelmagic/driver.cpp
src/hardware/reelmagic/mpeg_decoder.h
src/hardware/reelmagic/player.cpp
src/hardware/reelmagic/vga_passthrough.h
src/hardware/reelmagic/video_mixer.cpp

src/hardware/reelmagic/docs/...
src/hardware/reelmagic/tools/...

This matches the other multi-component modules that have
their own subdirectory like: mame, mouse, and serialport.

This allows for dropping the redundant filename prefixes, and
simply call the component-code was they represent within the
Reel Magic design.

It also co-locates the tools and documentation, and makes
small modifications to reflect the new paths and names.
2022-11-15 11:48:17 -08:00

33 lines
807 B
Bash
Executable file

#!/bin/bash
# SPDX-License-Identifier: GPL-2.0-or-later
#
# Copyright (C) 2020-2021 kcgen <kcgen@users.noreply.github.com>
#
# This is a convenient helper to run mdl (markdownlint) on the
# *.md files in the repo, except for those inside directories
# that are likely to hold 3rd party documentation.
#
# You can pass additional mdl arguments to this script itself, e.g.:
#
# ./verify-markdown.sh --verbose --json
set -euo pipefail
list_markdown_files () {
git ls-files -- \
'*.md' \
':!:src/libs/*.md' \
':!:src/hardware/reelmagic/docs/*.md' \
':!:contrib/resources/*.md'
}
main () {
repo_root="$(git rev-parse --show-toplevel)"
mdl --version
echo "Checking files:"
list_markdown_files
list_markdown_files | xargs -L 1000 mdl --style "$repo_root/.mdl-styles" "$@"
}
>&2 main "$@"