lkml.org 
[lkml]   [2011]   [Apr]   [23]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH 3/4] Documentation/00-INDEX.sh: add script to help keeping the index up-to-date
On Sat, 23 Apr 2011 18:15:43 +0200 Cyril Brulebois wrote:

> Signed-off-by: Cyril Brulebois <kibi@debian.org>
> ---
> Documentation/00-INDEX.sh | 24 ++++++++++++++++++++++++
> 1 files changed, 24 insertions(+), 0 deletions(-)
> create mode 100755 Documentation/00-INDEX.sh
>
> diff --git a/Documentation/00-INDEX.sh b/Documentation/00-INDEX.sh
> new file mode 100755
> index 0000000..31d92d2
> --- /dev/null
> +++ b/Documentation/00-INDEX.sh
> @@ -0,0 +1,24 @@
> +#!/bin/sh
> +# Copyright 2011 Cyril Brulebois <kibi@debian.org>
> +#
> +# Try and keep the 00-INDEX file up-to-date.
> +
> +# List all entries below the 00-INDEX entry:
> +documented=$(sed '1,/^00-INDEX$/d' 00-INDEX|grep -v '^\s'|sed 's,/$,,')
> +
> +# List all files/directories except 00-INDEX* and Makefile:
> +present=$(ls -1|grep -v '^00-INDEX'|grep -v '^Makefile$')
> +
> +echo "Undocumented:"
> +for i in $present; do
> + if ! echo "$documented"|grep -qs "\<$i\>"; then
> + echo " $i"
> + fi
> +done
> +
> +echo "Documented but missing:"
> +for i in $documented; do
> + if [ ! -e $i ]; then
> + echo " $i"
> + fi
> +done
> --

Good idea, thanks.

but what am I doing wrong?

cd Documentation
sh ./00-INDEX.sh

The "undocumented" list looks correct (well, it could omit .orig files),
but the "Documented but missing" list contains words, e.g.:

-
this
file.
-
info
on
kernel
<->
userspace
and
relative
interface
stability.
-
brute
force
method
of
doing
binary
search
of
patches

on and on and on ...

---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***

\
 
 \ /
  Last update: 2011-04-23 18:35    [from the cache]
©2003-2014 Jasper Spaans. Advertise on this site