Re: update sysupgrade manpage
There are plans to adapt sysupgrade for upgrading to arbitrary snapshots
from the archives, to help everyone do bisect.
When that comes, all these proposed changes will be backwards.
Otto Moerbeek wrote:
> On Mon, May 27, 2019 at 04:16:01AM +0200, giovani...@tuta.io wrote:
>
> > Hello,
> >
> > I tried to make sysupgrade man page more readable and fixed a small
> > mistake. The man page stated:
> >
> > > .It Fl s
> > > Upgrade to a snapshot.
> > > The default is to find out if the system is running a release or a
> > > snapshot.
> > > In case of release> .Nm
> > > downloads the next release.
> >
> > But if SNAP is set, even in release systems, sysupgrade targets snapshots:
>
> Yes, but the sentence describes the default beahviour as I read it.
> Your chanche is equally confusing, imo.
>
> I think it is better to move the description of the default behaviour
> to the start and only describe the non-default with the options.
>
> The rest of your changes I'll leave to a native speaker.
>
> -Otto
>
> >
> > > if $SNAP; then
> > > URL=${MIRROR}/snapshots/${ARCH}/
> > > else
> > > URL=${MIRROR}/${NEXT_VERSION}/${ARCH}/
> > > fi
> >
> > Here is the patch:
> >
> > Index: usr.sbin/sysupgrade/sysupgrade.8
> > ===
> > RCS file: /cvs/src/usr.sbin/sysupgrade/sysupgrade.8,v
> > retrieving revision 1.8
> > diff -u -p -u -p -r1.8 sysupgrade.8
> > --- usr.sbin/sysupgrade/sysupgrade.8 9 May 2019 21:09:37 - 1.8
> > +++ usr.sbin/sysupgrade/sysupgrade.8 27 May 2019 00:07:11 -
> > @@ -19,7 +19,7 @@
> > .Os
> > .Sh NAME
> > .Nm sysupgrade
> > -.Nd upgrade system to the next release or a new snapshot
> > +.Nd upgrade system to the next release or latest snapshot
> > .Sh SYNOPSIS
> > .Nm
> > .Op Fl fkn
> > @@ -29,7 +29,7 @@
> > .Nm
> > is a utility to upgrade
> > .Ox
> > -to the next release or a new snapshot if available.
> > +to the next release or latest snapshot, if available.
> > .Pp
> > .Nm
> > downloads the necessary files to
> > @@ -39,8 +39,9 @@ verifies them with
> > and copies bsd.rd to
> > .Pa /bsd.upgrade .
> > .Pp
> > +Then, by default,
> > .Nm
> > -by default then reboots the system.
> > +reboots the system.
> > The bootloader will automatically choose
> > .Pa /bsd.upgrade ,
> > triggering a one-shot upgrade using the files in
> > @@ -55,23 +56,22 @@ This option has no effect on releases.
> > .It Fl k
> > Keep the files in
> > .Pa /home/_sysupgrade .
> > -By default they will be deleted after the upgrade.
> > +By default, they are deleted after the upgrade.
> > .It Fl n
> > -Fetch and verify the files and create
> > -.Pa /bsd.upgrade
> > -but do not reboot.
> > +Do not reboot the system after creating
> > +.Pa /bsd.upgrade .
> > .It Fl r
> > Upgrade to the next release.
> > The default is to find out if the system is running a release or a
> > snapshot.
> > -In case of release
> > +In case of release,
> > .Nm
> > downloads the next release.
> > .It Fl s
> > Upgrade to a snapshot.
> > The default is to find out if the system is running a release or a
> > snapshot.
> > -In case of release
> > +In case of release,
> > .Nm
> > -downloads the next release.
> > +downloads the latest snapshot.
> > .El
> > .Sh FILES
> > .Bl -tag -width "/home/_sysupgrade" -compact
> >
> >
> >
>
Re: update sysupgrade manpage
On Mon, May 27, 2019 at 04:16:01AM +0200, giovani...@tuta.io wrote:
> Hello,
>
> I tried to make sysupgrade man page more readable and fixed a small mistake.
> The man page stated:
>
> > .It Fl s
> > Upgrade to a snapshot.
> > The default is to find out if the system is running a release or a snapshot.
> > In case of release> .Nm
> > downloads the next release.
>
> But if SNAP is set, even in release systems, sysupgrade targets snapshots:
Yes, but the sentence describes the default beahviour as I read it.
Your chanche is equally confusing, imo.
I think it is better to move the description of the default behaviour
to the start and only describe the non-default with the options.
The rest of your changes I'll leave to a native speaker.
-Otto
>
> > if $SNAP; then
> > URL=${MIRROR}/snapshots/${ARCH}/
> > else
> > URL=${MIRROR}/${NEXT_VERSION}/${ARCH}/
> > fi
>
> Here is the patch:
>
> Index: usr.sbin/sysupgrade/sysupgrade.8
> ===
> RCS file: /cvs/src/usr.sbin/sysupgrade/sysupgrade.8,v
> retrieving revision 1.8
> diff -u -p -u -p -r1.8 sysupgrade.8
> --- usr.sbin/sysupgrade/sysupgrade.8 9 May 2019 21:09:37 - 1.8
> +++ usr.sbin/sysupgrade/sysupgrade.8 27 May 2019 00:07:11 -
> @@ -19,7 +19,7 @@
> .Os
> .Sh NAME
> .Nm sysupgrade
> -.Nd upgrade system to the next release or a new snapshot
> +.Nd upgrade system to the next release or latest snapshot
> .Sh SYNOPSIS
> .Nm
> .Op Fl fkn
> @@ -29,7 +29,7 @@
> .Nm
> is a utility to upgrade
> .Ox
> -to the next release or a new snapshot if available.
> +to the next release or latest snapshot, if available.
> .Pp
> .Nm
> downloads the necessary files to
> @@ -39,8 +39,9 @@ verifies them with
> and copies bsd.rd to
> .Pa /bsd.upgrade .
> .Pp
> +Then, by default,
> .Nm
> -by default then reboots the system.
> +reboots the system.
> The bootloader will automatically choose
> .Pa /bsd.upgrade ,
> triggering a one-shot upgrade using the files in
> @@ -55,23 +56,22 @@ This option has no effect on releases.
> .It Fl k
> Keep the files in
> .Pa /home/_sysupgrade .
> -By default they will be deleted after the upgrade.
> +By default, they are deleted after the upgrade.
> .It Fl n
> -Fetch and verify the files and create
> -.Pa /bsd.upgrade
> -but do not reboot.
> +Do not reboot the system after creating
> +.Pa /bsd.upgrade .
> .It Fl r
> Upgrade to the next release.
> The default is to find out if the system is running a release or a snapshot.
> -In case of release
> +In case of release,
> .Nm
> downloads the next release.
> .It Fl s
> Upgrade to a snapshot.
> The default is to find out if the system is running a release or a snapshot.
> -In case of release
> +In case of release,
> .Nm
> -downloads the next release.
> +downloads the latest snapshot.
> .El
> .Sh FILES
> .Bl -tag -width "/home/_sysupgrade" -compact
>
>
>
update sysupgrade manpage
Hello,
I tried to make sysupgrade man page more readable and fixed a small mistake.
The man page stated:
> .It Fl s
> Upgrade to a snapshot.
> The default is to find out if the system is running a release or a snapshot.
> In case of release> .Nm
> downloads the next release.
But if SNAP is set, even in release systems, sysupgrade targets snapshots:
> if $SNAP; then
> URL=${MIRROR}/snapshots/${ARCH}/
> else
> URL=${MIRROR}/${NEXT_VERSION}/${ARCH}/
> fi
Here is the patch:
Index: usr.sbin/sysupgrade/sysupgrade.8
===
RCS file: /cvs/src/usr.sbin/sysupgrade/sysupgrade.8,v
retrieving revision 1.8
diff -u -p -u -p -r1.8 sysupgrade.8
--- usr.sbin/sysupgrade/sysupgrade.8 9 May 2019 21:09:37 - 1.8
+++ usr.sbin/sysupgrade/sysupgrade.8 27 May 2019 00:07:11 -
@@ -19,7 +19,7 @@
.Os
.Sh NAME
.Nm sysupgrade
-.Nd upgrade system to the next release or a new snapshot
+.Nd upgrade system to the next release or latest snapshot
.Sh SYNOPSIS
.Nm
.Op Fl fkn
@@ -29,7 +29,7 @@
.Nm
is a utility to upgrade
.Ox
-to the next release or a new snapshot if available.
+to the next release or latest snapshot, if available.
.Pp
.Nm
downloads the necessary files to
@@ -39,8 +39,9 @@ verifies them with
and copies bsd.rd to
.Pa /bsd.upgrade .
.Pp
+Then, by default,
.Nm
-by default then reboots the system.
+reboots the system.
The bootloader will automatically choose
.Pa /bsd.upgrade ,
triggering a one-shot upgrade using the files in
@@ -55,23 +56,22 @@ This option has no effect on releases.
.It Fl k
Keep the files in
.Pa /home/_sysupgrade .
-By default they will be deleted after the upgrade.
+By default, they are deleted after the upgrade.
.It Fl n
-Fetch and verify the files and create
-.Pa /bsd.upgrade
-but do not reboot.
+Do not reboot the system after creating
+.Pa /bsd.upgrade .
.It Fl r
Upgrade to the next release.
The default is to find out if the system is running a release or a snapshot.
-In case of release
+In case of release,
.Nm
downloads the next release.
.It Fl s
Upgrade to a snapshot.
The default is to find out if the system is running a release or a snapshot.
-In case of release
+In case of release,
.Nm
-downloads the next release.
+downloads the latest snapshot.
.El
.Sh FILES
.Bl -tag -width "/home/_sysupgrade" -compact
