Sfoglia il codice sorgente

doc: add the migration guide to the new guide series

Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/21807)
Matthias St. Pierre 1 anno fa
parent
commit
27315a978e

+ 3 - 3
README.md

@@ -114,7 +114,7 @@ document.
  * [Notes on Valgrind](NOTES-VALGRIND.md)
  * [Notes on Valgrind](NOTES-VALGRIND.md)
 
 
 Specific notes on upgrading to OpenSSL 3.0 from previous versions can be found
 Specific notes on upgrading to OpenSSL 3.0 from previous versions can be found
-in the [migration_guide(7ossl)] manual page.
+in the [ossl-guide-migration(7ossl)] manual page.
 
 
 Documentation
 Documentation
 =============
 =============
@@ -194,8 +194,8 @@ All rights reserved.
     <https://wiki.openssl.org>
     <https://wiki.openssl.org>
     "OpenSSL Wiki"
     "OpenSSL Wiki"
 
 
-[migration_guide(7ossl)]:
-    <https://www.openssl.org/docs/manmaster/man7/migration_guide.html>
+[ossl-guide-migration(7ossl)]:
+    <https://www.openssl.org/docs/manmaster/man7/ossl-guide-migration.html>
     "OpenSSL Migration Guide"
     "OpenSSL Migration Guide"
 
 
 [RFC 8446]:
 [RFC 8446]:

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

@@ -15,7 +15,7 @@
    Specific notes on upgrading to OpenSSL $series from previous versions are
    Specific notes on upgrading to OpenSSL $series from previous versions are
    available in the OpenSSL Migration Guide, here:
    available in the OpenSSL Migration Guide, here:
 
 
-        https://www.openssl.org/docs/manmaster/man7/migration_guide.html
+        https://www.openssl.org/docs/manmaster/man7/ossl-guide-migration.html
 
 
    The $label release is available for download via HTTPS and FTP from the
    The $label release is available for download via HTTPS and FTP from the
    following master locations (you can find the various FTP mirrors under
    following master locations (you can find the various FTP mirrors under

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

@@ -14,7 +14,7 @@
    Specific notes on upgrading to OpenSSL $series from previous versions are
    Specific notes on upgrading to OpenSSL $series from previous versions are
    available in the OpenSSL Migration Guide, here:
    available in the OpenSSL Migration Guide, here:
 
 
-        https://www.openssl.org/docs/man$series/man7/migration_guide.html
+        https://www.openssl.org/docs/man$series/man7/ossl-guide-migration.html
 
 
    OpenSSL $release is available for download via HTTPS and FTP from the
    OpenSSL $release is available for download via HTTPS and FTP from the
    following master locations (you can find the various FTP mirrors under
    following master locations (you can find the various FTP mirrors under

+ 6 - 6
doc/build.info

@@ -4721,10 +4721,6 @@ DEPEND[html/man7/life_cycle-rand.html]=man7/life_cycle-rand.pod
 GENERATE[html/man7/life_cycle-rand.html]=man7/life_cycle-rand.pod
 GENERATE[html/man7/life_cycle-rand.html]=man7/life_cycle-rand.pod
 DEPEND[man/man7/life_cycle-rand.7]=man7/life_cycle-rand.pod
 DEPEND[man/man7/life_cycle-rand.7]=man7/life_cycle-rand.pod
 GENERATE[man/man7/life_cycle-rand.7]=man7/life_cycle-rand.pod
 GENERATE[man/man7/life_cycle-rand.7]=man7/life_cycle-rand.pod
-DEPEND[html/man7/migration_guide.html]=man7/migration_guide.pod
-GENERATE[html/man7/migration_guide.html]=man7/migration_guide.pod
-DEPEND[man/man7/migration_guide.7]=man7/migration_guide.pod
-GENERATE[man/man7/migration_guide.7]=man7/migration_guide.pod
 DEPEND[html/man7/openssl-core.h.html]=man7/openssl-core.h.pod
 DEPEND[html/man7/openssl-core.h.html]=man7/openssl-core.h.pod
 GENERATE[html/man7/openssl-core.h.html]=man7/openssl-core.h.pod
 GENERATE[html/man7/openssl-core.h.html]=man7/openssl-core.h.pod
 DEPEND[man/man7/openssl-core.h.7]=man7/openssl-core.h.pod
 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
 GENERATE[html/man7/ossl-guide-libssl-introduction.html]=man7/ossl-guide-libssl-introduction.pod
 GENERATE[html/man7/ossl-guide-libssl-introduction.html]=man7/ossl-guide-libssl-introduction.pod
 DEPEND[man/man7/ossl-guide-libssl-introduction.7]=man7/ossl-guide-libssl-introduction.pod
 DEPEND[man/man7/ossl-guide-libssl-introduction.7]=man7/ossl-guide-libssl-introduction.pod
 GENERATE[man/man7/ossl-guide-libssl-introduction.7]=man7/ossl-guide-libssl-introduction.pod
 GENERATE[man/man7/ossl-guide-libssl-introduction.7]=man7/ossl-guide-libssl-introduction.pod
+DEPEND[html/man7/ossl-guide-migration.html]=man7/ossl-guide-migration.pod
+GENERATE[html/man7/ossl-guide-migration.html]=man7/ossl-guide-migration.pod
+DEPEND[man/man7/ossl-guide-migration.7]=man7/ossl-guide-migration.pod
+GENERATE[man/man7/ossl-guide-migration.7]=man7/ossl-guide-migration.pod
 DEPEND[html/man7/ossl-guide-quic-client-block.html]=man7/ossl-guide-quic-client-block.pod
 DEPEND[html/man7/ossl-guide-quic-client-block.html]=man7/ossl-guide-quic-client-block.pod
 GENERATE[html/man7/ossl-guide-quic-client-block.html]=man7/ossl-guide-quic-client-block.pod
 GENERATE[html/man7/ossl-guide-quic-client-block.html]=man7/ossl-guide-quic-client-block.pod
 DEPEND[man/man7/ossl-guide-quic-client-block.7]=man7/ossl-guide-quic-client-block.pod
 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 \
 html/man7/life_cycle-mac.html \
 html/man7/life_cycle-mac.html \
 html/man7/life_cycle-pkey.html \
 html/man7/life_cycle-pkey.html \
 html/man7/life_cycle-rand.html \
 html/man7/life_cycle-rand.html \
-html/man7/migration_guide.html \
 html/man7/openssl-core.h.html \
 html/man7/openssl-core.h.html \
 html/man7/openssl-core_dispatch.h.html \
 html/man7/openssl-core_dispatch.h.html \
 html/man7/openssl-core_names.h.html \
 html/man7/openssl-core_names.h.html \
@@ -4998,6 +4997,7 @@ html/man7/ossl-guide-introduction.html \
 html/man7/ossl-guide-libcrypto-introduction.html \
 html/man7/ossl-guide-libcrypto-introduction.html \
 html/man7/ossl-guide-libraries-introduction.html \
 html/man7/ossl-guide-libraries-introduction.html \
 html/man7/ossl-guide-libssl-introduction.html \
 html/man7/ossl-guide-libssl-introduction.html \
+html/man7/ossl-guide-migration.html \
 html/man7/ossl-guide-quic-client-block.html \
 html/man7/ossl-guide-quic-client-block.html \
 html/man7/ossl-guide-quic-introduction.html \
 html/man7/ossl-guide-quic-introduction.html \
 html/man7/ossl-guide-tls-client-block.html \
 html/man7/ossl-guide-tls-client-block.html \
@@ -5124,7 +5124,6 @@ man/man7/life_cycle-kdf.7 \
 man/man7/life_cycle-mac.7 \
 man/man7/life_cycle-mac.7 \
 man/man7/life_cycle-pkey.7 \
 man/man7/life_cycle-pkey.7 \
 man/man7/life_cycle-rand.7 \
 man/man7/life_cycle-rand.7 \
-man/man7/migration_guide.7 \
 man/man7/openssl-core.h.7 \
 man/man7/openssl-core.h.7 \
 man/man7/openssl-core_dispatch.h.7 \
 man/man7/openssl-core_dispatch.h.7 \
 man/man7/openssl-core_names.h.7 \
 man/man7/openssl-core_names.h.7 \
@@ -5137,6 +5136,7 @@ man/man7/ossl-guide-introduction.7 \
 man/man7/ossl-guide-libcrypto-introduction.7 \
 man/man7/ossl-guide-libcrypto-introduction.7 \
 man/man7/ossl-guide-libraries-introduction.7 \
 man/man7/ossl-guide-libraries-introduction.7 \
 man/man7/ossl-guide-libssl-introduction.7 \
 man/man7/ossl-guide-libssl-introduction.7 \
+man/man7/ossl-guide-migration.7 \
 man/man7/ossl-guide-quic-client-block.7 \
 man/man7/ossl-guide-quic-client-block.7 \
 man/man7/ossl-guide-quic-introduction.7 \
 man/man7/ossl-guide-quic-introduction.7 \
 man/man7/ossl-guide-tls-client-block.7 \
 man/man7/ossl-guide-tls-client-block.7 \

+ 3 - 3
doc/man7/fips_module.pod

@@ -42,7 +42,7 @@ EC_KEY_METHOD_new(), etc.)
 =back
 =back
 
 
 All of the above APIs are deprecated in OpenSSL 3.0 - so a simple rule is to
 All of the above APIs are deprecated in OpenSSL 3.0 - so a simple rule is to
-avoid using all deprecated functions. See L<migration_guide(7)> for a list of
+avoid using all deprecated functions. See L<ossl-guide-migration(7)> for a list of
 deprecated functions.
 deprecated functions.
 
 
 =head2 Making all applications use the FIPS module by default
 =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
 code using the default context by accident will fail because no algorithms will
 code using the default context by accident will fail because no algorithms will
 be available.
 be available.
 
 
-See L<migration_guide(7)/Library Context> for additional information about the
+See L<ossl-guide-migration(7)/Library Context> for additional information about the
 Library Context.
 Library Context.
 
 
 =head2 Using Encoders and Decoders with the FIPS module
 =head2 Using Encoders and Decoders with the FIPS module
@@ -500,7 +500,7 @@ want to operate in a FIPS approved manner.  The algorithms are:
 
 
 =head1 SEE ALSO
 =head1 SEE ALSO
 
 
-L<migration_guide(7)>, L<crypto(7)>, L<fips_config(5)>,
+L<ossl-guide-migration(7)>, L<crypto(7)>, L<fips_config(5)>,
 L<https://www.openssl.org/source/>
 L<https://www.openssl.org/source/>
 
 
 =head1 HISTORY
 =head1 HISTORY

+ 2 - 0
doc/man7/ossl-guide-introduction.pod

@@ -81,6 +81,8 @@ The pages in the guide are as follows:
 
 
 =item L<ossl-guide-quic-client-block(7)>: Writing a simple blocking QUIC client
 =item L<ossl-guide-quic-client-block(7)>: Writing a simple blocking QUIC client
 
 
+=item L<ossl-guide-migration(7)>: Migrating from older OpenSSL versions
+
 =back
 =back
 
 
 =head1 COPYRIGHT
 =head1 COPYRIGHT

+ 2 - 1
doc/man7/migration_guide.pod → doc/man7/ossl-guide-migration.pod

@@ -2,7 +2,8 @@
 
 
 =head1 NAME
 =head1 NAME
 
 
-migration_guide - OpenSSL migration guide
+ossl-guide-migration, migration_guide
+- OpenSSL Guide: Migrating from older OpenSSL versions
 
 
 =head1 SYNOPSIS
 =head1 SYNOPSIS