]> git.donarmstrong.com Git - neurodebian.git/commitdiff
Few fixes and bug report instructions
authorMichael Hanke <michael.hanke@gmail.com>
Sat, 20 Apr 2013 08:50:13 +0000 (10:50 +0200)
committerMichael Hanke <michael.hanke@gmail.com>
Sat, 20 Apr 2013 08:50:13 +0000 (10:50 +0200)
sphinx/about.rst
sphinx/install_pkg.rst
sphinx/popularity.rst
sphinx/reportbug.rst
sphinx/thanks.rst

index 656a86901b955b7e72971c99d4e514214a3adc26..9c4ebc8f88b74d45dae00b9b677f7379d25fb837 100644 (file)
@@ -51,3 +51,4 @@ maintainers_ that help to make Debian_ the ultimate software platform for
 neuroscience.
 
 .. _maintainers: pkgs.html#by-maintainer
+.. include:: link_names.txt
index 699b961760ff557eb0853ad8b17a7b613b118558..849352a68a2250f8f5ca6affdd2f553b35ea4204 100644 (file)
@@ -4,7 +4,8 @@ Install a package
 Step 1
 ------
 
-*[skip this steps if your machine is already configured to use this repository]*
+*[skip this steps if your are using the NeuroDebian virtual machine or if your
+machine is already configured to use this repository]*
 
 .. include:: reposetup.rst
 
index 19cff50e7eb183e364ff5c493e1490cbcef9d3bf..42350f3aefb9355485ab25a72b97e1e706b48475 100644 (file)
@@ -43,4 +43,4 @@ In addition to popcon pages for your "core" distribution (e.g. `Debian
 submissions to `NeuroDebian <http://neuro.debian.net/popcon/>`__ and
 know that you are already contributing back to the community.
 
-
+..include:: link_names.txt
index 2e59926b69ff965a1ddf365e2992c15ed3876781..e82566fe6950657ce53df32daeb362789ced58e2 100644 (file)
@@ -1,4 +1,62 @@
-Imagine very fine instructions for reporting a bug against ``###pkgname###``
+Report a bug
+============
+
+If you believe that there is a bug in ``###pkgname###``, we would be grateful if
+you take the time to report it. Only known problems can get fixed!
+
+Here are a few tips to help you report this bug in a way that facilitates its
+resolution.
+
+.. container:: foldup
+
+  .. container:: expandinstructions
+
+     Click on an item to expand it
+
+  Please double-check the name of the faulty package
+    If you have trouble with a command, you can identify the corresponding package
+    by running this command in a terminal::
+
+      $ dpkg -S `readlink -f $(which COMMAND)`
+
+    where ``COMMAND`` is the name of the command that fails.
+
+    If you believe there is a problem with a file installed on your system you
+    can find the responsible package by running::
+
+      $ dpkg -S FULLPATH
+
+    where ``FULLPATH`` is the complete absolute path of the file.
+
+  Try to reproduce the bug
+    If you cannot reproduce the bug it is likely that the package maintainer
+    also cannot do it. Please make an attempt to find out under which
+    circumstances the faulty behavior occurs. However, if you can't figure it
+    out, please report the bug nevertheless -- maybe someone else can provide
+    the missing information.
+
+  Describe the problem so that the developer can reproduce it
+    That means including every single detail -- not just the "important" ones.
+    What kind of system (hardware/software) are you using? What did you do
+    exactly when the bug hit you?
+
+    Remember: bug reports are not just input for developers, but also help other
+    users to identify whether they are affected by the same problem, and a
+    recommended solution applies to them as well.
+
+    A good bug report is an important service to the community!
+
+    More information on high quality bug reporting is available at:
+    http://raphaelhertzog.com/go/bugreporting/
+
+
+Please email bug reports to the neurodebian-users_ or neurodebian-devel_
+mailing list -- whichever is more appropriate. In rare cases where your
+bug report contains confidential information, please email it directly
+to `team@neuro.debian.net <mailto:team@neuro.debian.net?subject=BUG-###pkgname###:>`_.
+
+If you have evidence that the faulty behavior is not specific to NeuroDebian,
+your bug report is best directed to the developers of the respective software.
 
 .. raw:: html
 
@@ -8,3 +66,5 @@ Imagine very fine instructions for reporting a bug against ``###pkgname###``
       $(document.body).html($(document.body).html().replace('###pkgname###', split[1]));
     }
   </script>
+
+.. include:: link_names.txt
index 25552509b10c19baae2957a0bd4671212713e18f..11aea7e3e91c51d04cff2755b30617f20e435970 100644 (file)
@@ -41,3 +41,5 @@ If your are interested in mirroring the repository, please see the :ref:`faq`.
 .. _Paul Ivanov: http://www.pirsquared.org
 .. _Medical-image Analysis and Statistical Interpretation lab at Vanderbilt: https://masi.vuse.vanderbilt.edu
 .. _Nikolaus Valentin Haenel: http://haenel.co
+
+.. include:: link_names.txt