Skip to content

Commit 11ed1e6

Browse files
sam-githubMylesBorins
sam-github
authored and
MylesBorins
committed
deps,doc: move openssl maintenance guide to doc
The maintainenance guides are mostly in doc/guides-maintaining-*.md, so move the OpenSSL one there, too. PR-URL: #32209 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent b5b7bf5 commit 11ed1e6

File tree

2 files changed

+34
-32
lines changed

2 files changed

+34
-32
lines changed

‎deps/openssl/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,4 +76,4 @@ Please refer [config/opensslconf_asm.h](config/opensslconf_asm.h) for details.
7676

7777
### Upgrading OpenSSL
7878

79-
Please refer [config/README.md](config/README.md).
79+
Please refer to [maintaining-openssl](../../doc/guides/maintaining-openssl.md).

deps/openssl/config/README.md renamed to doc/guides/maintaining-openssl.md

Lines changed: 33 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,46 @@
1-
## Upgrading OpenSSL
1+
# Maintaining OpenSSL
22

3-
### Requirements
4-
- Linux environment (Only CentOS7.1 and Ubuntu16 are tested)
5-
- `perl` Only Perl version 5 is tested.
6-
- `nasm` (http://www.nasm.us/) The version of 2.11 or higher is needed.
7-
- GNU `as` in binutils. The version of 2.26 or higher is needed.
3+
This document describes how to update `deps/openssl/`.
84

9-
### 0. Check Requirements
5+
## Requirements
6+
* Linux environment
7+
* `perl` Only Perl version 5 is tested.
8+
* `nasm` (http://www.nasm.us/) The version of 2.11 or higher is needed.
9+
* GNU `as` in binutils. The version of 2.26 or higher is needed.
10+
11+
## 0. Check Requirements
1012

1113
```sh
12-
$ perl -v
14+
% perl -v
1315

1416
This is perl 5, version 22, subversion 1 (v5.22.1) built for
1517
x86_64-linux-gnu-thread-multi
1618
(with 60 registered patches, see perl -V for more detail)
1719

18-
$ as --version
20+
% as --version
1921
GNU assembler (GNU Binutils for Ubuntu) 2.26.1
2022
Copyright (C) 2015 Free Software Foundation, Inc.
2123
...
22-
$ nasm -v
24+
% nasm -v
2325
NASM version 2.11.08
2426
```
2527

26-
### 1. Obtain and extract new OpenSSL sources
28+
## 1. Obtain and extract new OpenSSL sources
2729

2830
Get a new source from https://www.openssl.org/source/ and extract
2931
all files into `deps/openssl/openssl`. Then add all files and commit
3032
them.
3133
```sh
32-
$ cd deps/openssl/
33-
$ rm -rf openssl
34-
$ tar zxf ~/tmp/openssl-1.1.0h.tar.gz
35-
$ mv openssl-1.1.0h openssl
36-
$ git add --all openssl
37-
$ git commit openssl
34+
% cd deps/openssl/
35+
% rm -rf openssl
36+
% tar zxf ~/tmp/openssl-1.1.0h.tar.gz
37+
% mv openssl-1.1.0h openssl
38+
% git add --all openssl
39+
% git commit openssl
3840
````
3941

4042
The commit message can be (with the openssl version set to the relevant value):
41-
```
43+
```text
4244
deps: upgrade openssl sources to 1.1.0h
4345
4446
This updates all sources in deps/openssl/openssl by:
@@ -50,22 +52,22 @@ This updates all sources in deps/openssl/openssl by:
5052
$ git commit openssl
5153
```
5254

53-
### 2. Execute `make` in `deps/openssl/config` directory
55+
## 2. Execute `make` in `deps/openssl/config` directory
5456

5557
Use `make` to regenerate all platform dependent files in
5658
`deps/openssl/config/archs/`:
5759
```sh
58-
$ cd deps/openssl/config; make
60+
% cd deps/openssl/config; make
5961
```
6062

61-
### 3. Check diffs
63+
## 3. Check diffs
6264

6365
Check diffs if updates are right. Even if no updates in openssl
6466
sources, `buildinf.h` files will be updated for they have a timestamp
6567
data in them.
6668
```sh
67-
$ cd deps/openssl/config
68-
$ git diff
69+
% cd deps/openssl/config
70+
% git diff
6971
```
7072

7173
*Note*: On Windows, OpenSSL Configure generates `makefile` that can be
@@ -75,20 +77,20 @@ created. When source files or build options are updated in Windows,
7577
it needs to change these two Makefiles by hand. If you are not sure,
7678
please ask @shigeki for details.
7779

78-
### 4. Commit and make test
80+
## 4. Commit and make test
7981

8082
Update all architecture dependent files. Do not forget to git add or remove
8183
files if they are changed before commit:
8284
```sh
83-
$ git add deps/openssl/config/archs
84-
$ git add deps/openssl/openssl/crypto/include/internal/bn_conf.h
85-
$ git add deps/openssl/openssl/crypto/include/internal/dso_conf.h
86-
$ git add deps/openssl/openssl/include/openssl/opensslconf.h
87-
$ git commit
85+
% git add deps/openssl/config/archs
86+
% git add deps/openssl/openssl/crypto/include/internal/bn_conf.h
87+
% git add deps/openssl/openssl/crypto/include/internal/dso_conf.h
88+
% git add deps/openssl/openssl/include/openssl/opensslconf.h
89+
% git commit
8890
```
8991

9092
The commit message can be (with the openssl version set to the relevant value):
91-
```
93+
```text
9294
deps: update archs files for OpenSSL-1.1.0
9395
9496
After an OpenSSL source update, all the config files need to be regenerated and
@@ -102,4 +104,4 @@ The commit message can be (with the openssl version set to the relevant value):
102104
$ git commit
103105
```
104106

105-
Finally, build Node and run tests.
107+
Finally, build Node.js and run tests.

0 commit comments

Comments
 (0)