Skip to content

Commit

Permalink
Convert all source/*.html to .md
Browse files Browse the repository at this point in the history
Partial fix of openssl#324
  • Loading branch information
levitte committed Jul 15, 2022
1 parent 364ddb0 commit 692222d
Show file tree
Hide file tree
Showing 11 changed files with 164 additions and 318 deletions.
10 changes: 8 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,15 @@ H_TOP = $(addsuffix .html,$(basename $(shell git ls-files -- *.md)))
H_COMMUNITY = $(addsuffix .html,\
$(basename $(shell git ls-files -- community/*.md)))
H_NEWS = $(addsuffix .html,$(basename $(shell git ls-files -- news/*.md)))
H_SUPPORT = $(addsuffix .html,$(basename $(shell git ls-files -- support/*.md)))
H_POLICIES = $(addsuffix .html,\
$(basename $(shell git ls-files -- policies/general/*.md \
policies/technical/*.md)))
H_SOURCE= $(addsuffix .html,\
$(basename $(shell git ls-files -- source/*.md \
source/old/*.md) \
$(basename $(shell git ls-files -- source/*.md.tt \
source/old/*.md.tt))))
H_SUPPORT = $(addsuffix .html,$(basename $(shell git ls-files -- support/*.md)))

SIMPLE = $(H_TOP) \
newsflash.inc \
Expand All @@ -85,9 +90,9 @@ SIMPLE = $(H_TOP) \
$(foreach S,$(SERIES) $(OLDSERIES),news/vulnerabilities-$(S).html) \
$(H_POLICIES) \
policies/glossary.html \
$(H_SOURCE) \
source/.htaccess \
source/index.inc \
source/old/index.html \
$(H_SUPPORT)
SRCLISTS = $(foreach S,$(FUTURESERIES) $(SERIES) $(OLDSERIES2) fips,source/old/$(S)/index.inc source/old/$(S)/index.html)

Expand Down Expand Up @@ -502,5 +507,6 @@ $(foreach H, \
$(H_COMMUNITY) \
$(H_NEWS) \
$(H_POLICIES) \
$(H_SOURCE) \
$(H_SUPPORT) \
,$(eval $(call makehtmldepend,$(H))))
12 changes: 12 additions & 0 deletions source/dirdata.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
breadcrumbs: |
[Home](/) : [Downloads](.)
sidebar: |
# [Downloads](.)
- [Git Repository](gitrepo.html)
- [License](license.html)
- [OCB License](OCB-patent-grant-OpenSSL.pdf)
- [Old Releases](old/)
- [Mirror Sites](mirror.html)
---
76 changes: 0 additions & 76 deletions source/gitrepo.html

This file was deleted.

41 changes: 41 additions & 0 deletions source/gitrepo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: Git Repository
---
# Git Repository

The OpenSSL software is developed using a Git repository. Read-only access
to the repository is available at git.openssl.org. We also maintain a
downstream clone on GitHub, at <https://github.com/openssl/openssl> on
GitHub. This repository is updated with every commit and is accessible
through a number of protocols.

On the OpenSSL repository we only support the *git* protocol. Use the
following command to clone the git repository including all available
branches and tags:

$ git clone git://git.openssl.org/openssl.git

Access to specific branches is possible via the standard branch and
checkout commands. See the discussion of branch naming below for more
information.

On Windows, once the repository is cloned, you should ensure that line
endings are set correctly:

$ cd openssl
$ git config core.autocrlf false
$ git config core.eol lf
$ git checkout .

## Git branch names and tagging

The *master* branch, also known as the development branch, contains the
latest bleeding edge code. There are also several *stable* branches
where stable releases come from. These take the form
*OpenSSL\_x\_y\_z-stable* so, for example, the 1.1.0 stable branch is
*OpenSSL\_1\_1\_0-stable*. When an actual release is made it is tagged
in the form *OpenSSL\_x\_y\_zp* or a beta *OpenSSL\_x\_y\_xp-betan*,
though you should normally just download the release tarball. Tags and
branches are occasionally used for other purposes such as testing
experimental or unstable code before it is merged into another branch.
104 changes: 0 additions & 104 deletions source/index.html

This file was deleted.

63 changes: 63 additions & 0 deletions source/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Downloads
The master sources are maintained in our [git repository](gitrepo.html),
which is accessible over the network and cloned on GitHub, at
<https://github.com/openssl/openssl>. Bugs and pull patches (issues and
pull requests) should be filed on the GitHub repo. Please familiarize
yourself with the [license](license.html).

The table below lists the latest releases for every branch. (For an explanation
of the numbering, see our [release strategy](/policies/releasestrat.html).)
All releases can be found at [/source/old](old). A list of mirror sites can be
found [here](mirror.html).

*Note:* The latest stable version is the 3.0 series supported until 7th
September 2026. This is also a Long Term Support (LTS) version. The
previous LTS version (the 1.1.1 series) is also available and is
supported until 11th September 2023. All older versions (including
1.1.0, 1.0.2, 1.0.0 and 0.9.8) are now out of support and should not be
used. Users of these older versions are encouraged to upgrade to 3.0 as
soon as possible. Extended support for 1.0.2 to gain access to security
fixes for that version is [available](/support/contracts.html).

OpenSSL 3.0 is the latest major version of OpenSSL. The OpenSSL FIPS
Object Module (FOM) 3.0 is an integrated part of the OpenSSL 3.0
download. You do not need to download the 3.0 FOM separately. Refer to
the installation instructions inside the download, and use the
"enable-fips" compile time configuration option to build it.

For an overview of some of the key concepts in OpenSSL 3.0 see the
libcrypto [manual
page](https://www.openssl.org/docs/man3.0/man7/crypto.html). Information
and notes about migrating existing applications to OpenSSL 3.0 are
available in the [OpenSSL 3.0 Migration
Guide](https://www.openssl.org/docs/man3.0/man7/migration_guide.html)

<table>
<tr>
<td>KBytes&nbsp;</td>
<td>Date&nbsp;&nbsp;</td>
<td>File&nbsp;</td>
</tr>
<!--#include virtual="index.inc" -->
</table>

When building a release for the first time, please make sure to look at
the INSTALL file in the distribution along with any NOTES file
applicable to your platform. If you have problems, look at the FAQ,
which can be found [online](/docs/faq.html). If you still need more
help, then join the [openssl-users](/community/mailinglists.html) email
list and post a question there.

PGP keys for the signatures are available from the
[OTC page](https://www.openssl.org/community/otc.html). Current members that
sign releases include Richard Levitte, Matt Caswell, Paul Dale, and Tomas Mraz.

Each day we make a snapshot of each development branch. They can be
found at <https://www.openssl.org/source/snapshot/>. These daily
snapshots of the source tree are provided for convenience only and not
even guaranteed to compile. Note that keeping a git local repository and
updating it every 24 hours is equivalent and will often be faster and
more efficient.

You are here: [Home](/) : [Downloads](.)\
[Sitemap](/sitemap.txt)
53 changes: 0 additions & 53 deletions source/license.html

This file was deleted.

Loading

0 comments on commit 692222d

Please sign in to comment.