doc/tools/conf2doc

   1 #!/bin/sh
   2 #
   3 # Generate asciidoc from the features.conf file in the top-level direftory.
   4 # Copyright (c) Jonas Fonseca <fonseca@diku.dk>, 2005
   5 #
   6
   7 CONFFILE="$1"
   8 TMPFILE=$(mktemp import-features.conf.XXXXXX) || exit 1
   9
  10 strip_comment()
  11 {
  12         echo "$1" | sed 's/^#\+\( \)*//'
  13 }
  14
  15 print_line()
  16 {
  17         line="$1"
  18
  19         echo "$(strip_comment "$line")"
  20 }
  21
  22 first_section=
  23 config_default=
  24 config_name="features.conf"
  25 section_title=
  26 section_mark="~"
  27 first_section=
  28
  29 print_section()
  30 {
  31         if [ -n "$section_title" ]; then
  32                 # "### Feature configuration file"
  33                 if [ "$section_title" != "Notes for developers" ]; then
  34                         label=
  35                         if [ -n "$config_name" ]; then
  36                                 section_title="$section_title (\`$config_name\`)"
  37                                 label="[[$(echo $config_name | sed 's/_/-/g')]]"
  38                         fi
  39                         cat << __END__
  40 $label
  41 $section_title
  42 $(echo "$section_title" | tr 'A-Za-z -_`' "$section_mark")
  43 $(cat $TMPFILE)
  44
  45 $config_default
  46
  47 __END__
  48                 fi
  49                 echo > $TMPFILE
  50                 section_mark="^"
  51                 section_title=
  52                 config_name=
  53                 config_default=
  54         fi
  55 }
  56
  57 cat "$CONFFILE" | while read line; do
  58         case "$line" in
  59         "### "*)
  60                 print_section
  61                 # Reset
  62                 section_title=$(strip_comment "$line")
  63                 ;;
  64         CONFIG*)
  65                 config_name=$(echo "$line" | cut -d '=' -f 1)
  66                 print_section
  67                 ;;
  68         "# Default:"*)
  69                 config_default=$(strip_comment "$line" | sed 's/Default://')
  70                 config_default="*Default:* $config_default"
  71                 ;;
  72         ""|"# vim:"*)
  73                 # Ignore
  74                 ;;
  75         "#"*)
  76                 line=$(strip_comment "$line")
  77                 echo "$line" >> $TMPFILE
  78                 ;;
  79         esac
  80 done
  81
  82 print_section
  83
  84 rm -f $TMPFILE
  85
  86 # vim: tabstop=4 shiftwidth=4 textwidth=76