Page MenuHomeFreeBSD

Fix incorrect instructions in ezjail upgrading section of the jail handbook
ClosedPublic

Authored by allanjude on Mar 22 2015, 8:36 PM.

Details

Reviewers
eadler
wblock
bcr
Summary

Reported by https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=197804

ezjail-update -r does not exist

The instructions also fail to differentiate between a 'patch' and an 'upgrade'

Diff Detail

Repository
rD FreeBSD doc repository - subversion
Lint
No Linters Available
Unit
No Unit Test Coverage

Event Timeline

allanjude retitled this revision from to Fix incorrect instructions in ezjail upgrading section of the jail handbook.
allanjude updated this object.
allanjude edited the test plan for this revision. (Show Details)
allanjude added reviewers: bcr, wblock, eadler.
en_US.ISO8859-1/books/handbook/jails/chapter.xml
1319

One of the goals of this section was avoiding literal revision numbers because the document would become so quickly obsolete.

A version of the original wording can probably be used here.

It is also important to distinguish upgrading the basejail from the individual jails.

1323

Again, it is the basejail that is being upgraded. The description here should make it clear that the upgrade is to a new release rather than just the latest version of the installed release.

1329

"version to upgrade from" is awkward. Maybe "version currently installed in the basejail".

1331

"of &os;" is redundant.
Again, it's important to be precise in the difference between the basejail and the individual jails.

1337

<literal> on the literal release string.

Avoid "your": "to the current version installed on the host system"

Update with feedback from wblock

en_US.ISO8859-1/books/handbook/jails/chapter.xml
1318

The "for example" is a separate sentence (an aside, really), and should not be tacked onto the first.

1323

The rest of this section uses "update" rather than "upgrade".

Also, "between versions" is confusing. "to a new version", maybe?

1327

This "the blahblah utility" construct is not necessary. We don't say "use the cp utility to copy files", just "use cp to copy files".

&man.freebsd-update.8; has no way of determining

1328

which version is currently installed in the basejail, so the

1329

"as part of the command" is redundant. There is nowhere else to specify it.

1330

Use &man.file.1; to determine the original

1331

"that was installed" is not needed.

1337

<literal> on this 9.3-RELEASE

1340

<replaceable> on this 9.3-RELEASE, because this is the one the user is expected to replace when they type it.

1341–1342

Does this mergemaster step still apply to the added freebsd-update instructions?

allanjude added inline comments.
en_US.ISO8859-1/books/handbook/jails/chapter.xml
1341–1342

Yes, because the mergemaster step needs to be done on each jail, whereas freebsd-update is applied to the basejail

Updated with feedback from wblock

en_US.ISO8859-1/books/handbook/jails/chapter.xml
1318

Comma needed after "For example".

1342

How about "must be run" rather than "needs to be"?

Final revisions from wblock

wblock edited edge metadata.

Please build-test before commit.

This revision is now accepted and ready to land.May 29 2015, 7:27 PM