[Bug 250834] pkg-create(8) description of manifest file is outdated

bugzilla-noreply at freebsd.org bugzilla-noreply at freebsd.org
Tue Nov 3 18:47:43 UTC 2020


https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=250834

            Bug ID: 250834
           Summary: pkg-create(8) description of manifest file is outdated
           Product: Documentation
           Version: Latest
          Hardware: Any
                OS: Any
            Status: New
          Severity: Affects Some People
          Priority: ---
         Component: Manual Pages
          Assignee: bugs at FreeBSD.org
          Reporter: pfm at wp.eu
                CC: doc at FreeBSD.org

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.

-- 
You are receiving this mail because:
You are on the CC list for the bug.


More information about the freebsd-doc mailing list