Bug 250834

Summary: pkg-create(8) description of manifest file is outdated
Product: Documentation Reporter: Piotr M. <pfm>
Component: Manual PagesAssignee: freebsd-pkg (Nobody) <pkg>
Status: Open ---    
Severity: Affects Some People CC: doc, lwhsu, pkg
Priority: --- Flags: linimon: maintainer-feedback? (pkg)
Version: Latest   
Hardware: Any   
OS: Any   

Description Piotr M. 2020-11-03 18:47:43 UTC
Manual page for the pkg-create utility (https://www.freebsd.org/cgi/man.cgi?pkg%2Dcreate) describes +MANIFEST file details, but it mentions a 'file' clause, while it should be 'files' followed by a collection of files enclosed in braces, as described on Microsoft Github project page of pkg utility (see section "Manifest": https://github.com/freebsd/pkg#manifest).

In my opinion, "MANIFEST FILE DETAILS" section of the manual page could start with at least one sentence of introduction, like:

> +MANIFEST file uses UCL, the Universal Configuration Language. See an example in the EXAMPLES section.

And then, I would introduce an "EXAMPLES" section like in many other FreeBSD manual pages, just copy-pasting the example from Microsoft Github page linked above.

Wiki page https://wiki.freebsd.org/pkgng is also outdated and suggests that +MANIFEST is a YAML file.