Chapter 7. MacPorts Project

Once you are logged into Trac, you may click New Ticket and you will be presented with a new ticket window shown in the graphic below. Follow the Trac ticket guidelines below to fill out the form. If you are reporting a failed port install and a log was mentioned in the error, please use the I have files to attach to this ticket checkbox to add that log file to the ticket.

Figure 7.1. A new Trac ticket

This is a short overview of the guidelines for Trac tickets. Please see below for longer and more detailed explanations.

There are certain conventions used to ensure that Trac tickets convey as much accurate information as possible so problems and contributions may be acted upon efficiently.

{{{
your error message here
}}}

+ Submitters are advised to trim inline pastes and logs to what’s really relevant to the report, as otherwise overly large ticket pages can become unmanageable. Long output, such as the full log from a port build, should be added as an attachment, not pasted inline. See I have files to attach to this ticket below. * Type: There are five types of tickets. defect - The default; any port/MacPorts build/runtime failures and/or documentation corrections. enhancement - Tickets, with or without patches, created to enhance something that isn’t failing its intended purpose. update - Tickets, with or without patches, involving updating a port to a newer upstream version. submission - Tickets created to submit Portfiles for software not currently available in MacPorts. request - Tickets created to request the creation of a new port. * Priority: Assign a priority level to the ticket. High - Reserved for the use of MacPorts team members, as they are the best fit to determine which reports warrant a higher priority over others. Normal - The default. For normal port failures, non-critical enhancement requests, non-critical port failures. Low - For mostly cosmetic improvements, documentation corrections/improvements, etc. Not set - Anything that doesn’t fit the categories high, normal, or low. * Milestone: Leave this blank. MacPorts developers will set this to the version of MacPorts that contains a fix for the ticket when they commit a change. Note that this is only meaningful for changes in MacPorts itself, since changes to ports are continuously provided to users. If the milestone is MacPorts Future no version of MacPorts with the fix has been released yet. * Component: Set what part of the MacPorts Project the ticket is to be filed against. base - Tickets related to MacPorts base code. guide - Documentation enhancements and error corrections, or patches to the MacPorts Guide. ports - Tickets related to ports. server/hosting - For MacPorts hosting & server-side issues. website - MacPorts website enhancements and error corrections. * *wiki - MacPorts Wiki enhancements and error corrections. * Version: Select the MacPorts version you are using when it is applicable. * Keywords: Type any keywords that might help when searching for tickets. It is not useful to list words here that already appear elsewhere in the ticket. Keywords also serve as tags; for example, use “tiger” if reporting a bug that only affects Mac OS X 10.4, “haspatch” if a fix is attached to the ticket, “maintainer” if you are the port’s maintainer, or “LP64” if reporting an issue that only affects 64-bit platforms.

+ See the TicketsKeywordGuidelines wiki page for a clickable list of all keywords. * Cc: Anyone else besides the ticket reporter and assignee who would like to be kept involved in the development of the ticket. Multiple email addresses or GitHub usernames should be separated with a comma and a space (e.g., +neverpanic, you@example.org, maintainer@macports.org+).

+ When reporting port-related tickets, make sure you add the port maintainers email address or GitHub username to the Cc: field so they are notified of the ticket (unless you have commit access, then see Assign To: below). You can obtain the email address or GitHub username of the port maintainer by running +port info --maintainers +`` * Assign To: For tickets on ports, enter the email address or GitHub username of the port’s maintainer (use [cmd]+port info +`` to find this). If multiple maintainers are listed, enter the first maintainer’s email address or GitHub username here and enter the remaining maintainers' email addresses or GitHub usernames in the Cc field. Exclude the email address openmaintainer@macports.org if it appears. If the maintainer’s email address is nomaintainer@macports.org, leave the field blank.

+ Only project members and the reporter of a ticket can edit this field. * Port: For tickets on ports, enter the name of the port (or ports, space-separated, when multiple are affected). * I have files to attach to this ticket: Use this checkbox to attach files to the ticket immediately after you create it. Or you can attach files later using the Attach File button.

+ If the file you are attaching is larger than 256 KiB, please compress it with bzip2 or gzip first to save space on the server and bandwidth for those downloading it, as Trac will not preview files above that size anyway.