From: Michael Hanke Date: Sat, 20 Apr 2013 08:50:13 +0000 (+0200) Subject: Few fixes and bug report instructions X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=e1561ee710e10745393c26b10c5961d218339f1d;p=neurodebian.git Few fixes and bug report instructions --- diff --git a/sphinx/about.rst b/sphinx/about.rst index 656a869..9c4ebc8 100644 --- a/sphinx/about.rst +++ b/sphinx/about.rst @@ -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 diff --git a/sphinx/install_pkg.rst b/sphinx/install_pkg.rst index 699b961..849352a 100644 --- a/sphinx/install_pkg.rst +++ b/sphinx/install_pkg.rst @@ -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 diff --git a/sphinx/popularity.rst b/sphinx/popularity.rst index 19cff50..42350f3 100644 --- a/sphinx/popularity.rst +++ b/sphinx/popularity.rst @@ -43,4 +43,4 @@ In addition to popcon pages for your "core" distribution (e.g. `Debian submissions to `NeuroDebian `__ and know that you are already contributing back to the community. - +..include:: link_names.txt diff --git a/sphinx/reportbug.rst b/sphinx/reportbug.rst index 2e59926..e82566f 100644 --- a/sphinx/reportbug.rst +++ b/sphinx/reportbug.rst @@ -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 `_. + +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])); } + +.. include:: link_names.txt diff --git a/sphinx/thanks.rst b/sphinx/thanks.rst index 2555250..11aea7e 100644 --- a/sphinx/thanks.rst +++ b/sphinx/thanks.rst @@ -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