nortti
/
sortix-mirror
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
sortix-mirror/share/man/man7/upgrade.7

155 lines
5.0 KiB
Groff
Raw Normal View History

Fix date format in manual pages.
2017-06-03 19:27:30 +00:00
.Dd January 5, 2016
Add sysinstall(8), sysmerge(8), and sysupgrade(8).
2016-02-18 21:16:02 +00:00
.Dt UPGRADE 7
.Os
.Sh NAME
.Nm upgrade
.Nd operating system upgrade instructions
.Sh DESCRIPTION
This document describes how to upgrade an existing Sortix installation to a
Correct manpage spacing per roff(7) convention. roff(7) dictates that "Each sentence should terminate at the end of an input line." Instead of doing this, Sortix manpages (incorrectly) used double-spaces to separate sentences. Additionally, fix a few small typos.
2017-02-15 21:56:28 +00:00
newer release.
The
Add sysinstall(8), sysmerge(8), and sysupgrade(8).
2016-02-18 21:16:02 +00:00
.Xr installation 7
manual page covers creating a new installation.
.Ss Prerequisites
You need to prepare a bootable medium with the new release as described in
.Xr installation 7 .
Read all the instructions up to Bootloader Menu and continue with this document.
.Pp
Correct manpage spacing per roff(7) convention. roff(7) dictates that "Each sentence should terminate at the end of an input line." Instead of doing this, Sortix manpages (incorrectly) used double-spaces to separate sentences. Additionally, fix a few small typos.
2017-02-15 21:56:28 +00:00
It is not possible to skip releases.
If you want to upgrade to a release, you must upgrade first to all releases
before that one.
If the existing installation is a development snapshot, you must either upgrade
to a newer development snapshot of that version, or a the final release of that
version.
Add support for modifying release iso images.
2018-03-30 21:44:12 +00:00
.Ss Release .iso Modification
Fix typos in hier(7), installation(7), and upgrade(7).
2022-01-10 13:20:30 +00:00
Optionally, you might want to modify a release .iso to meet your custom needs
per the instructions in
Add support for modifying release iso images.
2018-03-30 21:44:12 +00:00
.Xr release-iso-modification 7 .
.Pp
The release modification procedure lets you customize aspects such as the
default bootloader menu option and timeout, the default hostname, the default
keyboard layout, the default graphics resolution, adding files of your choice to
Add networking stack. This change adds all the kernel parts of a network stack. The network stack is partial but implements many of the important parts. Add if(4) network interface abstraction. Network interfaces are registered in a global list that can be iterated and each assigned an unique integer identifier. Add reference counted packets with a cache that recycles recent packets. Add support for lo(4) loopback and ether(4) ethernet network interfaces. The /dev/lo0 loopback device is created automatically on boot. Add arp(4) address resolution protocol driver for translation of inet(4) network layer addresses into ether(4) link layer addresses. arp(4) entries are cached and evicted from the cache when needed or when the entry has not been used for a while. The cache is limited to 256 entries for now. Add ip(4) internet protocol version 4 support. IP fragmentation and options are not implemented yet. Add tcp(4) transmission control protocol sockets for a reliable transport layer protocol that provides a reliable byte stream connection between two hosts. The implementation is incomplete and does not yet implement out of band data, options, and high performance extensions. Add udp(4) user datagram protocol sockets for a connectionless transport layer that provides best-effort delivery of datagrams. Add ping(4) sockets for a best-effort delivery of echo datagrams. Change type of sa_family_t from unsigned short to uint16_t. Add --disable-network-drivers to the kernel(7) options and expose it with a bootloader menu. tix-iso-bootconfig can set this option by default. Import CRC32 code from libz for the Ethernet checksum. This is a compatible ABI change that adds features to socket(2) (AF_INET, IPPROTO_TCP, IPPROTO_UDP, IPPROTO_PING), the ioctls for if(4), socket options, and the lo0 loopback interface. This commit is based on work by Meisaka Yukara contributed as the commit bbf7f1e8a5238a2bd1fe8eb1d2cc5c9c2421e2c4. Almost no lines of this work remains in this final commit as it has been rewritten or refactored away over the years, see the individual file headers for which files contain remnants of this work. Co-authored-by: Meisaka Yukara <Meisaka.Yukara@gmail.com>
2022-12-04 23:35:21 +00:00
the live environment, control which drivers are loaded by default, and so on.
Add support for modifying release iso images.
2018-03-30 21:44:12 +00:00
.Pp
Warning: The live environment does not come with any random entropy and entropy
gathering is not yet implemented.
To keep your system secure, it is recommended to use the release modification
procedure to add a
.Pa /boot/random.seed
file to the release .iso in order to securely seed the cryptographically secure
pseudorandom number generator.
Add sysinstall(8), sysmerge(8), and sysupgrade(8).
2016-02-18 21:16:02 +00:00
.Ss Bootloader Menu
Pick the
.Li upgrade existing installation
Correct manpage spacing per roff(7) convention. roff(7) dictates that "Each sentence should terminate at the end of an input line." Instead of doing this, Sortix manpages (incorrectly) used double-spaces to separate sentences. Additionally, fix a few small typos.
2017-02-15 21:56:28 +00:00
option in the bootloader menu to begin the upgrade.
This will load a live environment set to automatically run the
Add sysinstall(8), sysmerge(8), and sysupgrade(8).
2016-02-18 21:16:02 +00:00
.Xr sysupgrade 8
program.
.Ss Upgrader
Correct manpage spacing per roff(7) convention. roff(7) dictates that "Each sentence should terminate at the end of an input line." Instead of doing this, Sortix manpages (incorrectly) used double-spaces to separate sentences. Additionally, fix a few small typos.
2017-02-15 21:56:28 +00:00
This guide assumes you selected the upgrade option in the bootloader.
If not, you can run the installer by running the
Add sysinstall(8), sysmerge(8), and sysupgrade(8).
2016-02-18 21:16:02 +00:00
.Xr sysupgrade 8
command.
.Pp
The upgrader is an interactive command line program that asks you questions and
Correct manpage spacing per roff(7) convention. roff(7) dictates that "Each sentence should terminate at the end of an input line." Instead of doing this, Sortix manpages (incorrectly) used double-spaces to separate sentences. Additionally, fix a few small typos.
2017-02-15 21:56:28 +00:00
you answer them.
It provides useful information you shouldn't accidentally overlook.
Before answering any question, read all output since your last answer.
Add sysinstall(8), sysmerge(8), and sysupgrade(8).
2016-02-18 21:16:02 +00:00
.Pp
Correct manpage spacing per roff(7) convention. roff(7) dictates that "Each sentence should terminate at the end of an input line." Instead of doing this, Sortix manpages (incorrectly) used double-spaces to separate sentences. Additionally, fix a few small typos.
2017-02-15 21:56:28 +00:00
You should have this upgrade guide ready at all times.
You can view this
Add sysinstall(8), sysmerge(8), and sysupgrade(8).
2016-02-18 21:16:02 +00:00
.Xr upgrade 7
page during the installation by answering
.Sy '!man'
Correct manpage spacing per roff(7) convention. roff(7) dictates that "Each sentence should terminate at the end of an input line." Instead of doing this, Sortix manpages (incorrectly) used double-spaces to separate sentences. Additionally, fix a few small typos.
2017-02-15 21:56:28 +00:00
to any regular prompt (excluding password prompts).
Likewise you can answer
Add sysinstall(8), sysmerge(8), and sysupgrade(8).
2016-02-18 21:16:02 +00:00
.Sy '!'
Correct manpage spacing per roff(7) convention. roff(7) dictates that "Each sentence should terminate at the end of an input line." Instead of doing this, Sortix manpages (incorrectly) used double-spaces to separate sentences. Additionally, fix a few small typos.
2017-02-15 21:56:28 +00:00
to get an interactive shell.
Upon completion, you will be asked the question again.
Add sysinstall(8), sysmerge(8), and sysupgrade(8).
2016-02-18 21:16:02 +00:00
.Ss Keyboard Layout
Correct manpage spacing per roff(7) convention. roff(7) dictates that "Each sentence should terminate at the end of an input line." Instead of doing this, Sortix manpages (incorrectly) used double-spaces to separate sentences. Additionally, fix a few small typos.
2017-02-15 21:56:28 +00:00
You need to choose the applicable keyboard layout.
By default, a standard US keyboard layout is used.
You can view a list of keyboard layouts if you wish.
Add sysinstall(8), sysmerge(8), and sysupgrade(8).
2016-02-18 21:16:02 +00:00
.Ss Display Resolution
If a driver exists for your graphics card, then you will be asked for your
preferred display resolution by
.Xr chvideomode 1 .
.Ss Installation Search
The upgrader will search for existing Sortix installations by probing local
filesystems for
.Pa /etc/sortix-release .
Correct manpage spacing per roff(7) convention. roff(7) dictates that "Each sentence should terminate at the end of an input line." Instead of doing this, Sortix manpages (incorrectly) used double-spaces to separate sentences. Additionally, fix a few small typos.
2017-02-15 21:56:28 +00:00
You will be asked which installation you wish to upgrade.
Enter the name of the root filesystem device.
If none are found, it asks if you want to run
.Xr sysinstall 8 .
Filesystems will be repaired by
Add sysinstall(8), sysmerge(8), and sysupgrade(8).
2016-02-18 21:16:02 +00:00
.Xr fsck 8
as needed.
.Ss Confirmation
The upgrader will warn you if it detects you are not following proper upgrade
procedure either by downgrading or by skipping a release, neither of which is
Correct manpage spacing per roff(7) convention. roff(7) dictates that "Each sentence should terminate at the end of an input line." Instead of doing this, Sortix manpages (incorrectly) used double-spaces to separate sentences. Additionally, fix a few small typos.
2017-02-15 21:56:28 +00:00
supported.
It will also warn you if it detects an ABI downgrade.
Add sysinstall(8), sysmerge(8), and sysupgrade(8).
2016-02-18 21:16:02 +00:00
.Pp
The upgrade will load the upgrade preferences from
.Pa /etc/upgrade.conf
file of the target system as described in
.Xr upgrade.conf 5 .
.Pp
Correct manpage spacing per roff(7) convention. roff(7) dictates that "Each sentence should terminate at the end of an input line." Instead of doing this, Sortix manpages (incorrectly) used double-spaces to separate sentences. Additionally, fix a few small typos.
2017-02-15 21:56:28 +00:00
The new release may have a new ABI.
A major ABI change means the new kernel will be unable to properly execute old
programs.
A minor ABI change means the new kernel has new compatible features and will be
able to run older programs, but older kernels will not be able to run programs
using the new ABI.
Add sysinstall(8), sysmerge(8), and sysupgrade(8).
2016-02-18 21:16:02 +00:00
.Pp
A confirmation screen will tell you what actions the upgrader plan on doing.
Answer
.Sy yes
Correct manpage spacing per roff(7) convention. roff(7) dictates that "Each sentence should terminate at the end of an input line." Instead of doing this, Sortix manpages (incorrectly) used double-spaces to separate sentences. Additionally, fix a few small typos.
2017-02-15 21:56:28 +00:00
to proceed with the upgrade.
Otherwise you can escape to a shell, edit
Add sysinstall(8), sysmerge(8), and sysupgrade(8).
2016-02-18 21:16:02 +00:00
.Xr upgrade.conf 5 ,
return and answer
.Sy no
and the upgrader will reload the configuration.
.Ss Upgrade
The upgrader will take the appropriate actions:
.Pp
.Bl -bullet -compact
.It
Fix sysinstall hook markers not being installed and prefix logic. Document the compatibility hooks behavior while here.
2020-12-27 21:32:04 +00:00
Running any upgrade hooks needed to migrate the installation across incompatible
changes.
.It
Add sysinstall(8), sysmerge(8), and sysupgrade(8).
2016-02-18 21:16:02 +00:00
Updating the system.
.It
Fix system upgrade leaking files.
2021-01-18 23:04:56 +00:00
Updating the ports, installing any new ports, and removing any ports that
don't exist anymore or weren't loaded.
Add sysinstall(8), sysmerge(8), and sysupgrade(8).
2016-02-18 21:16:02 +00:00
.It
Updating the source code.
.It
Updating the initrd.
.It
Updating the bootloader.
.El
.Ss Completion
Correct manpage spacing per roff(7) convention. roff(7) dictates that "Each sentence should terminate at the end of an input line." Instead of doing this, Sortix manpages (incorrectly) used double-spaces to separate sentences. Additionally, fix a few small typos.
2017-02-15 21:56:28 +00:00
The upgrade is now complete.
The new system will run after a reboot.
The upgrader will give you an overview of what it has done.
If you upgraded across a major ABI change, then you will be told that you need
to recompile all local programs to use the new ABI.
Add sysinstall(8), sysmerge(8), and sysupgrade(8).
2016-02-18 21:16:02 +00:00
.Pp
Congratulations on your freshly upgraded Sortix system.
.Sh SEE ALSO
.Xr chkblayout 1 ,
.Xr chvideomode 1 ,
.Xr man 1 ,
.Xr development 7 ,
.Xr initrd 7 ,
.Xr installation 7 ,
.Xr kernel 7 ,
.Xr user-guide 7 ,
.Xr sysinstall 8 ,
.Xr sysupgrade 8 ,
.Xr update-grub 8 ,
.Xr update-initrd 8