Basic FAQ

From The Player Project

Jump to: navigation, search
m (What is the purpose of the key in a provides or requires field (e.g., the "odometry" in "odometry::position:0")?)
(What's the right way to report bugs and ask questions on the mailing lists?: move to Getting help)
Line 7: Line 7:
== What's the right way to report bugs and ask questions on the mailing lists? ==
== What's the right way to report bugs and ask questions on the mailing lists? ==
-
Nobody actually asks this question, but many should. Below are some tips for reporting bugs and asking questions. The idea is to use these resources as efficiently as possible (specifically, to save time for the good people who will look into your bug or answer your question). Please read this; if you don't, then in answer to your query you'll likely be directed back here.
 
-
Before posting anything:
 
-
*'''First, check the [http://sourceforge.net/tracker/?group_id=42445&atid=433164 bug list]'''.
+
Nobody actually asks this question, but many should.  
 +
The guidelines for messages on the mailing list can be found in [[Getting help#Guidelines_for_mailing_list_messages | the getting help page]].
-
Known bugs, often with patches or workarounds, are generally found there. If you have something to add to an existing bug, add it as a comment to the bug, rather than posting to the mailing lists. Be sure to check for bugs with Any status (i.e., not just Open); you're likely to find your fix in a Closed bug. 
+
'''It is very important that you read that page before posting to the mailing list'''. At least if you are meant to be helped efficiently.
-
 
+
-
*'''Next, [http://sourceforge.net/mail/?group_id=42445 check the mailing list archives]'''.
+
-
 
+
-
Yes, I know that the SF.net archive interface is atrocious, but that's all there is, and it is functional. Search the archives to see if someone else has asked your question or reported your bug. 
+
-
 
+
-
If you do post something:
+
-
 
+
-
*'''Don't contact the developers/maintainers directly'''.
+
-
 
+
-
Direct correspondence is not archived or otherwise publicly available, which means that the larger user/developer community can't benefit from your question or the ensuing answer(s). Also, by contacting a developer directly, you're asking one person, whereas if you post to a mailing list, you're asking hundreds of people. Open Source development works best when the entire community participates in discussions and helps to answer questions.
+
-
 
+
-
To be clear, send all questions to the appropriate [http://sourceforge.net/mail/?group_id=42445 mailing list], and report all bugs to the [http://sourceforge.net/tracker/?group_id=42445&atid=433164 bug tracker].
+
-
 
+
-
*'''Be as specific as possible'''.  
+
-
 
+
-
Describe exactly what you were doing or are trying to do, and exactly what, if anything, went wrong. If you say, "The camera in Gazebo is broken," we can't help you. 
+
-
 
+
-
*'''Always provide the following information''':
+
-
**'''Names and versions of our packages that you're using'''.
+
-
For example, "I'm using Gazebo 0.5 with Player 1.6, as well as pmap 0.0.0."
+
-
**'''Your platform (architecture, OS & version/distro)'''.
+
-
For example, "I'm running OS X 10.3 on an iBook," or "I'm running RedHat Fedora Core 3 on an x86, with kernel 2.6.12." For Linux, always provide the distro and kernel versions.
+
-
**'''Any warnings or errors'''. Cut and paste them directly from the terminal window to which they were printed. DO NOT re-type them yourself. If you don't run a web browser or mail client in the same windowing session as the program that generates the output, then save it to a file and copy the file somewhere from which you can include or attach it.
+
-
 
+
-
When discussing any compiling/linking/installation issues, also provide:
+
-
*'''gcc version'''
+
-
 
+
-
As appropriate, also include your:
+
-
*'''Player .cfg file
+
-
*Stage/Gazebo .world file'''
+
-
 
+
-
*'''Don't send your question more than once'''.
+
-
We all heard you the first time, and if you didn't get a response then likely nobody has had time to answer you. Alternatively, it could be that nobody knows the answer, or that nobody wants to help you. In any case, sending it again is poor form and will only aggravate everybody else. And don't tell us about your homework/project/paper deadlines; we don't care.
+
-
 
+
-
If your mail client is broken in such a way that it sends multiple copies when you hit "Send," then either fix your mail client or get a new one. The world if full of mail clients, many of which work great. Life is too short for broken mail software.  
+
==Which versions of Player, Stage and Gazebo are compatible?==
==Which versions of Player, Stage and Gazebo are compatible?==

Revision as of 12:53, 27 July 2006

Personal tools