diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-10-22 00:24:23 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-10-22 00:35:07 -0700 |
| commit | 99dbf7534681cc397801cd7bb73469729cde92fa (patch) | |
| tree | c89dcefcd2959bd7347d27e1caf39ce5420f27ce | |
| parent | fe0f89970af83642616dd041292a6711bc9f2eb9 (diff) | |
| download | nng-99dbf7534681cc397801cd7bb73469729cde92fa.tar.gz nng-99dbf7534681cc397801cd7bb73469729cde92fa.tar.bz2 nng-99dbf7534681cc397801cd7bb73469729cde92fa.zip | |
docs: move migration docs into book
| -rw-r--r-- | README.md | 4 | ||||
| -rw-r--r-- | docs/ref/SUMMARY.md | 5 | ||||
| -rw-r--r-- | docs/ref/migrate/index.md | 7 | ||||
| -rw-r--r-- | docs/ref/migrate/nanomsg.md (renamed from docs/migrating/nanomsg.md) | 0 | ||||
| -rw-r--r-- | docs/ref/migrate/nng1.md (renamed from docs/migrating/nng1.md) | 4 |
5 files changed, 16 insertions, 4 deletions
@@ -20,7 +20,7 @@ Please see [here](UKRAINE.md) for an important message for the people of Russia. > for the latest stable release. > > As a major release, there are some breaking API changes, -> but a [migration guide](docs/migrating/nng1.md) is +> but a [migration guide](docs/ref/migrate/nng1.md) is > available to help with migrating from NNG 1.x. > [!NOTE] @@ -186,7 +186,7 @@ These are located in the `demo` directory. ## Legacy Compatibility Migration from `libnanomsg` APIs is fairly straight-forward for most applications. -A [migration guide](docs/migrating/nanomsg.md) is available to assist. +A [migration guide](docs/ref/migrate/nanomsg.md) is available to assist. ## Commercial Support diff --git a/docs/ref/SUMMARY.md b/docs/ref/SUMMARY.md index dabdcf1f..9cb0de6a 100644 --- a/docs/ref/SUMMARY.md +++ b/docs/ref/SUMMARY.md @@ -55,4 +55,9 @@ - [BSD Socket (Experimental)](./tran/socket.md) - [UDP Transport (Experimental)](./tran/udp.md) +- [Migration Guides](./migrate/index.md) + + - [Migrating from NNG 1.x](./migrate/nng1.md) + - [Migrating from libnanomsg](./migrate/nanomsg.md) + [Index](./indexing.md) diff --git a/docs/ref/migrate/index.md b/docs/ref/migrate/index.md new file mode 100644 index 00000000..29d2d893 --- /dev/null +++ b/docs/ref/migrate/index.md @@ -0,0 +1,7 @@ +# Migration Guides + +This section provides some guides to aid in migrating software from +earlier versions _NNG_ or _libnanomsg_. + +- [Migrating from NNG 1.x](./migrate/nng1.md) +- [Migrating from libnanomsg](./migrate/nanomsg.md) diff --git a/docs/migrating/nanomsg.md b/docs/ref/migrate/nanomsg.md index e4c7b184..e4c7b184 100644 --- a/docs/migrating/nanomsg.md +++ b/docs/ref/migrate/nanomsg.md diff --git a/docs/migrating/nng1.md b/docs/ref/migrate/nng1.md index 9da86d48..6cf605f3 100644 --- a/docs/migrating/nng1.md +++ b/docs/ref/migrate/nng1.md @@ -5,8 +5,8 @@ This guide should help in migrating applications to use NNG 2.0. ## Nanomsg Compatibility -Applications using the legacy `libnanomsg` API will have to be updated to native NNG interfaces. -See the [Migration Guide for libnanomsg](nanomsg.md) for details. +Applications using the legacy `libnanomsg` API will have to be updated to native _NNG_ interfaces. +See the [Migrating From libnanomsg](nanomsg.md) chapter for details. ## Transport Specific Functions |