Closed Bug 1888339 Opened 1 year ago Closed 1 month ago

[Documentation] Update doc on creating mach commands

Categories

(Firefox Build System :: General, enhancement)

enhancement

Tracking

(firefox139 fixed)

RESOLVED FIXED
139 Branch
Tracking Status
firefox139 --- fixed

People

(Reporter: adhaliwal34, Assigned: adhaliwal34)

Details

Attachments

(2 files, 1 obsolete file)

Attached file commands.rst

Steps to reproduce:

The current document is not up-to-date regarding the category, description, and MACH_COMMANDS requirements of creating a new mach command.

Actual results:

Following the doc leads to errors

Expected results:

Update the doc with the newer category, description, and MACH_COMMANDS requirements. Please see attached file.

I have also updated the code in the Conditionally Filtering Commands section.

The Minimizing Code in Commands section probably needs to be rewritten because using the new MACH_COMMANDS dictionary, I assume, not all mach commands are loaded every time mach is called. Probably best left to another bug report.

Update the doc with the newer category, description, and MACH_COMMANDS requirements.

Assignee: nobody → adhaliwal34
Status: UNCONFIRMED → ASSIGNED
Ever confirmed: true

Remove reference to Mozilla source directory.
Emphasise alphabetical order of MACH_COMMANDS dictionary.

Attachment #9395740 - Attachment is obsolete: true

There is an r+ patch which didn't land and no activity in this bug for 2 weeks.
:adhaliwal34, could you have a look please?
If you still have some work to do, you can add an action "Plan Changes" in Phabricator.
For more information, please visit BugBot documentation.

Flags: needinfo?(ahochheiden)
Flags: needinfo?(adhaliwal34)

I will commandeer this and get it landed.

Flags: needinfo?(ahochheiden)
Flags: needinfo?(adhaliwal34)
Attachment #9393820 - Attachment description: Bug 1888339 Update doc on creating new mach commands. r=ahochheiden,glandium → Bug 1888339 Update doc on creating new mach commands. r?#build
Pushed by ahochheiden@mozilla.com: https://hg.mozilla.org/integration/autoland/rev/e6460f25f44d Update doc on creating new mach commands. r=firefox-build-system-reviewers,sergesanspaille
Status: ASSIGNED → RESOLVED
Closed: 1 month ago
Resolution: --- → FIXED
Target Milestone: --- → 139 Branch
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Creator:
Created:
Updated:
Size: