Page MenuHomeFreeBSD

packages.7: New manpage describing pkgbase
ClosedPublic

Authored by ivy on Sat, Sep 20, 8:06 PM.
Tags
None
Referenced Files
Unknown Object (File)
Fri, Oct 10, 10:36 PM
Unknown Object (File)
Fri, Oct 10, 5:21 AM
Unknown Object (File)
Fri, Oct 10, 5:21 AM
Unknown Object (File)
Fri, Oct 10, 5:21 AM
Unknown Object (File)
Fri, Oct 10, 5:21 AM
Unknown Object (File)
Thu, Oct 9, 11:54 PM
Unknown Object (File)
Thu, Oct 9, 8:23 PM
Unknown Object (File)
Thu, Oct 9, 7:50 PM

Details

Summary

This covers the basic structure of pkgbase, how packages are
distributed, how package sets work, and provides a few example
of actually using pkgbase.

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

ivy requested review of this revision.Sat, Sep 20, 8:06 PM

include the full license text in the file (this is my preference now for files i create)

grahamperrin added inline comments.
share/man/man7/packages.7
21 ↗(On Diff #162490)

I'm not convinced that this is a good name for the page.

26 ↗(On Diff #162490)

FreeBSD operating system

28 ↗(On Diff #162490)
29–31 ↗(On Diff #162490)
33 ↗(On Diff #162490)
38 ↗(On Diff #162490)
40 ↗(On Diff #162490)

The name FreeBSD could be troublesome, but I don't see a need for this level of detail in the page.

43 ↗(On Diff #162490)
45 ↗(On Diff #162490)
51 ↗(On Diff #162490)

There's markup for URLs, I forget the syntax.

53 ↗(On Diff #162490)

ENs and SAs are not limited to release (RELEASE).

61–62 ↗(On Diff #162490)

I suggest not using the phrase subpackages.

102 ↗(On Diff #162490)

What's meant by core, here?

129 ↗(On Diff #162490)

In at least one other context, base seems to mean something less than a full set of packages.

share/man/man7/packages.7
41–43 ↗(On Diff #162490)

--repository is an option in contexts such as pkg-install(8), but not pkg(8).

So is this the place to document the config files you need to fetch a custom repo?
Or what the distdir settings are for -current and -stable and how to get releases?
Or that if you pkg install all these things, you still need to do some flavoring to the system (fstab, rc.conf, loader.conf and a few others)

share/man/man7/packages.7
21 ↗(On Diff #162490)

"man pkgbase" is what I'd reach for first.

82 ↗(On Diff #162490)

I thought you told me it was the default was to split on irc lately.

115 ↗(On Diff #162490)

One can use devd in jails. It's not a hardware support item. devmatch is a hardware support item, though. devd is a generic kernel event mechanism.

In D52644#1202936, @imp wrote:

So is this the place to document the config files you need to fetch a custom repo?

no, that's pkg(8).

Or what the distdir settings are for -current and -stable and how to get releases?

yes, that would be the place to document this, but i think the link to https://pkg.freebsd.org is sufficient here, the front page tells you what repository are available.

Or that if you pkg install all these things, you still need to do some flavoring to the system (fstab, rc.conf, loader.conf and a few others)

this is more about managing the installed system (with packages), it's not meant to cover the entire process of bringing up a new system. that should probably be documented in bsdinstall(8), if it isn't already.

share/man/man7/packages.7
21 ↗(On Diff #162490)

we don't want "pkgbase" to be the user-facing name of this feature. in a few years when dist sets are gone, no one is going to know what "pkgbase" is, it'll just be the base system (which happens to be distributed via packages).

I'm not convinced that this is a good name for the page.

please suggest another name.

26 ↗(On Diff #162490)

is there precedent for this? i grepped existing uses of .Fx and found very few instances of "The .Fx operating syste".

41–43 ↗(On Diff #162490)

yes, but it can be used with pkg(8). for example, with "pkg upgrade", which is part of pkg(8).

82 ↗(On Diff #162490)

no, it was the default until recently when i turned it off. that change is in both stable/15 and main, and we don't care about unsupported stable/14 pkgbase for this manpage.

115 ↗(On Diff #162490)

you can use it in a jail, but it is "not typically required for jails", so it's not included in the minimal-jail set.

if you want to change what's in minimal-jail, let's do that elsewhere and i will update this manpage after we change it.

grahamperrin added inline comments.
share/man/man7/packages.7
21 ↗(On Diff #162490)
Possible names for the manual page

My first thought was pkgbase. With that, understandably, to be avoided, my second thought was …


base

If 7 will be the section, then
base(7) is non-existent in the FreeBSD ports collection,
https://man.freebsd.org/cgi/man.cgi?query=base&sektion=7&manpath=freebsd-ports 👍

So, future FreeBSD URLs:

https://man.freebsd.org/cgi/man.cgi?query=base&sektion=7&manpath=freebsd-current
https://man.freebsd.org/cgi/man.cgi?query=base&sektion=7&manpath=freebsd-stable
https://man.freebsd.org/cgi/man.cgi?query=base&sektion=7&manpath=freebsd.

The word base is arguably way too generic, so my third thought is …


freebsd-base

This revision now requires changes to proceed.Mon, Sep 22, 1:13 AM

I like base way better than packages, which has the sane issues as pkgbase, and it's too generic.

share/man/man7/packages.7
78 ↗(On Diff #162490)

Why dg here? Other man pages don't really do that, so why here?

82 ↗(On Diff #162490)

Yea, that's probably a mistake. man pages are the first thing people reach for to limit space on systems...

share/man/man7/packages.7
82 ↗(On Diff #162490)

a full set of manpages for the base system is 17MB, so those people might be looking in the wrong place. but you can prevent manpages being installed using pkg -oFILES_IGNORE_GLOB=/usr/share/man/*, so there's really no need to force everyone else to install twice as many packages just for that.

share/man/man7/packages.7
82 ↗(On Diff #162490)

17MB is a huge savings in an important savings when you are making images in the 100-200MB...

And that workaround on seems to work sometimes.... and needs to remove the man pages under openssl and others...

115 ↗(On Diff #162490)

I'm also objecting to characterizing devd being for hardware configuration..

I'd like to remind everyone that ALPHA3 is out with absolutely no documentation whatsoever.

cperciva added a subscriber: cperciva.

I would lean in favour of this being freebsd-base.7 with an MLINK to pkgbase.7, and the text about pkg.freebsd.org will need to change (that's not where releases and security updates to them are going to be hosted), but I'm inclined to agree with @ziaee that it's better to get something into the tree ASAP and tweak it later.

@ivy Commit this whenever you consider it ready. Approved by: re (cperciva).

This revision was not accepted when it landed; it landed in state Needs Revision.Thu, Sep 25, 7:05 PM
This revision was automatically updated to reflect the committed changes.