#!/bin/bash # SPDX-License-Identifier: LGPL-2.1 # Copyright (C) 2022, Google Inc, Steven Rostedt # # This checks if any function is listed in a man page that is not listed # in the main man page. if [ $# -lt 1 ]; then echo "usage: check-manpages man-page-path" exit 1 fi cd $1 MAIN=libtraceevent MAIN_FILE=${MAIN}.txt PROCESSED="" # Ignore man pages that do not contain functions IGNORE="" for man in ${MAIN}-*.txt; do for a in `sed -ne '/^NAME/,/^SYNOP/{/^[a-z]/{s/, *$//;s/,/\n/g;s/ //g;s/-.*$/-/;/-/{s/-//p;q};p}}' $man`; do if [ "${PROCESSED/:${a} /}" != "${PROCESSED}" ]; then P="${PROCESSED/:${a} */}" echo "Found ${a} in ${man} and in ${P/* /}" fi PROCESSED="${man}:${a} ${PROCESSED}" if [ "${IGNORE/$man/}" != "${IGNORE}" ]; then continue fi if ! grep -q '\*'${a}'\*' $MAIN_FILE; then if [ "$last" == "" ]; then echo fi if [ "$last" != "$man" ]; then echo "Missing functions from $MAIN_FILE that are in $man" last=$man fi echo " ${a}" fi done done DEPRECATED="*tep_print_field*" # Should not be used by applications, only internal use by trace-cmd IGNORE="*kbuffer_set_old_format* *kbuffer_raw_get* *kbuffer_ptr_delta* *kbuffer_translate_data*" HEADER=event-parse.h sed -ne 's/^[a-z].*[ \*]\([a-z_][a-z_]*\)(.*/\1/p' -e 's/^\([a-z_][a-z_]*\)(.*/\1/p' ../include/traceevent/{event-parse,trace-seq,kbuffer}.h | while read f; do if ! grep -q '\*'${f}'\*' $MAIN_FILE; then if [ "${DEPRECATED/\*$f\*/}" != "${DEPRECATED}" ]; then continue; fi if [ "${IGNORE/\*$f\*/}" != "${IGNORE}" ]; then continue; fi for head in event-parse.h trace-seq.h kbuffer.h; do if grep -q $f ../include/traceevent/$head; then if [ "$HEADER" != "$head" ]; then last="" HEADER=$head break fi fi done if [ "$last" == "" ]; then echo echo "Missing functions from $MAIN_FILE that are in $HEADER" last=$f fi echo " ${f}" fi done