Mercurial > web-octave
comparison pages/support.md @ 288:2e13395adcc0
Major design change, footer, texts.
| author | Kai T. Ohlhus <k.ohlhus@gmail.com> |
|---|---|
| date | Sun, 29 May 2022 01:25:16 +0900 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 287:7b528322279e | 288:2e13395adcc0 |
|---|---|
| 1 --- | |
| 2 layout: page | |
| 3 title: Support | |
| 4 icon: <i class="fas fa-book-medical"></i> | |
| 5 menu: true | |
| 6 permalink: support | |
| 7 --- | |
| 8 | |
| 9 #### <i class="fas fa-book"></i> Read the **GNU Octave Manual** | |
| 10 | |
| 11 <div style="margin-left: 2em;" markdown="1"> | |
| 12 - [<i class="fas fa-globe-americas"></i> Web version]({{ site.docs_url }}) | |
| 13 - [<i class="fas fa-file-pdf"></i> PDF version]({{ "octave.pdf" | relative_url }}) | |
| 14 - Type `doc` inside Octave | |
| 15 </div> | |
| 16 | |
| 17 | |
| 18 #### <i class="fab fa-wikipedia-w"></i> [Octave Wiki]({{ site.wiki_url }}) | |
| 19 | |
| 20 <div style="margin-left: 2em;" markdown="1"> | |
| 21 Find [Frequently Asked Questions (FAQ)]({{ site.faq_url }}) | |
| 22 </div> | |
| 23 | |
| 24 #### <i class="fas fa-users"></i> User community | |
| 25 | |
| 26 <div style="margin-left: 2em;" markdown="1"> | |
| 27 The Octave user community is a loosely organized association of **volunteers**. | |
| 28 Your interactions with the community will be better if you have the | |
| 29 [right expectations about the support options]({{ "support-expectations.html" | relative_url }}) | |
| 30 available to you. | |
| 31 </div> | |
| 32 | |
| 33 <div style="margin-left: 2em;" markdown="1"> | |
| 34 - [<i class="fab fa-discourse"></i> **Discourse**]({{ site.discourse_url }}) -- | |
| 35 the major communication platform for Octave users and developers. | |
| 36 - <i class="far fa-comments"></i> **IRC**: Chat with users and developers on the | |
| 37 [Libera `#octave` channel](https://web.libera.chat/#octave). | |
| 38 - <i class="far fa-envelope"></i> Browse the old | |
| 39 [**mailing list archives**](https://lists.gnu.org/archive/html/help-octave/). | |
| 40 </div> | |
| 41 | |
| 42 | |
| 43 #### <i class="fas fa-comment-dollar"></i> [Commercial support]({{ "commercial-support.html" | relative_url }}) | |
| 44 | |
| 45 <div style="margin-left: 2em;" markdown="1"> | |
| 46 - Setup assistance | |
| 47 - Custom feature implementation | |
| 48 </div> | |
| 49 | |
| 50 #### <i class="fas fa-bug"></i> Report a bug | |
| 51 | |
| 52 GNU Octave uses the bug tracker at [GNU Savannah]({{ site.bugs_url }}). | |
| 53 There you can | |
| 54 [<i class="far fa-plus-square"></i> report a new bug](https://savannah.gnu.org/bugs/?group=octave&func=additem), | |
| 55 [<i class="far fa-list-alt"></i> browse recent bugs]({{ site.bugs_url }}), | |
| 56 or [<i class="fas fa-search"></i> search for bugs](https://savannah.gnu.org/bugs/?group=octave&func=search). | |
| 57 | |
| 58 <a href="{{ "/img/savannah_bug_report.png" | relative_url }}"> | |
| 59 <img src="{{ "/img/savannah_bug_report.png" | relative_url }}" | |
| 60 style="max-height: 250px; width: auto;" alt="Savannah bug report"> | |
| 61 </a> | |
| 62 | |
| 63 1. **Is the bug already known?** | |
| 64 | |
| 65 [<i class="fas fa-search"></i> Search for already reported bugs](https://savannah.gnu.org/bugs/?group=octave&func=search) | |
| 66 at the bug tracker first. | |
| 67 If you your problem **does not appear** to be known, | |
| 68 then you should report the problem. | |
| 69 | |
| 70 2. **Is it really a bug?** | |
| 71 | |
| 72 - If Octave **crashes**, for any input whatever, that is a bug. | |
| 73 Reliable interpreters never crash. | |
| 74 - If Octave produces **incorrect results**, for any input whatever, | |
| 75 that is a bug. | |
| 76 - If Octave produces an **error message** for **valid input**, that is a bug. | |
| 77 - If Octave produces **no error message** for **invalid input**, | |
| 78 that is a bug. | |
| 79 | |
| 80 <p></p> | |
| 81 | |
| 82 3. **Missing function in Octave** | |
| 83 | |
| 84 If a function exists in Matlab, but not in Octave, this is **not** a bug. | |
| 85 | |
| 86 - The function might already be | |
| 87 [part of an Octave package]({{ site.sourceforge_url }}/functions_by_alpha.php). | |
| 88 - You may file a **feature request** for it on the bug tracker. | |
| 89 | |
| 90 <p></p> | |
| 91 | |
| 92 Please be aware that it might take **several months** | |
| 93 until for new features become part of Octave. | |
| 94 Consider [<i class="fas fa-comment-dollar"></i> commercial support]({{ "commercial-support.html" | relative_url }}) | |
| 95 if you don't want to wait that long. | |
| 96 | |
| 97 4. **Make your bug report count** | |
| 98 | |
| 99 - **Report all the facts:**<br> | |
| 100 Include all information that make it possible to fix the bug. | |
| 101 If you are not sure whether to state a fact or leave it out, state it. | |
| 102 This information includes your **operating system**, **Octave version**, | |
| 103 **exact error message** or **exact output**. | |
| 104 - **Give a short, specific, complete example:**<br> | |
| 105 Avoid: pseudocode, uninitialized variables, | |
| 106 calls to unattached scripts or functions. | |
| 107 - **Justify your expectations briefly:**<br> | |
| 108 Although it might seem obvious to you, | |
| 109 someone examining the problem might not know what result you consider | |
| 110 correct. | |
| 111 | |
| 112 | |
| 113 #### Sending Patches for Octave | |
| 114 | |
| 115 If you have a suggested fix for a bug, | |
| 116 please attach it to your report in the tracker. | |
| 117 Your patch is more likely to be reviewed if you follow the guidelines from the | |
| 118 Octave Wiki about the [creation of changesets]({{ site.wiki_url }}/Mercurial). |