Skip to content

Commit 27315a9

Browse files
mspncphlandau
authored andcommitted
doc: add the migration guide to the new guide series
Reviewed-by: Hugo Landau <[email protected]> Reviewed-by: Matt Caswell <[email protected]> (Merged from openssl#21807)
1 parent 7542bdb commit 27315a9

7 files changed

+18
-15
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ document.
114114
* [Notes on Valgrind](NOTES-VALGRIND.md)
115115

116116
Specific notes on upgrading to OpenSSL 3.0 from previous versions can be found
117-
in the [migration_guide(7ossl)] manual page.
117+
in the [ossl-guide-migration(7ossl)] manual page.
118118

119119
Documentation
120120
=============
@@ -194,8 +194,8 @@ All rights reserved.
194194
<https://wiki.openssl.org>
195195
"OpenSSL Wiki"
196196

197-
[migration_guide(7ossl)]:
198-
<https://www.openssl.org/docs/manmaster/man7/migration_guide.html>
197+
[ossl-guide-migration(7ossl)]:
198+
<https://www.openssl.org/docs/manmaster/man7/ossl-guide-migration.html>
199199
"OpenSSL Migration Guide"
200200

201201
[RFC 8446]:

dev/release-aux/openssl-announce-pre-release.tmpl

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
Specific notes on upgrading to OpenSSL $series from previous versions are
1616
available in the OpenSSL Migration Guide, here:
1717

18-
https://www.openssl.org/docs/manmaster/man7/migration_guide.html
18+
https://www.openssl.org/docs/manmaster/man7/ossl-guide-migration.html
1919

2020
The $label release is available for download via HTTPS and FTP from the
2121
following master locations (you can find the various FTP mirrors under

dev/release-aux/openssl-announce-release.tmpl

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
Specific notes on upgrading to OpenSSL $series from previous versions are
1515
available in the OpenSSL Migration Guide, here:
1616

17-
https://www.openssl.org/docs/man$series/man7/migration_guide.html
17+
https://www.openssl.org/docs/man$series/man7/ossl-guide-migration.html
1818

1919
OpenSSL $release is available for download via HTTPS and FTP from the
2020
following master locations (you can find the various FTP mirrors under

doc/build.info

+6-6
Original file line numberDiff line numberDiff line change
@@ -4721,10 +4721,6 @@ DEPEND[html/man7/life_cycle-rand.html]=man7/life_cycle-rand.pod
47214721
GENERATE[html/man7/life_cycle-rand.html]=man7/life_cycle-rand.pod
47224722
DEPEND[man/man7/life_cycle-rand.7]=man7/life_cycle-rand.pod
47234723
GENERATE[man/man7/life_cycle-rand.7]=man7/life_cycle-rand.pod
4724-
DEPEND[html/man7/migration_guide.html]=man7/migration_guide.pod
4725-
GENERATE[html/man7/migration_guide.html]=man7/migration_guide.pod
4726-
DEPEND[man/man7/migration_guide.7]=man7/migration_guide.pod
4727-
GENERATE[man/man7/migration_guide.7]=man7/migration_guide.pod
47284724
DEPEND[html/man7/openssl-core.h.html]=man7/openssl-core.h.pod
47294725
GENERATE[html/man7/openssl-core.h.html]=man7/openssl-core.h.pod
47304726
DEPEND[man/man7/openssl-core.h.7]=man7/openssl-core.h.pod
@@ -4775,6 +4771,10 @@ DEPEND[html/man7/ossl-guide-libssl-introduction.html]=man7/ossl-guide-libssl-int
47754771
GENERATE[html/man7/ossl-guide-libssl-introduction.html]=man7/ossl-guide-libssl-introduction.pod
47764772
DEPEND[man/man7/ossl-guide-libssl-introduction.7]=man7/ossl-guide-libssl-introduction.pod
47774773
GENERATE[man/man7/ossl-guide-libssl-introduction.7]=man7/ossl-guide-libssl-introduction.pod
4774+
DEPEND[html/man7/ossl-guide-migration.html]=man7/ossl-guide-migration.pod
4775+
GENERATE[html/man7/ossl-guide-migration.html]=man7/ossl-guide-migration.pod
4776+
DEPEND[man/man7/ossl-guide-migration.7]=man7/ossl-guide-migration.pod
4777+
GENERATE[man/man7/ossl-guide-migration.7]=man7/ossl-guide-migration.pod
47784778
DEPEND[html/man7/ossl-guide-quic-client-block.html]=man7/ossl-guide-quic-client-block.pod
47794779
GENERATE[html/man7/ossl-guide-quic-client-block.html]=man7/ossl-guide-quic-client-block.pod
47804780
DEPEND[man/man7/ossl-guide-quic-client-block.7]=man7/ossl-guide-quic-client-block.pod
@@ -4985,7 +4985,6 @@ html/man7/life_cycle-kdf.html \
49854985
html/man7/life_cycle-mac.html \
49864986
html/man7/life_cycle-pkey.html \
49874987
html/man7/life_cycle-rand.html \
4988-
html/man7/migration_guide.html \
49894988
html/man7/openssl-core.h.html \
49904989
html/man7/openssl-core_dispatch.h.html \
49914990
html/man7/openssl-core_names.h.html \
@@ -4998,6 +4997,7 @@ html/man7/ossl-guide-introduction.html \
49984997
html/man7/ossl-guide-libcrypto-introduction.html \
49994998
html/man7/ossl-guide-libraries-introduction.html \
50004999
html/man7/ossl-guide-libssl-introduction.html \
5000+
html/man7/ossl-guide-migration.html \
50015001
html/man7/ossl-guide-quic-client-block.html \
50025002
html/man7/ossl-guide-quic-introduction.html \
50035003
html/man7/ossl-guide-tls-client-block.html \
@@ -5124,7 +5124,6 @@ man/man7/life_cycle-kdf.7 \
51245124
man/man7/life_cycle-mac.7 \
51255125
man/man7/life_cycle-pkey.7 \
51265126
man/man7/life_cycle-rand.7 \
5127-
man/man7/migration_guide.7 \
51285127
man/man7/openssl-core.h.7 \
51295128
man/man7/openssl-core_dispatch.h.7 \
51305129
man/man7/openssl-core_names.h.7 \
@@ -5137,6 +5136,7 @@ man/man7/ossl-guide-introduction.7 \
51375136
man/man7/ossl-guide-libcrypto-introduction.7 \
51385137
man/man7/ossl-guide-libraries-introduction.7 \
51395138
man/man7/ossl-guide-libssl-introduction.7 \
5139+
man/man7/ossl-guide-migration.7 \
51405140
man/man7/ossl-guide-quic-client-block.7 \
51415141
man/man7/ossl-guide-quic-introduction.7 \
51425142
man/man7/ossl-guide-tls-client-block.7 \

doc/man7/fips_module.pod

+3-3
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ EC_KEY_METHOD_new(), etc.)
4242
=back
4343

4444
All of the above APIs are deprecated in OpenSSL 3.0 - so a simple rule is to
45-
avoid using all deprecated functions. See L<migration_guide(7)> for a list of
45+
avoid using all deprecated functions. See L<ossl-guide-migration(7)> for a list of
4646
deprecated functions.
4747

4848
=head2 Making all applications use the FIPS module by default
@@ -393,7 +393,7 @@ explicitly loaded, the default provider will not automatically load. This means
393393
code using the default context by accident will fail because no algorithms will
394394
be available.
395395

396-
See L<migration_guide(7)/Library Context> for additional information about the
396+
See L<ossl-guide-migration(7)/Library Context> for additional information about the
397397
Library Context.
398398

399399
=head2 Using Encoders and Decoders with the FIPS module
@@ -500,7 +500,7 @@ want to operate in a FIPS approved manner. The algorithms are:
500500

501501
=head1 SEE ALSO
502502

503-
L<migration_guide(7)>, L<crypto(7)>, L<fips_config(5)>,
503+
L<ossl-guide-migration(7)>, L<crypto(7)>, L<fips_config(5)>,
504504
L<https://www.openssl.org/source/>
505505

506506
=head1 HISTORY

doc/man7/ossl-guide-introduction.pod

+2
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,8 @@ The pages in the guide are as follows:
8181

8282
=item L<ossl-guide-quic-client-block(7)>: Writing a simple blocking QUIC client
8383

84+
=item L<ossl-guide-migration(7)>: Migrating from older OpenSSL versions
85+
8486
=back
8587

8688
=head1 COPYRIGHT

doc/man7/migration_guide.pod doc/man7/ossl-guide-migration.pod

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
=head1 NAME
44

5-
migration_guide - OpenSSL migration guide
5+
ossl-guide-migration, migration_guide
6+
- OpenSSL Guide: Migrating from older OpenSSL versions
67

78
=head1 SYNOPSIS
89

0 commit comments

Comments
 (0)