File size: 971 Bytes
5cdf637 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 | #!/usr/bin/env bash
## SPDX-License-Identifier: BSD-3-Clause
## Copyright (c) 2024-2026, The OpenROAD Authors
# This code does the symlink for module-level READMEs to the working folder
# for manpage compilations.
SRC_BASE_PATH="../src"
DEST_BASE_PATH="./md/man2"
MAN3_DIR="./md/man3"
mkdir -p $DEST_BASE_PATH
mkdir -p $MAN3_DIR # needed for CI Tests.
# Loop through all folders inside "../src"
for MODULE_PATH in "$SRC_BASE_PATH"/*; do
if [ -d "$MODULE_PATH" ]; then
MODULE=$(basename "$MODULE_PATH")
SRC_PATH=$(realpath $SRC_BASE_PATH/$MODULE/README.md)
DEST_PATH="$(realpath $DEST_BASE_PATH/$MODULE).md"
# Not every directory under src/ is a documented module (src/cmake,
# modules whose docs live elsewhere), so a missing README is not an
# error here. md_roff_compat.py reports the ones it actually expects.
if [ -e "$SRC_PATH" ]; then
ln -s -f "$SRC_PATH" "$DEST_PATH"
fi
fi
done
|