Bug 233697 - Porter's handbook: Makes clearer the official ordering for plist
Summary: Porter's handbook: Makes clearer the official ordering for plist
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Books & Articles (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Only Me
Assignee: Fernando Apesteguía
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2018-12-01 19:17 UTC by Lorenzo Salvadore
Modified: 2023-08-29 11:13 UTC (History)
1 user (show)

See Also:


Attachments
patch for official plist ordering (1.90 KB, patch)
2018-12-01 19:17 UTC, Lorenzo Salvadore
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Lorenzo Salvadore freebsd_committer freebsd_triage 2018-12-01 19:17:32 UTC
Created attachment 199720 [details]
patch for official plist ordering

It looks like there is an official ordering for plist's (some committers explicitly requested it), although it is only suggested and not required in the porter's handbook: my patch makes it clear that it is required and tries to explain it better.

Indeed the ordering is described by the handbook just as alphabetical and I thought that the "sort" command would generate it, but I was wrong: I was explained that the ordering must occur after variable expansion, not before, and that "make makeplist" can be used to generate it. I put those details in the patch.
Comment 1 Fernando Apesteguía freebsd_committer freebsd_triage 2023-08-29 06:55:39 UTC
https://reviews.freebsd.org/D41624
Comment 2 commit-hook freebsd_committer freebsd_triage 2023-08-29 11:12:04 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/doc/commit/?id=d7f4e2377f23909e8339567b6a09119630a49395

commit d7f4e2377f23909e8339567b6a09119630a49395
Author:     Fernando Apesteguía <fernape@FreeBSD.org>
AuthorDate: 2023-08-26 17:00:12 +0000
Commit:     Fernando Apesteguía <fernape@FreeBSD.org>
CommitDate: 2023-08-29 11:10:45 +0000

    [phb]: Clarify pkg-plist items order

    PR:             233697
    Reported by:    salvadore@
    Reviewed by:    carlavilla@, ceri@
    Differential Revision: https://reviews.freebsd.org/D41624

 .../content/en/books/porters-handbook/quick-porting/_index.adoc         | 2 ++
 1 file changed, 2 insertions(+)
Comment 3 Fernando Apesteguía freebsd_committer freebsd_triage 2023-08-29 11:13:18 UTC
Fixed.

Thanks!