Page MenuHomeFreeBSD

etcupdate.8: Cross-reference build(7)
Needs ReviewPublic

Authored by temcbun_gmail.com on Mon, Jun 1, 11:06 AM.
Referenced Files
F159152208: D57382.diff
Wed, Jun 10, 4:50 PM
Unknown Object (File)
Mon, Jun 8, 11:58 AM
Unknown Object (File)
Mon, Jun 8, 8:06 AM
Unknown Object (File)
Mon, Jun 8, 8:03 AM
Unknown Object (File)
Sun, Jun 7, 8:35 PM
Unknown Object (File)
Sun, Jun 7, 8:24 PM
Unknown Object (File)
Sun, Jun 7, 8:12 PM
Unknown Object (File)
Sun, Jun 7, 5:41 PM
Subscribers

Details

Summary

Without this reference it may not be clear to the reader what installworld means.

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

usr.sbin/etcupdate/etcupdate.8
85–92

Are you familiar with the term code smell? It means it's not exactly incorrect but it's a sign it could be written better. I think of parentheticals like this, that they are a tacked on amendment to the sentence and not the clearest way to write. What do you think of this?

usr.sbin/etcupdate/etcupdate.8
85–92

Do we need to note somewhere pkg auto merges?

usr.sbin/etcupdate/etcupdate.8
85–92

I would love that. it could be a lot clearer specifying when you actually need to use this, and for pkg based updates you search for .pkgnew by hand iiuc.

usr.sbin/etcupdate/etcupdate.8
85–92

I will put this in pkgbase.7

usr.sbin/etcupdate/etcupdate.8
85–92

Pkgnew is only for conflicts.

See pkgbase(7) if for pkg updates.

Or similar maybe?

Better integrate .Xr into the sentence (suggestion by @ziaee).

I'm not sure about documenting pkg things here - I don't have much experience with that. Maybe this should be done in a separate commit?

usr.sbin/etcupdate/etcupdate.8
88

This has lost the make installworld detail, and it's not the *build* that you care about at all, it's the *install of that build and method of doing so*. This is particularly relevant for pkgbase; the current wording is correct with respect to pkgbase, but this wording is not. That is, consider that you are building your own pkgbase packages from source. That's still a build from source, and update-packages is documented in build(7), but your wording would imply that etcupdate is used for that case, when it isn't.

Also I think, due to the use of "*the base system*", the proposed wording makes it less obvious that, if you're doing an installworld to a system that's not the currently-running one, you can do the etcupdate from the current host rather than needing to boot the system being updated.