From 3b74f8c358d64e4b3ebbf9c010efb9e6187caa46 Mon Sep 17 00:00:00 2001 From: mhagger Date: Thu, 24 Feb 2011 06:35:08 +0000 Subject: [PATCH] Emphasize the list of info that should be included in requests for help. git-svn-id: http://cvs2svn.tigris.org/svn/cvs2svn/trunk@5327 be7e6eca-30d4-0310-a8e5-ac0d63af7087 --- www/faq.html | 105 +++++++++++++++++++++++++++++++++++------------------------ 1 file changed, 62 insertions(+), 43 deletions(-) diff --git a/www/faq.html b/www/faq.html index 1f763222..aefecd3e 100644 --- a/www/faq.html +++ b/www/faq.html @@ -108,6 +108,9 @@
  • How do I get help?
    • +
  • What information should I + include when requesting help?
    • +
  • How do I subscribe to a mailing list?
  • How do I report a bug?
    • @@ -1058,27 +1061,70 @@ help?
  • The mailing - list archives. Maybe your question has + list archives. Maybe your question has already been discussed on either the user@cvs2svn.tigris.org or dev@cvs2svn.tigris.org mailing list.
    • -
  • If you need help with running cvs2svn or problems converting - your repository, the users@cvs2svn.tigris.org - mailing list is the first place to send inquiries. Please subscribe - to the list so that you can follow ensuing discussions.
    • +
  • The users@cvs2svn.tigris.org + mailing list can often help with questions about how to configure + and run cvs2svn, conversion strategies, or problems converting your + repository. + Please subscribe + to the list so that you can follow ensuing discussions. Be sure to + include the information listed in "What + information should I include when requesting help?"
    • -
  • You can also ask questions on IRC at irc.freenode.net, - channel #cvs2svn.
    • +
  • You can also ask questions + on the #cvs2svn + channel on irc.freenode.net.
  • If you think you have found a bug, please refer to "How do I report a bug?"
    • +
  • For individual help with your conversion (especially for + non-open-source projects), commercial + support is available.
    • + +

    What information should I +include when requesting help?

    + +

    If you ask for help and/or report a bug on a mailing list, it is +important that you include the following information. Failure to +include important information is the best way to dissuade the +volunteers of the cvs2svn project from trying to help you.

    + +
      + +
    1. Exactly what version of cvs2svn are you using? If you + are not using an official release, please tell us what branch and + revision number from the svn archive you + are using. If you have modified cvs2svn, please tell us exactly + what you have changed.
      2. + +
    2. What platform are you using (Linux, BSD, Windows, etc.)? What + python version (e.g., type python --version)?
      3. + +
    3. What is the exact command line that you used to start + the conversion? If you used the --options option, please + attach a copy of the options file that you used.
      4. + +
    4. What happened when you ran the program? How did that differ + from what you wanted/expected? Include transcripts and/or error + output if available.
      5. + +
    5. If you think you have found a bug, try to submit a repository + that we can use to reproduce the problem. + See "How can I produce a useful test case?" + for more information. In most cases, if we cannot reproduce the + problem, there is nothing we can do to help you.
      6. + +
    + +

    How do I subscribe to a mailing list?

    @@ -1097,7 +1143,7 @@ lists. There are two ways:

  • If you do not have a tigris account, then you can subscribe by sending an email to $LIST-subscribe@cvs2svn.tigris.org, where $LIST - is one of "announce", "users", "dev", issues", or "commits". Please + is one of "announce", "users", "dev", "issues", or "commits". Please be sure to send the email to $LIST-subscribe and not to the list itself! (To unsubscribe, send and email to $LIST-unsubscribe@cvs2svn.tigris.org.) More details can be found useful test case or a workaround).

    If your bug seems new, then the best thing to do is report it via -email to the dev@cvs2svn.tigris.org -mailing list. Be sure to include the following information in your -message:

    - -
      - -
    1. Exactly what version of cvs2svn are you using? If you - are not using an official release, please tell us what branch and - revision number from the svn archive you - are using. If you have modified cvs2svn, please tell us exactly - what you have changed.
      2. - -
    2. What platform are you using (Linux, BSD, Windows, etc.)? What - python version (e.g., type python --version)?
      3. - -
    3. What is the exact command line that you used to start - the conversion? If you used the --options option, please - attach a copy of the options file that you used.
      4. - -
    4. What happened when you ran the program? Why do you think the - behavior was wrong? Include transcripts and/or error output if - available.
      5. - -
    5. If at all possible, include a test case repository that we can - use to reproduce the problem. See "How can I - produce a useful test case?" for more information. In most - cases, if we cannot reproduce the problem, there is nothing we can - do to help you.
      6. - -
    +email to +the dev@cvs2svn.tigris.org +mailing list. Be sure to include the information listed +in "What information should I include when +requesting help?"

    How can I produce a useful -- 2.11.4.GIT