doc: It is not possible to use SSL_OP_* value in preprocessor conditions
[openssl.git] / SUPPORT.md
index 9dc33a79867610cd3ed637b833ac651b5c18c26a..bf88c2147e39968ea7fb4b4e2faa0d1f95e24f8d 100644 (file)
@@ -1,63 +1,26 @@
-
 OpenSSL User Support resources
 ==============================
 
-_Under Construction; not more than a collection of text fragments yet._
-
-See the OpenSSL website www.openssl.org for details on how to obtain
-commercial technical support. Free community support is available through the
-openssl-users email list (see
-https://www.openssl.org/community/mailinglists.html for further details).
-
-If you have any problems with OpenSSL then please take the following steps
-first:
-
- - Download the latest version from the repository
-   to see if the problem has already been addressed
- - Configure with no-asm
- - Remove compiler optimization flags
-
-If you wish to report a bug then please include the following information
-and create an issue on GitHub:
-
- - OpenSSL version: output of 'openssl version -a'
- - Configuration data: output of 'perl configdata.pm ==dump'
- - OS Name, Version, Hardware platform
- - Compiler Details (name, version)
- - Application Details (name, version)
- - Problem Description (steps that will reproduce the problem, if known)
- - Stack Traceback (if the application dumps core)
-
-Just because something doesn't work the way you expect does not mean it
-is necessarily a bug in OpenSSL. Use the openssl-users email list for this type
-of query.
-
-
-
-For *questions* on how to use OpenSSL or what went wrong when you
-tried something, our primary resource is the mailing list
-openssl-users@openssl.org, where you can get help from others in the
-OpenSSL community (which includes the developers as time permits).
+See the <https://www.openssl.org/support/contracts.html> for details on how to
+obtain commercial technical support.
 
-Only subscribers can post to openssl-users@openssl.org (although the
-archives are public).
-For more information, see https://www.openssl.org/community/mailinglists.html
+If you have general questions about using OpenSSL
+-------------------------------------------------
 
-
-
-
-You have general questions about using OpenSSL
-----------------------------------------------
-
-In this case the [openssl-users][] mailing list is the right place for you.
+In this case the [openssl-users] mailing list is the right place for you.
 The list is not only watched by the OpenSSL team members, but also by many
 other OpenSSL users. Here you will most likely get the answer to your questions.
 An overview over the [mailing lists](#mailing-lists) can be found below.
 
-You found a Bug
----------------
+If you think you found a Bug
+----------------------------
+
+*NOTE: this section assumes that you want to report it or figure it out and
+fix it.  What's written here is not to be taken as a recipe for how to get a
+working production installation*
 
-If you have any problems with OpenSSL then please take the following steps first:
+If you have any problems with OpenSSL then please take the following steps
+first:
 
 - Search the mailing lists and/or the GitHub issues to find out whether
   the problem has already been reported.
@@ -70,7 +33,7 @@ If you have any problems with OpenSSL then please take the following steps first
 Please keep in mind: Just because something doesn't work the way you expect
 does not mean it is necessarily a bug in OpenSSL. If you are not sure,
 consider searching the mail archives and posting a question to the
-[openssl-users][] mailing list first.
+[openssl-users] mailing list first.
 
 ### Open an Issue
 
@@ -97,30 +60,27 @@ pull request. The details are covered in the [Contributing](#contributing) secti
 Don't hesitate to open a pull request, even if it's only a small change
 like a grammatical or typographical error in the documentation.
 
-
-
-
-
 Mailing Lists
 =============
 
-The OpenSSL maintains a number of [mailing lists][] for various purposes.
+The OpenSSL maintains a number of [mailing lists] for various purposes.
 The most important lists are:
 
-- [openssl-users][] for general questions about using the OpenSSL software
-                    and discussions between OpenSSL users.
-
-- [openssl-announce][] for official announcements to the OpenSSL community.
+- [openssl-users]    for general questions about using the OpenSSL software
+                     and discussions between OpenSSL users.
 
-- [openssl-project][]  for discussion about the development roadmap
-                       and governance.
+- [openssl-announce] for official announcements to the OpenSSL community.
 
-- [openssl-dev][]      for discussion about development of OpenSSL.
+- [openssl-project]  for discussion about the development roadmap
+                     and governance.
 
-The openssl-dev list has been discontinued since development is now taking
-place in form of GitHub pull requests. Although not active anymore, the
-searchable archive may still contain useful information.
+Only subscribers can post to [openssl-users] or [openssl-project].  The
+archives are made public, however.  For more information, see the [mailing
+lists] page.
 
+There was an [openssl-dev] list that has been discontinued since development
+is now taking place in the form of GitHub pull requests. Although not active
+anymore, the searchable archive may still contain useful information.
 
 <!-- Links -->