Opened 2 years ago

Last modified 7 weeks ago

#64329 assigned enhancement

guide and portfile man page: document missing keywords

Reported by: mascguy (Christopher Nielsen) Owned by: mascguy (Christopher Nielsen)
Priority: Normal Milestone:
Component: guide Version:
Keywords: Cc:
Port:

Description (last modified by mascguy (Christopher Nielsen))

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

Keywords documented in the man pages, but missing from the guide:

Keywords documented in the guide, but missing from the man pages:

Keywords missing from both:

Keywords needing additional work/clarification, before being documented:

Change History (21)

comment:1 Changed 2 years ago by jmroot (Joshua Root)

There is documentation for installs_libs in the portfile man page.

comment:2 Changed 2 years ago by mascguy (Christopher Nielsen)

Description: modified (diff)
Owner: set to mascguy
Status: newassigned
Summary: guide: document newer keywords: installs_libs, etcguide and portfile man page: document missing keywords

Replying to 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!

comment:3 Changed 8 months ago by mascguy (Christopher Nielsen)

Description: modified (diff)

Added two more to the list of items not documented at all: startupitem.user and startupitem.group.

comment:4 in reply to:  3 ; Changed 8 months ago by mascguy (Christopher Nielsen)

Replying to mascguy:

Added two more to the list of items not documented at all: startupitem.user and startupitem.group.

PR created, to document options startupitem.user/startupitem.group in the manpage for portfile:

PR 294 - manpages: portfile: add info for startupitem.user/startupitem.group

comment:5 Changed 8 months ago by mascguy (Christopher Nielsen)

Description: modified (diff)

comment:6 in reply to:  4 Changed 8 months ago by mascguy (Christopher Nielsen)

Replying to mascguy:

PR created, to document options startupitem.user/startupitem.group in the manpage for portfile:

PR 294 - manpages: portfile: document keywords startupitem.user/startupitem.group

Corresponding PR created, to update the MacPorts Guide:

PR 59 - guide: startupitem: document keywords startupitem.user/startupitem.group

comment:7 Changed 8 months ago by mascguy (Christopher Nielsen)

PR created, to document installs_libs and add_users in the MacPorts Guide:

PR 60 - guide: keywords: document installs_libs, add_users

comment:8 Changed 8 months ago by mascguy (Christopher Nielsen)

PR created, to document keyword use_dmg in the manpage for portfile:

PR 295 - manpages: portfile: document keyword use_dmg

comment:9 in reply to:  8 Changed 8 months ago by mascguy (Christopher Nielsen)

Replying to mascguy:

PR created, to document keyword use_dmg in the manpage for portfile:

PR 295 - manpages: portfile: document keyword use_dmg

Corresponding PR created, to update the MacPorts Guide:

PR 61 - guide: phase: document keyword use_dmg

comment:10 Changed 8 months ago by mascguy (Christopher Nielsen)

Description: modified (diff)

comment:11 Changed 8 months ago by mascguy (Christopher Nielsen)

Description: modified (diff)

comment:12 Changed 8 months ago by mascguy (Christopher Nielsen)

PR created, to document configure.sdkroot in the manpage for portfile:

PR 297 - manpages: portfile: document keyword configure.sdkroot

comment:13 Changed 8 months ago by mascguy (Christopher Nielsen)

Description: modified (diff)

PR created, to document keyword macosx_deployment_target in the MacPorts Guide:

PR 62 - guide: keywords: document macosx_deployment_target

comment:14 Changed 8 months ago by mascguy (Christopher Nielsen)

PRs have been created for everything covered in the description, apart from those keywords that need additional work/clarification.

comment:15 Changed 8 months ago by Christopher Nielsen <mascguy@…>

In 9b28483ac923f06ebd76f84d37e7e9bcc1e36e60/macports-base (master):

manpages: portfile: document keyword configure.sdkroot

Fixes: #39083
See: #64329

comment:16 Changed 8 months ago by Christopher Nielsen <mascguy@…>

In 07723aadf4cfb2907944cdc52cc855d919960542/macports-guide (master):

guide: keywords: document macosx_deployment_target

Fixes: #39083
See: #64329

comment:17 Changed 8 months ago by Christopher Nielsen <mascguy@…>

In c1b0428bb2ef663fa1f97ecfa365d5c42bc68c31/macports-guide (master):

guide: phase: document use_dmg

Fixes: #56036
See: #64329

comment:18 Changed 8 months ago by Christopher Nielsen <mascguy@…>

In 29d77b20b049dbe1eae8460483b2b86505fa4932/macports-guide (master):

guide: startupitem: document keywords startupitem.user/startupitem.group

See: #64329

comment:19 Changed 8 months ago by Christopher Nielsen <mascguy@…>

In c4fca2088df4c7d2c7d509f4a7b76389e40bf7ea/macports-guide (master):

guide: keywords: document installs_libs, add_users

Fixes: #38440
See: #64329

comment:20 Changed 8 months ago by Christopher Nielsen <mascguy@…>

In 57ec9f935c160b8c68981415b76f7f90e5891078/macports-base (master):

manpages: portfile: document keywords startupitem.user/startupitem.group

See: #64329

comment:21 Changed 7 weeks ago by Christopher Nielsen <mascguy@…>

In 91fb998d149a3d2b78e3a0e32b93aab9f6481918/macports-base (master):

manpages: portfile: document keyword use_dmg

Fixes: #56036
See: #64329

Note: See TracTickets for help on using tickets.