[openssl-commits] [openssl] master update
Matt Caswell
matt at openssl.org
Fri Jun 3 16:15:02 UTC 2016
The branch master has been updated
via 49c2a00d1427b84bd851125740f493d1822e6fbc (commit)
via 4d6013c762dcd8d1eb7d481b7d6df6b5433818fe (commit)
via 073b1b72f61d81f3cf8bc1728d35f9e7e734bbd2 (commit)
via 8c4f8039df25c930f9120eca4ccd9cfd225ad7ef (commit)
via 75737d4fcd19974dc7b21fa790836435dafb294c (commit)
via 26dee42d6ac6770d6ccdff59500f1619eb486cf0 (commit)
from 7d6df9e9150abc8e0d8f88b02159261e37eea167 (commit)
- Log -----------------------------------------------------------------
commit 49c2a00d1427b84bd851125740f493d1822e6fbc
Author: Matt Caswell <matt at openssl.org>
Date: Fri Jun 3 10:51:13 2016 +0100
Add a paragraph on documentation to CONTRIBUTING
Reviewed-by: Rich Salz <rsalz at openssl.org>
Reviewed-by: Richard Levitte <levitte at openssl.org>
commit 4d6013c762dcd8d1eb7d481b7d6df6b5433818fe
Author: Matt Caswell <matt at openssl.org>
Date: Fri Jun 3 10:42:20 2016 +0100
Further update CONTRIBUTING
Tweak to the wording on merge commits.
Reviewed-by: Rich Salz <rsalz at openssl.org>
Reviewed-by: Richard Levitte <levitte at openssl.org>
commit 073b1b72f61d81f3cf8bc1728d35f9e7e734bbd2
Author: Matt Caswell <matt at openssl.org>
Date: Thu Jun 2 11:09:13 2016 +0100
Tweaks to NOTES.PERL
Fix some typos and other minor amendments to NOTES.PERL.
Reviewed-by: Rich Salz <rsalz at openssl.org>
Reviewed-by: Richard Levitte <levitte at openssl.org>
commit 8c4f8039df25c930f9120eca4ccd9cfd225ad7ef
Author: Matt Caswell <matt at openssl.org>
Date: Thu Jun 2 11:03:45 2016 +0100
Update NOTES.WIN
Make the recommendation for MSYS perl in an MSYS environment more forceful.
Reviewed-by: Rich Salz <rsalz at openssl.org>
Reviewed-by: Richard Levitte <levitte at openssl.org>
commit 75737d4fcd19974dc7b21fa790836435dafb294c
Author: Matt Caswell <matt at openssl.org>
Date: Thu Jun 2 11:03:10 2016 +0100
Update CONTRIBUTING
Fix typos and clarify a few things in the CONTRIBUTING file.
Reviewed-by: Rich Salz <rsalz at openssl.org>
Reviewed-by: Richard Levitte <levitte at openssl.org>
commit 26dee42d6ac6770d6ccdff59500f1619eb486cf0
Author: Matt Caswell <matt at openssl.org>
Date: Thu Jun 2 11:01:32 2016 +0100
Bring the README file up to date
The README file was a little out of date so needed a refresh
Reviewed-by: Rich Salz <rsalz at openssl.org>
Reviewed-by: Richard Levitte <levitte at openssl.org>
-----------------------------------------------------------------------
Summary of changes:
CONTRIBUTING | 25 ++++++++++++++++---------
NOTES.PERL | 9 +++++----
NOTES.WIN | 2 +-
README | 34 ++++++++++++++++------------------
4 files changed, 38 insertions(+), 32 deletions(-)
diff --git a/CONTRIBUTING b/CONTRIBUTING
index 1bfbc1b..07115e5 100644
--- a/CONTRIBUTING
+++ b/CONTRIBUTING
@@ -1,11 +1,11 @@
HOW TO CONTRIBUTE TO PATCHES OpenSSL
------------------------------------
-(Please visit https://openssl.org/community/getting-started.html for
+(Please visit https://www.openssl.org/community/getting-started.html for
other ideas about how to contribute.)
Development is coordinated on the openssl-dev mailing list (see the
-above link or http://mta.openssl.org for information on subscribing).
+above link or https://mta.openssl.org for information on subscribing).
If you are unsure as to whether a feature will be useful for the general
OpenSSL community you might want to discuss it on the openssl-dev mailing
list first. Someone may be already working on the same thing or there
@@ -16,7 +16,7 @@ The best way to submit a patch is to make a pull request on GitHub.
If you think the patch could use feedback from the community, please
start a thread on openssl-dev.
-You can also submit patches by sending it as mail to rt at opensslorg.
+You can also submit patches by sending it as mail to rt at openssl.org.
Please include the word "PATCH" and an explanation of what the patch
does in the subject line. If you do this, our preferred format is "git
format-patch" output. For example to provide a patch file containing the
@@ -42,7 +42,7 @@ the acceptance and review process faster:
1. Anything other than trivial contributions will require a contributor
licensing agreement, giving us permission to use your code. See
- https://openssl.org/policies/cla.html for details.
+ https://www.openssl.org/policies/cla.html for details.
2. All source files should start with the following text (with
appropriate comment characters at the start of each line and the
@@ -56,13 +56,20 @@ the acceptance and review process faster:
https://www.openssl.org/source/license.html
3. Patches should be as current as possible. When using GitHub, please
- expect to have to rebase and update often.
+ expect to have to rebase and update often. Note that we do not accept merge
+ commits. You will be asked to remove them before a patch is considered
+ acceptable.
- 3. Patches should follow our coding style (see
+ 4. Patches should follow our coding style (see
https://www.openssl.org/policies/codingstyle.html) and compile without
- warnings using the --strict-warnings flag. OpenSSL compiles on many
- varied platforms: try to ensure you only use portable features.
+ warnings. Where gcc or clang is availble you should use the
+ --strict-warnings Configure option. OpenSSL compiles on many varied
+ platforms: try to ensure you only use portable features.
- 4. When at all possible, patches should include tests. These can either be
+ 5. When at all possible, patches should include tests. These can either be
added to an existing test, or completely new. Please see test/README
for information on the test framework.
+
+ 6. New features or changed functionality must include documentation. Please
+ look at the "pod" files in doc/apps, doc/crypto and doc/ssl for examples of
+ our style.
diff --git a/NOTES.PERL b/NOTES.PERL
index eda812d..46d585a 100644
--- a/NOTES.PERL
+++ b/NOTES.PERL
@@ -35,7 +35,8 @@
MinGW and Cygwin. The key recommendation is to use "matching" Perl,
one that matches build environment. For example, if you will build
on Cygwin be sure to use the Cygwin package manager to install Perl.
- For VC-* builds we recommend ActiveState Perl, available from
+ For MSYS builds use the MSYS provided Perl. For VC-* builds we
+ recommend ActiveState Perl, available from
http://www.activestate.com/ActivePerl.
Notes on Perl on VMS
@@ -43,7 +44,7 @@
You will need to install Perl separately. One way to do so is to
download the source from http://perl.org/, unpacking it, reading
- README.vms and follow instructions. Another way is to download a
+ README.vms and follow the instructions. Another way is to download a
.PCSI file from http://www.vmsperl.com/ and install it using the
POLYCENTER install tool.
@@ -99,9 +100,9 @@
$ cpan -i Text::Template
- Note that this runs all the tests that the module to be install
+ Note that this runs all the tests that the module to be installed
comes with. This is usually a smooth operation, but there are
- platforms where a failure is indicate even though the actual tests
+ platforms where a failure is indicated even though the actual tests
were successful. Should that happen, you can force an
installation regardless (that should be safe since you've already
seen the tests succeed!):
diff --git a/NOTES.WIN b/NOTES.WIN
index b3d1967..00ffb4a 100644
--- a/NOTES.WIN
+++ b/NOTES.WIN
@@ -95,7 +95,7 @@
required. Run the installers and do whatever magic they say it takes
to start MSYS bash shell with GNU tools and matching Perl on its PATH.
"Matching Perl" refers to chosen "shell environment", i.e. if built
- under MSYS, then Perl compiled for MSYS is highly recommended.
+ under MSYS, then Perl compiled for MSYS must be used.
Alternativelly, one can use MSYS2 from http://msys2.github.io/,
which includes MingW (32-bit and 64-bit).
diff --git a/README b/README
index 1672580..aa8fe68 100644
--- a/README
+++ b/README
@@ -10,11 +10,8 @@
The OpenSSL Project is a collaborative effort to develop a robust,
commercial-grade, fully featured, and Open Source toolkit implementing the
- Secure Sockets Layer (SSLv3) and Transport Layer Security (TLS) protocols as
- well as a full-strength general purpose cryptographic library. The project is
- managed by a worldwide community of volunteers that use the Internet to
- communicate, plan, and develop the OpenSSL toolkit and its related
- documentation.
+ Transport Layer Security (TLS) protocols (including SSLv3) as well as a
+ full-strength general purpose cryptographic library.
OpenSSL is descended from the SSLeay library developed by Eric A. Young
and Tim J. Hudson. The OpenSSL toolkit is licensed under a dual-license (the
@@ -55,7 +52,9 @@
-------
See the OpenSSL website www.openssl.org for details on how to obtain
- commercial technical support.
+ 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:
@@ -68,12 +67,11 @@
If you wish to report a bug then please include the following information in
any bug report:
- - On Unix systems:
- Self-test report generated by 'make report'
- - On other systems:
- OpenSSL version: output of 'openssl version -a'
- OS Name, Version, Hardware platform
- Compiler Details (name, version)
+ - OpenSSL version: output of 'openssl version -a'
+ - Any "Configure" options that you selected during compilation of the
+ library if applicable (see INSTALL)
+ - 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)
@@ -83,8 +81,8 @@
rt at openssl.org
In order to avoid spam, this is a moderated mailing list, and it might
- take a day for the ticket to show up. (We also scan posts to make sure
- that security disclosures aren't publically posted by mistake.) Mail
+ take a couple of days for the ticket to show up. (We also scan posts to make
+ sure that security disclosures aren't publically posted by mistake.) Mail
to this address is recorded in the public RT (request tracker) database
(see https://www.openssl.org/community/index.html#bugs for details) and
also forwarded the public openssl-dev mailing list. Confidential mail
@@ -93,11 +91,11 @@
Please do NOT use this for general assistance or support queries.
Just because something doesn't work the way you expect does not mean it
- is necessarily a bug in OpenSSL.
+ is necessarily a bug in OpenSSL. Use the openssl-users email list for this type
+ of query.
- You can also make GitHub pull requests. If you do this, please also send
- mail to rt at openssl.org with a link to the PR so that we can more easily
- keep track of it.
+ You can also make GitHub pull requests. See the CONTRIBUTING file for more
+ details.
HOW TO CONTRIBUTE TO OpenSSL
----------------------------
More information about the openssl-commits
mailing list