[MacPorts] #64329: guide and portfile man page: document missing keywords (was: guide: document newer keywords: installs_libs, etc)

MacPorts noreply at macports.org
Sat Jan 1 18:57:31 UTC 2022


#64329: guide and portfile man page: document missing keywords
--------------------------+----------------------
  Reporter:  mascguy      |      Owner:  mascguy
      Type:  enhancement  |     Status:  assigned
  Priority:  Normal       |  Milestone:
 Component:  guide        |    Version:
Resolution:               |   Keywords:
      Port:               |
--------------------------+----------------------
Changes (by mascguy):

 * status:  new => assigned
 * owner:  (none) => mascguy


Old description:

> While our MacPorts Guide is quite extensive, there are a few portfile
> keywords missing. And while many have previously been identified in
> tickets, there are still a few that have not.
>
> One such keyword is `installs_libs`.
>
> Of note, there are open tickets covering other keywords/areas. And the
> goal of this ticket is to identify items not brought up previously:
>
> * issue:62952 - Document master_site_local, patch_site_local,
> archive_site_local in guide
> * issue:59640 - Docs: keyword "known_fail" seems undocumented
> * issue:56036 - Keyword use_dmg is not documented in guide and portfile
> * issue:39083 - Add information about configure.sdkroot and
> configure.macosx_deployment_target
> * issue:38440 - Document add_users

New description:

 While our MacPorts Guide is quite extensive, there are a few portfile
 keywords missing. And while many have previously been identified in
 tickets, there are still a few that have not.

 Per @jmroot, some items are documented via the man page for `portfile`.
 And for those that are, we can update the guide with that info. Two such
 cases are:

 * `installs_libs`
 * `add_users` - issue:38440

 Some others are missing from both:

 * `master_site_local`, `patch_site_local`, `archive_site_local` -
 issue:62952
 * `known_fail` - issue:59640
 * `use_dmg` - issue:56036
 * `configure.sdkroot`, `configure.macosx_deployment_target` - issue:39083

--

Comment:

 Replying to [comment:1 jmroot]:
 > There is documentation for installs_libs in the portfile man page.

 Indeed there is, along with detail for `add_users`. That makes things
 easier, as we can reconcile from the man page, when possible.

 Thanks for the heads-up Josh!

-- 
Ticket URL: <https://trac.macports.org/ticket/64329#comment:2>
MacPorts <https://www.macports.org/>
Ports system for macOS


More information about the macports-tickets mailing list