Blame scripts/documented.sh

Packit Service 82fcde
#!/bin/sh
Packit Service 82fcde
bindir=$1
Packit Service 82fcde
Packit Service 82fcde
VERSION=1.0
Packit Service 82fcde
Packit Service 82fcde
egrep -h @deftypefu?nx? *.texi ../linuxthreads/*.texi |
Packit Service 82fcde
sed -e 's/@deftypefunx*[[:space:]]*\({[^{]*}\|[[:alnum:]_]*\)[[:space:]]*\([[:alnum:]_]*\).*/\2/' -e 's/@deftypefn {[^}]*function}*[[:space:]]*\({[^{]*}\|[[:alnum:]_]*\)[[:space:]]*\([[:alnum:]_]*\).*/\2/' -e '/^@/d' |
Packit Service 82fcde
sed -e '/^obstack_/d' -e '/^\([lf]\|\)stat\(\|64\)$/d' -e '/^mknod$/d' |
Packit Service 82fcde
sed -e '/^signbit$/d' -e '/^sigsetjmp$/d' |
Packit Service 82fcde
sed -e '/^pthread_cleanup/d' -e '/^IFTODT$/d' -e '/^DTTOIF$/d' |
Packit Service 82fcde
sed -e '/^__fwriting$/d' -e '/^__fwritable$/d' -e '/^__fsetlocking$/d' |
Packit Service 82fcde
sed -e '/^__freading$/d' -e '/^__freadable$/d' -e '/^__fpurge$/d' |
Packit Service 82fcde
sed -e '/^__fpending$/d' -e '/^__flbf$/d' -e '/^__fbufsize$/d' |
Packit Service 82fcde
sed -e '/^alloca$/d' |
Packit Service 82fcde
sort -u > DOCUMENTED
Packit Service 82fcde
Packit Service 82fcde
nm --extern --define $bindir/libc.so $bindir/math/libm.so $bindir/rt/librt.so $bindir/linuxthreads/libpthread.so $bindir/dlfcn/libdl.so $bindir/crypt/libcrypt.so $bindir/login/libutil.so |
Packit Service 82fcde
egrep " [TW] ([[:alpha:]]|_[[:alpha:]])" |
Packit Service 82fcde
sed 's/\(@.*\)//' |
Packit Service 82fcde
cut -b 12- |
Packit Service 82fcde
sed -e '/^_IO/d' -e '/^_dl/d' -e '/^_pthread/d' -e '/^_obstack/d' |
Packit Service 82fcde
sed -e '/^_argp/d' -e '/^_authenticate$/d' -e '/^_environ$/d' |
Packit Service 82fcde
sed -e '/^_errno$/d' -e '/^_h_errno$/d' -e '/^_longjmp$/d' |
Packit Service 82fcde
sed -e '/^_mcleanup$/d' -e '/^_rpc_dtablesize$/d' -e '/^_seterr_reply$/d' |
Packit Service 82fcde
sed -e '/^_nss/d' -e '/^_setjmp$/d' |
Packit Service 82fcde
sort -u > AVAILABLE
Packit Service 82fcde
Packit Service 82fcde
cat <
Packit Service 82fcde
Packit Service 82fcde
<html>
Packit Service 82fcde
  <head>
Packit Service 82fcde
    <title>Undocumented glibc functions</title>
Packit Service 82fcde
  </head>
Packit Service 82fcde
Packit Service 82fcde
  <body>
Packit Service 82fcde
    <center>

Undocumented <tt>glibc</tt> functions

</center>
Packit Service 82fcde
Packit Service 82fcde
    

The following table includes names of the function in glibc

Packit Service 82fcde
    which are not yet documented in the manual.  This list is
Packit Service 82fcde
    automatically created and therefore might contain errors.  Please
Packit Service 82fcde
    check the latest manual (available from the CVS archive) before
Packit Service 82fcde
    starting to work.  It might also be good to let me know in
Packit Service 82fcde
    advanace on which functions you intend to work to avoid
Packit Service 82fcde
    duplication.

Packit Service 82fcde
Packit Service 82fcde
    

A few comments:

Packit Service 82fcde
Packit Service 82fcde
    
    Packit Service 82fcde
          
  • Some functions in the list are much less important than
  • Packit Service 82fcde
          others.  Please prioritize.
    Packit Service 82fcde
    Packit Service 82fcde
          
  • Similarly for the LFS functions (those ending in 64).
  • Packit Service 82fcde
        
    Packit Service 82fcde
    Packit Service 82fcde
        

    The function sombody already volunteered to document are marked

    Packit Service 82fcde
        with a reference to the person.

    Packit Service 82fcde
    Packit Service 82fcde
        <center>
    Packit Service 82fcde
    EOF
    Packit Service 82fcde
    Packit Service 82fcde
    n=0
    Packit Service 82fcde
    diff -y --width=60 --suppress-common-lines DOCUMENTED AVAILABLE |
    Packit Service 82fcde
    expand | cut -b 33- | sed '/^[[:space:]]*$/d' |
    Packit Service 82fcde
    while read name; do
    Packit Service 82fcde
      line="$line
    Packit Service 82fcde
    <tt>$name</tt>"
    Packit Service 82fcde
      n=$(expr $n + 1)
    Packit Service 82fcde
      if [ $n -eq 4 ]; then
    Packit Service 82fcde
        echo "
    Packit Service 82fcde
    $line
    Packit Service 82fcde
    "
    Packit Service 82fcde
        line=""
    Packit Service 82fcde
        n=0
    Packit Service 82fcde
      fi
    Packit Service 82fcde
    done
    Packit Service 82fcde
    if [ $n -gt 0 ]; then
    Packit Service 82fcde
      if [ $n -eq 1 ]; then
    Packit Service 82fcde
        line="$line
    Packit Service 82fcde
    "
    Packit Service 82fcde
      fi
    Packit Service 82fcde
      if [ $n -eq 2 ]; then
    Packit Service 82fcde
        line="$line
    Packit Service 82fcde
    "
    Packit Service 82fcde
      fi
    Packit Service 82fcde
      if [ $n -eq 3 ]; then
    Packit Service 82fcde
        line="$line
    Packit Service 82fcde
    "
    Packit Service 82fcde
      fi
    Packit Service 82fcde
      echo "
    Packit Service 82fcde
    $line
    Packit Service 82fcde
    "
    Packit Service 82fcde
    fi
    Packit Service 82fcde
    Packit Service 82fcde
    cat <
    Packit Service 82fcde
        </center>
    Packit Service 82fcde
    Packit Service 82fcde
        
    Packit Service 82fcde
        <address>Ulrich Drepper</address>
    Packit Service 82fcde
    Generated on $(date) with documented.sh version $VERSION
    Packit Service 82fcde
      </body>
    Packit Service 82fcde
    </html>
    Packit Service 82fcde
    EOF