tools/meson-check-api-docs.sh

   1 #!/bin/sh
   2 set -eu
   3
   4 sd_good=0
   5 sd_total=0
   6 udev_good=0
   7 udev_total=0
   8
   9 deprecated="
  10     -e sd_bus_try_close
  11     -e sd_bus_process_priority
  12     -e sd_bus_message_get_priority
  13     -e sd_bus_message_set_priority
  14 "
  15
  16 for symbol in `nm -g --defined-only "$@" | grep " T " | cut -d" " -f3 | grep -wv $deprecated | sort -u` ; do
  17     if test -f ${MESON_BUILD_ROOT}/man/$symbol.3 ; then
  18         echo "✓ Symbol $symbol() is documented."
  19         good=1
  20     else
  21         printf "  \x1b[1;31mSymbol $symbol() lacks documentation.\x1b[0m\n"
  22         good=0
  23     fi
  24
  25     case $symbol in
  26         sd_*)
  27             ((sd_good+=good))
  28             ((sd_total+=1))
  29             ;;
  30         udev_*)
  31             ((udev_good+=good))
  32             ((udev_total+=1))
  33             ;;
  34         *)
  35             echo 'unknown symbol prefix'
  36             exit 1
  37     esac
  38 done
  39
  40 echo "libsystemd: $sd_good/$sd_total libudev: $udev_good/$udev_total"