Mercurial > web-octave

annotate pages/support.md @ 288:2e13395adcc0

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