[[title
                     Instructions for Filing Bugs
]]


  This file assumes that you have chosen a "short name" for the bug
  and copied the template file to a file with that name (plus the
  suffix `.bug') stored in the `all-bugs' subdirectory.

  Read the file <INSTRUCTIONS.html> (or .txt) if you haven't done
  that yet and aren't sure what it means.


* The Meaning of `<<<...>>>'

  The template contains many small fragments surrounded by `<<<' and
  '>>>'.

  In general, your job in filling out the template is to delete those,
  replacing them with values that describe the bug you are entering.



* Title

  The template says:

  [[tty
    [[title
                 <<<a plain english title for the bug>>>
                                 ---
                          (<<<the-short-name>>>)
    ]]
  ]]

  The plain english title serves as the title for the document you 
  are creating.  The parentheses and short-name are a subtitle.

  A completed example might read:

  [[tty
    [[title
          The `munge' Command Crashes with Option `--tweak'
                                 ---
                         (munge-tweak-crash)
    ]]
  ]]


* The `bug-status' Section

  The section surrounded by a `bug-status' display:

  [[tty
        [[bug-status
          ...
        ]]
  ]]

  contains a set of standard "keyword/value" pairs.   You need to 
  fill these out.   It should not take more than a minute or so.

  The standard fields are described below:

** `received: <<<YYYY-MM-DD>>>'

  Enter the date on which you are creating the new bug database entry
  in the format shown:

  [[tty
	received: 2005-02-06
  ]]


** `received-by:' and `received-from:'

  Enter your email address and that of the bug submitter(s):

  [[tty
        received-by: lord@seyza.com
        received-from: rms@gnu.org, miles@gnu.org
  ]]

** `status' and `comment'

  Leave the status field as it is (with the value `open').
  Programmers may later change it to `closed'.

  The `comment' section is where you can leave the equivalent
  of a "post it" for the developers:

  [[tty
    	status: open
        comment: This might be a duplicate of munge-crash, 
                 I'm not sure.
  ]]


  Programmers and bug czar's may later change that:


  [[tty
    	status: closed
        comment: This was a duplicate of munge-crash.
  ]]



* Fix the Inventory Tag

  Before going further, observe that there is an "inventory tag" at
  the bottom of your new bug file.   Initially, that tag is copied
  from the template (making it a duplicate tag -- an error).

  Change the inventory tag to a new, unique string.

  [[tty
     [[null
       ; arch-tag: Talli Sun Feb  6 15:25 2005
     ]]
  ]]


** The Bug Body

  Above tag and below the `bug-status' section is where the "body" of
  the bug goes.

  If you are comfortable with Awiki, or wish to become so, you can
  enter the bug body there and format it for Awiki.

  If you don't want to do that for some reason, it is quite sufficient
  to write in unformatted plain text (text that Awiki will render 
  without any special effects).   

  For example, if you got the bug report in email, you could trim out
  some of the extraneous headers, indent the rest by a couple of
  spaces, and enclose the whole thing in a `tty' display:


  [[tty

    [[tty
      From: rms@gnu.org
      Subject: munge keeps crashing

      Half the time I use the munge command it crashes.  I'm not sure
      why and haven't had a chance to come up with a reproducible case
      yet.   Do you have any clue about what might be going on?




      From: miles@gnu.org
      Subject: munge --tweak bug

      The munge command crashes whenever the --tweak option is given
      and the XYZZY environment variable is set.   If you look in
      "foo.c" it's pretty easy to see why.
    ]]

  ]]


[[null
  ; arch-tag: Tom Lord Sun Feb  6 15:34:45 2005 (bugs/Template-instructions.txt)
]]

