TheRock/rocm-systems/projects/hip/docs/gen_clang_option_doc.sh

#!/bin/bash

# Copyright (c) Advanced Micro Devices, Inc., or its affiliates.
#
# SPDX-License-Identifier: MIT

## generates documentation about clang options.

clang=/opt/rocm*/llvm/bin/clang

exec > clang_options.md

echo "# Support of Clang options"
echo " Clang version: $($clang --version | head -1|sed 's:\(.*\) (.* \(.*\)).*:\1 \2:')"
echo
echo "|Option|Support|Description|"
echo "|-------|------|-------|"

declare -A db
while read a b; do
  if [[ "$a" != "" && "$b" != "" ]]; then
    db[$a]="$b"
    #echo "db[$a]=${db[$a]}"
  fi
done <clang_options.txt
#for K in "${!db[@]}"; do echo $K; done

tmpf=tmp_clang_option.txt

[[ -f $tmpf ]] && rm $tmpf

$clang --help | sed '1,5d'|  while read a b; do
  if [[ "$a" != "-"* ]]; then
    desc="$a $b"
  elif [[ "$b" = *'>'* ]]; then
    opt=$(echo $a $b| sed -e 's:\(^-[^ ]*[= ]*<[^<>]*>\) *\(.*\):\1:')
    desc=$(echo $a $b| sed -e 's:\(^-[^ ]*[= ]*<[^<>]*>\) *\(.*\):\2:')
    if [[ "$opt" == "$desc" ]]; then
      opt="$a"
      desc="$b"
    fi
  else
    opt="$a"
    desc="$b"
  fi
  supp=
  key=$(printf "%s" "$opt" |sed 's:\([^ =<]*\).*:\1:')
  if [[ "$key" != "" ]]; then
    supp="${db[$key]}"
    #echo "opt=$opt supp=${db[$opt]}"
  fi
  if [[ "$supp" == "" ]]; then
    if [[ "$desc" = *AArch* ||\
          "$desc" = *MIPS* || \
          "$desc" = *ARM* || \
          "$desc" = *Arm* || \
          "$desc" = *SYCL* || \
          "$desc" = *PPC* || \
          "$desc" = *RISC-V* || \
          "$desc" = *WebAssembly* || \
          "$desc" = *Objective-C* || \
          "$opt" = *xray* \
       ]]; then
      supp="n"
    elif [[ "$opt" = *sanity* ]]; then
      supp="h"
    else
      supp="s"
    fi
  fi
  s=$supp
  case $supp in
    s) supp="Supported";;
    n) supp="Unsupported";;
    h) supp="Supported on Host only";;
  esac

  desc=$(echo "$desc"| sed -e 's:^ *::' -e 's:|:\\|:g')
  #echo a=$a
  #echo b=$b
  #echo opt=$opt
  #echo desc=$desc
  if [[ "$desc" != "" ]]; then
    printf "%s %s\n" "$key" "$s" >>$tmpf
    echo '|`'$opt'`|'$supp'|`'$desc'`|'
  fi
done