Skip to content

Commit be0c6a3

Browse files
committedFeb 26, 2020
doc: revamp the SUPPORT file
Too be continued... Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> (Merged from openssl#10545)
1 parent 6ede7d7 commit be0c6a3

File tree

1 file changed

+120
-0
lines changed

1 file changed

+120
-0
lines changed
 

‎SUPPORT.md

+120
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,39 @@
1+
12
OpenSSL User Support resources
23
==============================
34

5+
_Under Construction; not more than a collection of text fragments yet._
6+
7+
See the OpenSSL website www.openssl.org for details on how to obtain
8+
commercial technical support. Free community support is available through the
9+
openssl-users email list (see
10+
https://www.openssl.org/community/mailinglists.html for further details).
11+
12+
If you have any problems with OpenSSL then please take the following steps
13+
first:
14+
15+
- Download the latest version from the repository
16+
to see if the problem has already been addressed
17+
- Configure with no-asm
18+
- Remove compiler optimization flags
19+
20+
If you wish to report a bug then please include the following information
21+
and create an issue on GitHub:
22+
23+
- OpenSSL version: output of 'openssl version -a'
24+
- Configuration data: output of 'perl configdata.pm ==dump'
25+
- OS Name, Version, Hardware platform
26+
- Compiler Details (name, version)
27+
- Application Details (name, version)
28+
- Problem Description (steps that will reproduce the problem, if known)
29+
- Stack Traceback (if the application dumps core)
30+
31+
Just because something doesn't work the way you expect does not mean it
32+
is necessarily a bug in OpenSSL. Use the openssl-users email list for this type
33+
of query.
34+
35+
36+
437
For *questions* on how to use OpenSSL or what went wrong when you
538
tried something, our primary resource is the mailing list
639
openssl-users@openssl.org, where you can get help from others in the
@@ -9,3 +42,90 @@ OpenSSL community (which includes the developers as time permits).
942
Only subscribers can post to openssl-users@openssl.org (although the
1043
archives are public).
1144
For more information, see https://www.openssl.org/community/mailinglists.html
45+
46+
47+
48+
49+
You have general questions about using OpenSSL
50+
----------------------------------------------
51+
52+
In this case the [openssl-users][] mailing list is the right place for you.
53+
The list is not only watched by the OpenSSL team members, but also by many
54+
other OpenSSL users. Here you will most likely get the answer to your questions.
55+
An overview over the [mailing lists](#mailing-lists) can be found below.
56+
57+
You found a Bug
58+
---------------
59+
60+
If you have any problems with OpenSSL then please take the following steps first:
61+
62+
- Search the mailing lists and/or the GitHub issues to find out whether
63+
the problem has already been reported.
64+
- Download the latest version from the repository to see if the problem
65+
has already been addressed.
66+
- Configure without assembler support (`no-asm`) and check whether the
67+
problem persists.
68+
- Remove compiler optimization flags.
69+
70+
Please keep in mind: Just because something doesn't work the way you expect
71+
does not mean it is necessarily a bug in OpenSSL. If you are not sure,
72+
consider searching the mail archives and posting a question to the
73+
[openssl-users][] mailing list first.
74+
75+
### Open an Issue
76+
77+
If you wish to report a bug, please open an [issue][github-issues] on GitHub
78+
and include the following information:
79+
80+
- OpenSSL version: output of `openssl version -a`
81+
- Configuration data: output of `perl configdata.pm --dump`
82+
- OS Name, Version, Hardware platform
83+
- Compiler Details (name, version)
84+
- Application Details (name, version)
85+
- Problem Description (steps that will reproduce the problem, if known)
86+
- Stack Traceback (if the application dumps core)
87+
88+
Not only errors in the software, also errors in the documentation, in
89+
particular the manual pages, can be reported as issues.
90+
91+
### Submit a Pull Request
92+
93+
The fastest way to get a bug fixed is to fix it yourself ;-). If you are
94+
experienced in programming and know how to fix the bug, you can open a
95+
pull request. The details are covered in the [Contributing](#contributing) section.
96+
97+
Don't hesitate to open a pull request, even if it's only a small change
98+
like a grammatical or typographical error in the documentation.
99+
100+
101+
102+
103+
104+
Mailing Lists
105+
=============
106+
107+
The OpenSSL maintains a number of [mailing lists][] for various purposes.
108+
The most important lists are:
109+
110+
- [openssl-users][] for general questions about using the OpenSSL software
111+
and discussions between OpenSSL users.
112+
113+
- [openssl-announce][] for official announcements to the OpenSSL community.
114+
115+
- [openssl-project][] for discussion about the development roadmap
116+
and governance.
117+
118+
- [openssl-dev][] for discussion about development of OpenSSL.
119+
120+
The openssl-dev list has been discontinued since development is now taking
121+
place in form of GitHub pull requests. Although not active anymore, the
122+
searchable archive may still contain useful information.
123+
124+
125+
<!-- Links -->
126+
127+
[mailing lists]: https://www.openssl.org/community/mailinglists.html
128+
[openssl-users]: https://mta.openssl.org/mailman/listinfo/openssl-users
129+
[openssl-announce]: https://mta.openssl.org/mailman/listinfo/openssl-announce
130+
[openssl-project]: https://mta.openssl.org/mailman/listinfo/openssl-project
131+
[openssl-dev]: https://mta.openssl.org/mailman/listinfo/openssl-dev

0 commit comments

Comments
 (0)
Please sign in to comment.